PBEKey

AI-generated Key Takeaways

• PBEKey interface provides access to the password, salt, and iteration count used in Password-Based Encryption (PBE).

• It extends the SecretKey interface and includes methods for retrieving PBE-specific parameters.

• getPassword(), getSalt(), and getIterationCount() methods retrieve the password, salt, and iteration count respectively.

• Developers should securely handle the sensitive information returned by these methods, ensuring to zero out the data when no longer needed.

public interface PBEKey implements SecretKey

The interface to a PBE key.

See Also

• PBEKeySpec
• SecretKey

Constant Summary

long

serialVersionUID

The class fingerprint that is set to indicate serialization compatibility since J2SE 1.4.

Inherited Constant Summary

From interface javax.crypto.SecretKey

long

serialVersionUID

The class fingerprint that is set to indicate serialization compatibility since J2SE 1.4.

From interface java.security.Key

long

serialVersionUID

The class fingerprint that is set to indicate serialization compatibility with a previous version of the class.

Public Method Summary

abstract int	getIterationCount() Returns the iteration count or 0 if not specified.
abstract char[]	getPassword() Returns the password.
abstract byte[]	getSalt() Returns the salt or null if not specified.

Inherited Method Summary

From interface java.security.Key

abstract String	getAlgorithm() Returns the standard algorithm name for this key.
abstract byte[]	getEncoded() Returns the key in its primary encoding format, or null if this key does not support encoding.
abstract String	getFormat() Returns the name of the primary encoding format of this key, or null if this key does not support encoding.

From interface javax.security.auth.Destroyable

void	destroy() Destroy this Object.
boolean	isDestroyed() Determine if this Object has been destroyed.

Constants

public static final long serialVersionUID

The class fingerprint that is set to indicate serialization compatibility since J2SE 1.4.

Constant Value: -1430015993304333921

Public Methods

public abstract int getIterationCount ()

Returns the iteration count or 0 if not specified.

Returns

• the iteration count.

public abstract char[] getPassword ()

Returns the password.

Note: this method should return 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.

public abstract byte[] getSalt ()

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