Package Summary Overview Summary

### class:KerberosKey [NONE]
- All Implemented Interfaces: Serializable, Key, SecretKey, Destroyable
      public class KerberosKey
      extends Object
      implements SecretKey
  This class encapsulates a long term secret key for a Kerberos principal. A `KerberosKey` object includes an EncryptionKey, a `KerberosPrincipal` as its owner, and the version number of the key. An EncryptionKey is defined in Section 4.2.9 of the Kerberos Protocol Specification (RFC 4120 ) as:
           EncryptionKey   ::= SEQUENCE {
                   keytype         [0] Int32 -- actually encryption type --,
                   keyvalue        [1] OCTET STRING
           }
The key material of a `KerberosKey` is defined as the value of the `keyValue` above. 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`. When creating a `KerberosKey` using the `KerberosKey(KerberosPrincipal, char[], String)` constructor, an implementation may accept non-IANA algorithm names (For example, "ArcFourMac" for "rc4-hmac"), but the `getAlgorithm()` method must always return the IANA algorithm name. Implementation Note: Old algorithm names used before JDK 9 are supported in the `KerberosKey(KerberosPrincipal, char[], String)` constructor in this implementation for compatibility reasons, which are "DES" (and null) for "des-cbc-md5", "DESede" for "des3-cbc-sha1-kd", "ArcFourHmac" for "rc4-hmac", "AES128" for "aes128-cts-hmac-sha1-96", and "AES256" for "aes256-cts-hmac-sha1-96". Since: 1.4 See Also: Serialized Form

### constructor:KerberosKey(javax.security.auth.kerberos.KerberosPrincipal, byte[], int, int) [NONE]
- #### KerberosKey
      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". Parameters: `principal` - the principal that this secret key belongs to `keyBytes` - the key material for the secret key `keyType` - the key type for the secret key as defined by the Kerberos protocol specification. `versionNum` - the version number of this secret key

### constructor:KerberosKey(javax.security.auth.kerberos.KerberosPrincipal, char[], java.lang.String) [NONE]
- #### KerberosKey
      public KerberosKey(KerberosPrincipal principal,
                         char[] password,
                         String algorithm)
Constructs a KerberosKey from a principal's password using the specified algorithm name. The algorithm name (case insensitive) should be provided as the encryption type string defined on the IANA Kerberos Encryption Type Numbers page. The version number of the key generated will be 0. Parameters: `principal` - the principal that this password belongs to `password` - the password that should be used to compute the key `algorithm` - the name for the algorithm that this key will be used for Throws: `IllegalArgumentException` - if the name of the algorithm passed is unsupported.

### method:getPrincipal() [NONE]
- #### getPrincipal
      public final KerberosPrincipal getPrincipal()
Returns the principal that this key belongs to. Returns: the principal this key belongs to. Throws: `IllegalStateException` - if the key is destroyed

### method:getVersionNumber() [NONE]
- #### getVersionNumber
      public final int getVersionNumber()
Returns the key version number. Returns: the key version number. Throws: `IllegalStateException` - if the key is destroyed

### method:getKeyType() [NONE]
- #### getKeyType
      public final int getKeyType()
Returns the key type for this long-term key. Returns: the key type. Throws: `IllegalStateException` - if the key is destroyed

### method:getAlgorithm() [NONE]
- #### getAlgorithm
      public final String getAlgorithm()
Returns the standard algorithm name for this key. The algorithm names are the encryption type string defined on the IANA Kerberos Encryption Type Numbers page. This method can return the following value not defined on the IANA page: none: for etype equal to 0 unknown: for etype greater than 0 but unsupported by the implementation private: for etype smaller than 0 Specified by: `getAlgorithm` in interface `Key` Returns: the name of the algorithm associated with this key. Throws: `IllegalStateException` - if the key is destroyed

### method:getFormat() [NONE]
- #### getFormat
      public final String getFormat()
Returns the name of the encoding format for this secret key. Specified by: `getFormat` in interface `Key` Returns: the String "RAW" Throws: `IllegalStateException` - if the key is destroyed

### method:getEncoded() [NONE]
- #### getEncoded
      public final byte[] getEncoded()
Returns the key material of this secret key. Specified by: `getEncoded` in interface `Key` Returns: the key material Throws: `IllegalStateException` - if the key is destroyed

### method:destroy() [NONE]
- #### destroy
      public void destroy()
                   throws DestroyFailedException
Destroys this key by clearing out the key material of this secret key. Specified by: `destroy` in interface `Destroyable` Throws: `DestroyFailedException` - if some error occurs while destorying this key.

### method:isDestroyed() [NONE]
- #### isDestroyed
      public boolean isDestroyed()
Determines if this key has been destroyed. Specified by: `isDestroyed` in interface `Destroyable` Returns: true if this `Object` has been destroyed, false otherwise.

### method:toString() [NONE]
- #### toString
      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())
Overrides: `toString` in class `Object` Returns: a string representation of the object.

### method:hashCode() [NONE]
- #### hashCode
      public int hashCode()
Returns a hashcode for this KerberosKey. Overrides: `hashCode` in class `Object` Returns: a hashCode() for the `KerberosKey` Since: 1.6 See Also: `Object.equals(java.lang.Object)`, `System.identityHashCode(java.lang.Object)`

### method:equals(java.lang.Object) [NONE]
- #### equals
      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. Overrides: `equals` in class `Object` Parameters: `other` - the Object to compare to Returns: true if the specified object is equal to this KerberosKey, false otherwise. NOTE: Returns false if either of the KerberosKey objects has been destroyed. Since: 1.6 See Also: `Object.hashCode()`, `HashMap`