Liking cljdoc? Tell your friends :D

javax.security.auth.kerberos.KerberosKey

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.

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.
raw docstring

->kerberos-keyclj

(->kerberos-key principal password algorithm)
(->kerberos-key principal key-bytes key-type version-num)

Constructor.

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 to - javax.security.auth.kerberos.KerberosPrincipal key-bytes - the raw bytes for the secret key - byte[] key-type - the key type for the secret key as defined by the Kerberos protocol specification. - int version-num - the version number of this secret key - int

Constructor.

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 to - `javax.security.auth.kerberos.KerberosPrincipal`
key-bytes - the raw bytes for the secret key - `byte[]`
key-type - the key type for the secret key as defined by the Kerberos protocol specification. - `int`
version-num - the version number of this secret key - `int`
raw docstring

destroyclj

(destroy this)

Destroys this key. A call to any of its other methods after this will cause an IllegalStateException to be thrown.

throws: javax.security.auth.DestroyFailedException - if some error occurs while destorying this key.

Destroys this key. A call to any of its other methods after this
 will cause an  IllegalStateException to be thrown.

throws: javax.security.auth.DestroyFailedException - if some error occurs while destorying this key.
raw docstring

destroyed?clj

(destroyed? this)

Determines if this key has been destroyed.

returns: true if this Object has been destroyed, false otherwise. - boolean

Determines if this key has been destroyed.

returns: true if this Object has been destroyed,
          false otherwise. - `boolean`
raw docstring

equalsclj

(equals this 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.

other - the Object to compare to - java.lang.Object

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. - boolean

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.

other - the Object to compare to - `java.lang.Object`

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. - `boolean`
raw docstring

get-algorithmclj

(get-algorithm this)

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.

returns: the name of the algorithm associated with this key. - java.lang.String

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.

returns: the name of the algorithm associated with this key. - `java.lang.String`
raw docstring

get-encodedclj

(get-encoded this)

Returns the key material of this secret key.

returns: the key material - byte[]

Returns the key material of this secret key.

returns: the key material - `byte[]`
raw docstring

get-formatclj

(get-format this)

Returns the name of the encoding format for this secret key.

returns: the String RAW - java.lang.String

Returns the name of the encoding format for this secret key.

returns: the String `RAW` - `java.lang.String`
raw docstring

get-key-typeclj

(get-key-type this)

Returns the key type for this long-term key.

returns: the key type. - int

Returns the key type for this long-term key.

returns: the key type. - `int`
raw docstring

get-principalclj

(get-principal this)

Returns the principal that this key belongs to.

returns: the principal this key belongs to. - javax.security.auth.kerberos.KerberosPrincipal

Returns the principal that this key belongs to.

returns: the principal this key belongs to. - `javax.security.auth.kerberos.KerberosPrincipal`
raw docstring

get-version-numberclj

(get-version-number this)

Returns the key version number.

returns: the key version number. - int

Returns the key version number.

returns: the key version number. - `int`
raw docstring

hash-codeclj

(hash-code this)

Returns a hashcode for this KerberosKey.

returns: a hashCode() for the KerberosKey - int

Returns a hashcode for this KerberosKey.

returns: a hashCode() for the KerberosKey - `int`
raw docstring

to-stringclj

(to-string this)

Description copied from class: Object

returns: a string representation of the object. - java.lang.String

Description copied from class: Object

returns: a string representation of the object. - `java.lang.String`
raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close