PrivateKey

A private key. The purpose of this interface is to group (and provide type safety for) all private key interfaces. <p> Note: The specialized private key interfaces extend this interface. See, for example, the {@code DSAPrivateKey} interface in {@link java.security.interfaces}. <p> Implementations should override the default {@code destroy} and {@code isDestroyed} methods from the {@link javax.security.auth.Destroyable} interface to enable sensitive key information to be destroyed, cleared, or in the case where such information is immutable, unreferenced. Finally, since {@code PrivateKey} is {@code Serializable}, implementations should also override {@link java.io.ObjectOutputStream#writeObject(java.lang.Object)} to prevent keys that have been destroyed from being serialized.

@see Key @see PublicKey @see Certificate @see Signature#initVerify @see java.security.interfaces.DSAPrivateKey @see java.security.interfaces.RSAPrivateKey @see java.security.interfaces.RSAPrivateCrtKey

@author Benjamin Renaud @author Josh Bloch

interface PrivateKey : Key

Inherited Members

From Key

getAlgorithm
string getAlgorithm()

Returns the standard algorithm name for this key. For example, "DSA" would indicate that this key is a DSA key. See Appendix A in the <a href= "../../../technotes/guides/security/crypto/CryptoSpec.html#AppA"> Java Cryptography Architecture API Specification &amp; Reference </a> for information about standard algorithm names.

getFormat
string getFormat()

Returns the name of the primary encoding format of this key, or null if this key does not support encoding. The primary encoding format is named in terms of the appropriate ASN.1 data format, if an ASN.1 specification for this key exists. For example, the name of the ASN.1 data format for public keys is <I>SubjectPublicKeyInfo</I>, as defined by the X.509 standard; in this case, the returned format is {@code "X.509"}. Similarly, the name of the ASN.1 data format for private keys is <I>PrivateKeyInfo</I>, as defined by the PKCS #8 standard; in this case, the returned format is {@code "PKCS#8"}.

getEncoded
byte[] getEncoded()

Returns the key in its primary encoding format, or null if this key does not support encoding.

Meta