Liking cljdoc? Tell your friends :D

javax.crypto.spec.PBEKeySpec

A user-chosen password that can be used with password-based encryption (PBE).

The password can be viewed as some kind of raw key material, from which the encryption mechanism that uses it derives a cryptographic key.

Different PBE mechanisms may consume different bits of each password character. For example, the PBE mechanism defined in

PKCS #5 looks at only the low order 8 bits of each character, whereas PKCS #12 looks at all 16 bits of each character.

You convert the password characters to a PBE key by creating an instance of the appropriate secret-key factory. For example, a secret-key factory for PKCS #5 will construct a PBE key from only the low order 8 bits of each password character, whereas a secret-key factory for PKCS #12 will take all 16 bits of each character.

Also note that this class stores passwords as char arrays instead of String objects (which would seem more logical), because the String class is immutable and there is no way to overwrite its internal value when the password stored in it is no longer needed. Hence, this class requests the password as a char array, so it can be overwritten when done.

A user-chosen password that can be used with password-based encryption
(PBE).

The password can be viewed as some kind of raw key material, from which
the encryption mechanism that uses it derives a cryptographic key.

Different PBE mechanisms may consume different bits of each password
character. For example, the PBE mechanism defined in

PKCS #5 looks at only the low order 8 bits of each character, whereas
PKCS #12 looks at all 16 bits of each character.

You convert the password characters to a PBE key by creating an
instance of the appropriate secret-key factory. For example, a secret-key
factory for PKCS #5 will construct a PBE key from only the low order 8 bits
of each password character, whereas a secret-key factory for PKCS #12 will
take all 16 bits of each character.

Also note that this class stores passwords as char arrays instead of
String objects (which would seem more logical), because the
String class is immutable and there is no way to overwrite its
internal value when the password stored in it is no longer needed. Hence,
this class requests the password as a char array, so it can be overwritten
when done.
raw docstring

->pbe-key-specclj

(->pbe-key-spec password)
(->pbe-key-spec password salt iteration-count)
(->pbe-key-spec password salt iteration-count key-length)

Constructor.

Constructor that takes a password, salt, iteration count, and to-be-derived key length for generating PBEKey of variable-key-size PBE ciphers. An empty char[] is used if null is specified for password.

Note: the password and salt are cloned before they are stored in the new PBEKeySpec object.

password - the password. - char[] salt - the salt. - byte[] iteration-count - the iteration count. - int key-length - the to-be-derived key length. - int

throws: java.lang.NullPointerException - if salt is null.

Constructor.

Constructor that takes a password, salt, iteration count, and
 to-be-derived key length for generating PBEKey of variable-key-size
 PBE ciphers.  An empty char[] is used if null is specified for
 password.

  Note: the password and salt
 are cloned before they are stored in
 the new PBEKeySpec object.

password - the password. - `char[]`
salt - the salt. - `byte[]`
iteration-count - the iteration count. - `int`
key-length - the to-be-derived key length. - `int`

throws: java.lang.NullPointerException - if salt is null.
raw docstring

clear-passwordclj

(clear-password this)

Clears the internal copy of the password.

Clears the internal copy of the password.
raw docstring

get-iteration-countclj

(get-iteration-count this)

Returns the iteration count or 0 if not specified.

returns: the iteration count. - int

Returns the iteration count or 0 if not specified.

returns: the iteration count. - `int`
raw docstring

get-key-lengthclj

(get-key-length this)

Returns the to-be-derived key length or 0 if not specified.

Note: this is used to indicate the preference on key length for variable-key-size ciphers. The actual key size depends on each provider's implementation.

returns: the to-be-derived key length. - int

Returns the to-be-derived key length or 0 if not specified.

  Note: this is used to indicate the preference on key length
 for variable-key-size ciphers. The actual key size depends on
 each provider's implementation.

returns: the to-be-derived key length. - `int`
raw docstring

get-passwordclj

(get-password this)

Returns a copy of the password.

Note: this method returns a copy of the password. It is the caller's responsibility to zero out the password information after it is no longer needed.

returns: the password. - char[]

throws: java.lang.IllegalStateException - if password has been cleared by calling clearPassword method.

Returns a copy of the password.

  Note: this method returns a copy of the password. It is
 the caller's responsibility to zero out the password information after
 it is no longer needed.

returns: the password. - `char[]`

throws: java.lang.IllegalStateException - if password has been cleared by calling clearPassword method.
raw docstring

get-saltclj

(get-salt this)

Returns a copy of the salt or null if not specified.

Note: this method should return a copy of the salt. It is the caller's responsibility to zero out the salt information after it is no longer needed.

returns: the salt. - byte[]

Returns a copy of the salt or null if not specified.

  Note: this method should return a copy of the salt. It is
 the caller's responsibility to zero out the salt information after
 it is no longer needed.

returns: the salt. - `byte[]`
raw docstring

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

× close