/*

 * Copyright (c) 1997, 2017, Oracle and/or its affiliates. All rights reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Oracle designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Oracle in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

 * or visit www.oracle.com if you need additional information or have any

 * questions.

 */

package java.security.spec;

/**

 * This class represents the ASN.1 encoding of a private key,

 * encoded according to the ASN.1 type {@code PrivateKeyInfo}.

 * The {@code PrivateKeyInfo} syntax is defined in the PKCS#8 standard

 * as follows:

 *

 * <pre>

 * PrivateKeyInfo ::= SEQUENCE {

 *   version Version,

 *   privateKeyAlgorithm PrivateKeyAlgorithmIdentifier,

 *   privateKey PrivateKey,

 *   attributes [0] IMPLICIT Attributes OPTIONAL }

 *

 * Version ::= INTEGER

 *

 * PrivateKeyAlgorithmIdentifier ::= AlgorithmIdentifier

 *

 * PrivateKey ::= OCTET STRING

 *

 * Attributes ::= SET OF Attribute

 * </pre>

 *

 * @author Jan Luehe

 *

 *

 * @see java.security.Key

 * @see java.security.KeyFactory

 * @see KeySpec

 * @see EncodedKeySpec

 * @see X509EncodedKeySpec

 *

 * @since 1.2

 */

public class PKCS8EncodedKeySpec extends EncodedKeySpec {

    /**

     * Creates a new {@code PKCS8EncodedKeySpec} with the given encoded key.

     *

     * @param encodedKey the key, which is assumed to be

     * encoded according to the PKCS #8 standard. The contents of

     * the array are copied to protect against subsequent modification.

     * @throws NullPointerException if {@code encodedKey}

     * is null.

     */

    public PKCS8EncodedKeySpec(byte[] encodedKey) {

        super(encodedKey);

    }

    /**

     * Creates a new {@code PKCS8EncodedKeySpec} with the given encoded key and

     * algorithm. This constructor is useful when subsequent callers of

     * the {@code PKCS8EncodedKeySpec} object might not know the

     * algorithm of the private key.

     *

     * @param encodedKey the key, which is assumed to be

     * encoded according to the PKCS #8 standard. The contents of

     * the array are copied to protect against subsequent modification.

     * @param algorithm the algorithm name of the encoded private key

     * See the KeyFactory section in the <a href=

     * "{@docRoot}/../specs/security/standard-names.html#keyfactory-algorithms">

     * Java Security Standard Algorithm Names Specification</a>

     * for information about standard algorithm names.

     * @throws NullPointerException if {@code encodedKey}

     * or {@code algorithm} is null.

     * @throws IllegalArgumentException if {@code algorithm} is

     * the empty string {@code ""}

     * @since 9

     */

    public PKCS8EncodedKeySpec(byte[] encodedKey, String algorithm) {

        super(encodedKey, algorithm);

    }

    /**

     * Returns the key bytes, encoded according to the PKCS #8 standard.

     *

     * @return the PKCS #8 encoding of the key. Returns a new array

     * each time this method is called.

     */

    public byte[] getEncoded() {

        return super.getEncoded();

    }

    /**

     * Returns the name of the encoding format associated with this

     * key specification.

     *

     * @return the string {@code "PKCS#8"}.

     */

    public final String getFormat() {

        return "PKCS#8";

    }

}