-
- All Superinterfaces:
- Serializable
- All Known Subinterfaces:
- DHPrivateKey, DHPublicKey, DSAPrivateKey, DSAPublicKey, ECPrivateKey, ECPublicKey, PBEKey, PrivateKey, PublicKey, RSAMultiPrimePrivateCrtKey, RSAPrivateCrtKey, RSAPrivateKey, RSAPublicKey, SecretKey
- All Known Implementing Classes:
- KerberosKey, SecretKeySpec
public interface Key extends Serializable
The Key interface is the top-level interface for all keys. It defines the functionality shared by all key objects. All keys have three characteristics:- An Algorithm
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. - An Encoded Form
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 thegetEncoded
method. Note: The syntax of the ASN.1 typeSubjectPublicKeyInfo
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. - A Format
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.
- See Also:
PublicKey
,PrivateKey
,KeyPair
,KeyPairGenerator
,KeyFactory
,KeyRep
,KeySpec
,Identity
,Signer
-
-
Field Summary
Fields 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.
-
Method Summary
Methods 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.
-
-
-
Field Detail
-
serialVersionUID
static final long serialVersionUID
The class fingerprint that is set to indicate serialization compatibility with a previous version of the class.- See Also:
- Constant Field Values
-
-
Method Detail
-
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 Java Cryptography Architecture API Specification & Reference for information about standard algorithm names.- Returns:
- the name of the algorithm associated with this key.
-
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 SubjectPublicKeyInfo, as defined by the X.509 standard; in this case, the returned format is"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"
.- Returns:
- the primary encoding format of the key.
-
getEncoded
byte[] getEncoded()
Returns the key in its primary encoding format, or null if this key does not support encoding.- Returns:
- the encoded key, or null if the key does not support encoding.
-
-
Nederlandse vertaling
U hebt gevraagd om deze site in het Nederlands te bezoeken. Voor nu wordt alleen de interface vertaald, maar nog niet alle inhoud.Als je me wilt helpen met vertalingen, is je bijdrage welkom. Het enige dat u hoeft te doen, is u op de site registreren en mij een bericht sturen waarin u wordt gevraagd om u toe te voegen aan de groep vertalers, zodat u de gewenste pagina's kunt vertalen. Een link onderaan elke vertaalde pagina geeft aan dat u de vertaler bent en heeft een link naar uw profiel.
Bij voorbaat dank.
Document heeft de 11/06/2005 gemaakt, de laatste keer de 04/03/2020 gewijzigd
Bron van het afgedrukte document:https://www.gaudry.be/nl/java-api-rf-java/security/key.html
De infobrol is een persoonlijke site waarvan de inhoud uitsluitend mijn verantwoordelijkheid is. De tekst is beschikbaar onder CreativeCommons-licentie (BY-NC-SA). Meer info op de gebruiksvoorwaarden en de auteur.
Referenties
Deze verwijzingen en links verwijzen naar documenten die geraadpleegd zijn tijdens het schrijven van deze pagina, of die aanvullende informatie kunnen geven, maar de auteurs van deze bronnen kunnen niet verantwoordelijk worden gehouden voor de inhoud van deze pagina.
De auteur Deze site is als enige verantwoordelijk voor de manier waarop de verschillende concepten, en de vrijheden die met de referentiewerken worden genomen, hier worden gepresenteerd. Vergeet niet dat u meerdere broninformatie moet doorgeven om het risico op fouten te verkleinen.