OpenJDK 27 · com.sun.crypto.provider.PBKDF2KeyImpl · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
private final transient Cleaner.Cleanable	cleaner
private final int	iterCount
private final byte[]	key
private final char[]	passwd
private final transient Mac	prf
private final byte[]	salt
private static final long	serialVersionUID Hides javax.crypto.interfaces.PBEKey.serialVersionUID.

Access	Constructor and Description
pack-priv	PBKDF2KeyImpl(PBEKeySpec the given PBE key specification keySpec, String the given PBE key algorithm prfAlgo) Creates a PBE key from a given PBE key specification.

Method Summary

Modifier and Type	Method and Description
public void	clear()
private static byte[]	deriveKey(final Mac prf, final byte[] password, byte[] salt, int iterCount, int keyLengthInBit)
public boolean	equals(Object obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public String	getAlgorithm() Implements java.security.Key.getAlgorithm. Returns the standard algorithm name for this key.
public byte[]	getEncoded() Implements java.security.Key.getEncoded. Returns the key in its primary encoding format, or `null` if this key does not support encoding.
public String	getFormat() Implements java.security.Key.getFormat. Returns the name of the primary encoding format of this key, or `null` if this key does not support encoding.
public int	getIterationCount() Implements javax.crypto.interfaces.PBEKey.getIterationCount. Returns the iteration count or 0 if not specified.
public char[]	getPassword() Implements javax.crypto.interfaces.PBEKey.getPassword. Returns the password.
public byte[]	getSalt() Implements javax.crypto.interfaces.PBEKey.getSalt. Returns the salt or null if not specified.
public int	hashCode() Overrides java.lang.Object.hashCode. Calculates a hash code value for the object.
private void	readObject(ObjectInputStream the `ObjectInputStream` from which data is read stream) Restores the state of this object from the stream.
private Object	Returns: the standard KeyRep object to be serialized writeReplace() Replace the PBE key to be serialized.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll toString wait wait wait

cleaner	back to summary
private final transient Cleaner.Cleanable cleaner

iterCount	back to summary
private final int iterCount

key	back to summary
private final byte[] key

passwd	back to summary
private final char[] passwd

prf	back to summary
private final transient Mac prf

salt	back to summary
private final byte[] salt

serialVersionUID	back to summary
private static final long serialVersionUID Hides javax.crypto.interfaces.PBEKey.serialVersionUID. Annotations @Serial

PBKDF2KeyImpl	back to summary
pack-priv PBKDF2KeyImpl(PBEKeySpec keySpec, String prfAlgo) throws InvalidKeySpecException Creates a PBE key from a given PBE key specification. Parameters keySpec:PBEKeySpec the given PBE key specification prfAlgo:String the given PBE key algorithm

Method Detail

clear	back to summary
public void clear()

deriveKey	back to summary
private static byte[] deriveKey(final Mac prf, final byte[] password, byte[] salt, int iterCount, int keyLengthInBit)

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Annotations @Override

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Annotations

@Override

getAlgorithm	back to summary
public String getAlgorithm() Implements java.security.Key.getAlgorithm. Doc from java.security.Key.getAlgorithm. Returns the standard algorithm name for this key. For example, "RSA" would indicate that this key is an RSA key. See the Key Algorithms section in the Java Security Standard Algorithm Names Specification for information about standard key algorithm names.

getAlgorithm

back to summary

public String getAlgorithm()

Implements java.security.Key.getAlgorithm.

Doc from java.security.Key.getAlgorithm.

Returns the standard algorithm name for this key. For example, "RSA" would indicate that this key is an RSA key. See the Key Algorithms section in the Java Security Standard Algorithm Names Specification for information about standard key algorithm names.

getEncoded back to summary

getEncoded	back to summary
public byte[] getEncoded() Implements java.security.Key.getEncoded. Doc from java.security.Key.getEncoded. Returns the key in its primary encoding format, or `null` if this key does not support encoding.

public byte[] getEncoded()

Implements java.security.Key.getEncoded.

Doc from java.security.Key.getEncoded.

Returns the key in its primary encoding format, or null if this key does not support encoding.

getFormat back to summary

getFormat	back to summary
public String getFormat() Implements java.security.Key.getFormat. Doc from java.security.Key.getFormat. Returns the name of the primary encoding format of this key, or `null` if this key does not support encoding. The primary encoding format is named in terms of the appropriate ASN.1 data format, if an ASN.1 specification for this key exists. For example, the name of the ASN.1 data format for public keys is SubjectPublicKeyInfo, as defined by the X.509 standard; in this case, the returned format is `"X.509"`. Similarly, the name of the ASN.1 data format for private keys is PrivateKeyInfo, as defined by the PKCS #8 standard; in this case, the returned format is `"PKCS#8"`.

public String getFormat()

Implements java.security.Key.getFormat.

Doc from java.security.Key.getFormat.

Returns the name of the primary encoding format of this key, or null if this key does not support encoding. The primary encoding format is named in terms of the appropriate ASN.1 data format, if an ASN.1 specification for this key exists. For example, the name of the ASN.1 data format for public keys is SubjectPublicKeyInfo, as defined by the X.509 standard; in this case, the returned format is "X.509". Similarly, the name of the ASN.1 data format for private keys is PrivateKeyInfo, as defined by the PKCS #8 standard; in this case, the returned format is "PKCS#8".

getIterationCount	back to summary
public int getIterationCount() Implements javax.crypto.interfaces.PBEKey.getIterationCount. Doc from javax.crypto.interfaces.PBEKey.getIterationCount. Returns the iteration count or 0 if not specified.

getIterationCount

back to summary

public int getIterationCount()

Implements javax.crypto.interfaces.PBEKey.getIterationCount.

Doc from javax.crypto.interfaces.PBEKey.getIterationCount.

Returns the iteration count or 0 if not specified.

getPassword	back to summary
public char[] getPassword() Implements javax.crypto.interfaces.PBEKey.getPassword. Doc from javax.crypto.interfaces.PBEKey.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.

getPassword

back to summary

public char[] getPassword()

Implements javax.crypto.interfaces.PBEKey.getPassword.

Doc from javax.crypto.interfaces.PBEKey.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.

getSalt	back to summary
public byte[] getSalt() Implements javax.crypto.interfaces.PBEKey.getSalt. Doc from javax.crypto.interfaces.PBEKey.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.

getSalt

back to summary

public byte[] getSalt()

Implements javax.crypto.interfaces.PBEKey.getSalt.

Doc from javax.crypto.interfaces.PBEKey.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.

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Calculates a hash code value for the object. Objects that are equal will also have the same hashcode. Annotations @Override

hashCode

back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Calculates a hash code value for the object. Objects that are equal will also have the same hashcode.

Annotations

@Override

readObject back to summary

readObject	back to summary
private void readObject(ObjectInputStream stream) throws IOException, ClassNotFoundException Restores the state of this object from the stream. Deserialization of this class is not supported. Parameters stream:ObjectInputStream the `ObjectInputStream` from which data is read Annotations @Serial Exceptions IOException: if an I/O error occurs ClassNotFoundException: if a serialized class cannot be loaded

private void readObject(ObjectInputStream stream) throws IOException, ClassNotFoundException

Restores the state of this object from the stream.

Deserialization of this class is not supported.

Parameters

stream:ObjectInputStream: the ObjectInputStream from which data is read

Annotations

@Serial

Exceptions

IOException:: if an I/O error occurs
ClassNotFoundException:: if a serialized class cannot be loaded

writeReplace	back to summary
private Object writeReplace() throws ObjectStreamException Replace the PBE key to be serialized. Returns:Object the standard KeyRep object to be serialized Annotations @Serial Exceptions ObjectStreamException: if a new object representing this PBE key could not be created

writeReplace

back to summary

private Object writeReplace() throws ObjectStreamException

Replace the PBE key to be serialized.

Returns:Object

the standard KeyRep object to be serialized

Annotations

@Serial

Exceptions

ObjectStreamException:: if a new object representing this PBE key could not be created

public final Class PBKDF2KeyImpl

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail