public interface Key extends Serializable
This is the key algorithm for that key. The key algorithm is usually
an encryption or asymmetric operation algorithm (such as DSA or
RSA), which will work with those algorithms and with related
algorithms (such as MD5 with RSA, SHA-1 with RSA, Raw DSA, etc.)
The name of the algorithm of a key is obtained using the
getAlgorithm
method.
This is an external encoded form for the key used when a standard
representation of the key is needed outside the Java Virtual Machine,
as when transmitting the key to some other party. The key
is encoded according to a standard format (such as
X.509 SubjectPublicKeyInfo
or PKCS#8), and
is returned using the getEncoded
method.
Note: The syntax of the ASN.1 type SubjectPublicKeyInfo
is defined as follows:
SubjectPublicKeyInfo ::= SEQUENCE { algorithm AlgorithmIdentifier, subjectPublicKey BIT STRING } AlgorithmIdentifier ::= SEQUENCE { algorithm OBJECT IDENTIFIER, parameters ANY DEFINED BY algorithm OPTIONAL }For more information, see RFC 3280: Internet X.509 Public Key Infrastructure Certificate and CRL Profile.
This is the name of the format of the encoded key. It is returned
by the getFormat
method.
KeyFactory
).
A Key should use KeyRep as its serialized representation. Note that a serialized Key may contain sensitive information which should not be exposed in untrusted environments. See the Security Appendix of the Serialization Specification for more information.
PublicKey
,
PrivateKey
,
KeyPair
,
KeyPairGenerator
,
KeyFactory
,
KeyRep
,
KeySpec
,
Identity
,
Signer
Modifier and Type | Field and Description |
---|---|
static long |
serialVersionUID
The class fingerprint that is set to indicate
serialization compatibility with a previous
version of the class.
|
Modifier and Type | Method and Description |
---|---|
String |
getAlgorithm()
Returns the standard algorithm name for this key.
|
byte[] |
getEncoded()
Returns the key in its primary encoding format, or null
if this key does not support encoding.
|
String |
getFormat()
Returns the name of the primary encoding format of this key,
or null if this key does not support encoding.
|
static final long serialVersionUID
String getAlgorithm()
String getFormat()
"X.509"
. Similarly,
the name of the ASN.1 data format for private keys is
PrivateKeyInfo,
as defined by the PKCS #8 standard; in this case, the returned format is
"PKCS#8"
.byte[] getEncoded()
Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2011, Oracle and/or its affiliates. All rights reserved.
DRAFT ea-b138