public class KerberosKey extends Object implements SecretKey, Destroyable
This class encapsulates a long term secret key for a Kerberos principal.
All Kerberos JAAS login modules that obtain a principal's password and generate the secret key from it should use this class. Sometimes, such as when authenticating a server in the absence of user-to-user authentication, the login module will store an instance of this class in the private credential set of a Subject
during the commit phase of the authentication process.
A Kerberos service using a keytab to read secret keys should use the KeyTab
class, where latest keys can be read when needed.
It might be necessary for the application to be granted a PrivateCredentialPermission
if it needs to access the KerberosKey instance from a Subject. This permission is not needed when the application depends on the default JGSS Kerberos mechanism to access the KerberosKey. In that case, however, the application will need an appropriate ServicePermission
.
public KerberosKey(KerberosPrincipal principal, byte[] keyBytes, int keyType, int versionNum)
Constructs a KerberosKey from the given bytes when the key type and key version number are known. This can be used when reading the secret key information from a Kerberos "keytab".
principal
- the principal that this secret key belongs tokeyBytes
- the raw bytes for the secret keykeyType
- the key type for the secret key as defined by the Kerberos protocol specification.versionNum
- the version number of this secret keypublic KerberosKey(KerberosPrincipal principal, char[] password, String algorithm)
Constructs a KerberosKey from a principal's password.
principal
- the principal that this password belongs topassword
- the password that should be used to compute the keyalgorithm
- the name for the algorithm that this key will be used for. This parameter may be null in which case the default algorithm "DES" will be assumed.IllegalArgumentException
- if the name of the algorithm passed is unsupported.public final KerberosPrincipal getPrincipal()
Returns the principal that this key belongs to.
public final int getVersionNumber()
Returns the key version number.
public final int getKeyType()
Returns the key type for this long-term key.
public final String getAlgorithm()
Returns the standard algorithm name for this key. For example, "DES" would indicate that this key is a DES key. See Appendix A in the Java Cryptography Architecture API Specification & Reference for information about standard algorithm names.
getAlgorithm
in interface Key
public final String getFormat()
Returns the name of the encoding format for this secret key.
public final byte[] getEncoded()
Returns the key material of this secret key.
getEncoded
in interface Key
public void destroy() throws DestroyFailedException
Destroys this key. A call to any of its other methods after this will cause an IllegalStateException to be thrown.
destroy
in interface Destroyable
DestroyFailedException
- if some error occurs while destorying this key.public boolean isDestroyed()
Determines if this key has been destroyed.
isDestroyed
in interface Destroyable
Object
has been destroyed, false otherwise.public String toString()
Description copied from class: Object
Returns a string representation of the object. In general, the toString
method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.
The toString
method for class Object
returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@
', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:
getClass().getName() + '@' + Integer.toHexString(hashCode())
public int hashCode()
Returns a hashcode for this KerberosKey.
hashCode
in class Object
KerberosKey
Object.equals(java.lang.Object)
, System.identityHashCode(java.lang.Object)
public boolean equals(Object other)
Compares the specified Object with this KerberosKey for equality. Returns true if the given object is also a KerberosKey
and the two KerberosKey
instances are equivalent.
equals
in class Object
other
- the Object to compare toObject.hashCode()
, HashMap
© 1993–2017, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.