com.tencent.kona.sun.security.pkcs

Class PKCS8Key

java.lang.Object

com.tencent.kona.sun.security.pkcs.PKCS8Key

All Implemented Interfaces:

java.io.Serializable, java.security.Key, java.security.PrivateKey, javax.security.auth.Destroyable

Direct Known Subclasses:

ECPrivateKeyImpl, RSAPrivateCrtKeyImpl, RSAPrivateKeyImpl

public class PKCS8Key
extends java.lang.Object
implements java.security.PrivateKey

Holds a PKCS#8 key, for example a private key According to https://tools.ietf.org/html/rfc5958: OneAsymmetricKey ::= SEQUENCE { version Version, privateKeyAlgorithm PrivateKeyAlgorithmIdentifier, privateKey PrivateKey, attributes [0] Attributes OPTIONAL, ..., [[2: publicKey [1] PublicKey OPTIONAL ]], ... } We support this format but do not parse attributes and publicKey now.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected AlgorithmId	algid
protected byte[]	encodedKey
protected byte[]	key

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PKCS8Key() Default constructor.
protected	PKCS8Key(byte[] input) Another constructor.

Method Summary

Modifier and Type	Method and Description
void	clear()
boolean	equals(java.lang.Object object) Compares two private keys.
java.lang.String	getAlgorithm() Returns the algorithm to be used with this key.
AlgorithmId	getAlgorithmId() Returns the algorithm ID to be used with this key.
byte[]	getEncoded() Returns the DER-encoded form of the key as a byte array, or null if an encoding error occurs.
java.lang.String	getFormat() Returns the format for this key: "PKCS#8"
int	hashCode() Calculates a hash code value for this object.
static java.security.PrivateKey	parseKey(byte[] encoded) Construct PKCS#8 subject public key from a DER encoding.
protected java.lang.Object	writeReplace()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.security.auth.Destroyable

destroy, isDestroyed

Field Detail

algid

protected AlgorithmId algid

key

protected byte[] key

encodedKey

protected byte[] encodedKey

Constructor Detail

PKCS8Key

protected PKCS8Key()

Default constructor. Constructors in subclasses that create a new key from its components require this. These constructors must initialize algid and key.

PKCS8Key

protected PKCS8Key(byte[] input)
            throws java.security.InvalidKeyException

Another constructor. Constructors in subclasses that create a new key from an encoded byte array require this. We do not assign this encoding to encodedKey directly. This method is also used by parseKey(byte[]) to create a raw key.

Throws:

java.security.InvalidKeyException

Method Detail

parseKey

public static java.security.PrivateKey parseKey(byte[] encoded)
                                         throws java.io.IOException

Construct PKCS#8 subject public key from a DER encoding. If a security provider supports the key algorithm with a specific class, a PrivateKey from the provider is returned. Otherwise, a raw PKCS8Key object is returned.

This mechanism guarantees that keys (and algorithms) may be freely manipulated and transferred, without risk of losing information. Also, when a key (or algorithm) needs some special handling, that specific need can be accommodated.

Parameters:

encoded - the DER-encoded SubjectPublicKeyInfo value

Throws:

java.io.IOException - on data format errors

getAlgorithm

public java.lang.String getAlgorithm()

Returns the algorithm to be used with this key.

Specified by:

getAlgorithm in interface java.security.Key

getAlgorithmId

public AlgorithmId getAlgorithmId()

Returns the algorithm ID to be used with this key.

getEncoded

public byte[] getEncoded()

Returns the DER-encoded form of the key as a byte array, or null if an encoding error occurs.

Specified by:

getEncoded in interface java.security.Key

getFormat

public java.lang.String getFormat()

Returns the format for this key: "PKCS#8"

Specified by:

getFormat in interface java.security.Key

writeReplace

protected java.lang.Object writeReplace()
                                 throws java.io.ObjectStreamException

Throws:

java.io.ObjectStreamException

equals

public boolean equals(java.lang.Object object)

Compares two private keys. This returns false if the object with which to compare is not of type Key. Otherwise, the encoding of this key object is compared with the encoding of the given key object.

Overrides:

equals in class java.lang.Object

Parameters:

object - the object with which to compare

Returns:

true if this key has the same encoding as the object argument; false otherwise.

hashCode

public int hashCode()

Calculates a hash code value for this object. Objects which are equal will also have the same hashcode.

Overrides:

hashCode in class java.lang.Object

clear

public void clear()