- java.lang.Object
-
- javax.crypto.spec.PBEKeySpec
-
- All Implemented Interfaces:
- KeySpec
public class PBEKeySpec extends Object implements KeySpec
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.- Since:
- 1.4
- See Also:
SecretKeyFactory
,PBEParameterSpec
-
-
Constructor Summary
Constructors Constructor and Description PBEKeySpec(char[] password)
Constructor that takes a password.PBEKeySpec(char[] password, byte[] salt, int iterationCount)
Constructor that takes a password, salt, iteration count for generating PBEKey of fixed-key-size PBE ciphers.PBEKeySpec(char[] password, byte[] salt, int iterationCount, int keyLength)
Constructor that takes a password, salt, iteration count, and to-be-derived key length for generating PBEKey of variable-key-size PBE ciphers.
-
Method Summary
Methods Modifier and Type Method and Description void
clearPassword()
Clears the internal copy of the password.int
getIterationCount()
Returns the iteration count or 0 if not specified.int
getKeyLength()
Returns the to-be-derived key length or 0 if not specified.char[]
getPassword()
Returns a copy of the password.byte[]
getSalt()
Returns a copy of the salt or null if not specified.
-
-
-
Constructor Detail
-
PBEKeySpec
public PBEKeySpec(char[] password)
Constructor that takes a password. An empty char[] is used if null is specified.Note:
password
is cloned before it is stored in the newPBEKeySpec
object.- Parameters:
password
- the password.
-
PBEKeySpec
public PBEKeySpec(char[] password, byte[] salt, int iterationCount, int keyLength)
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 forpassword
.Note: the
password
andsalt
are cloned before they are stored in the newPBEKeySpec
object.- Parameters:
password
- the password.salt
- the salt.iterationCount
- the iteration count.keyLength
- the to-be-derived key length.- Throws:
NullPointerException
- ifsalt
is null.IllegalArgumentException
- ifsalt
is empty, i.e. 0-length,iterationCount
orkeyLength
is not positive.
-
PBEKeySpec
public PBEKeySpec(char[] password, byte[] salt, int iterationCount)
Constructor that takes a password, salt, iteration count for generating PBEKey of fixed-key-size PBE ciphers. An empty char[] is used if null is specified forpassword
.Note: the
password
andsalt
are cloned before they are stored in the newPBEKeySpec
object.- Parameters:
password
- the password.salt
- the salt.iterationCount
- the iteration count.- Throws:
NullPointerException
- ifsalt
is null.IllegalArgumentException
- ifsalt
is empty, i.e. 0-length, oriterationCount
is not positive.
-
-
Method Detail
-
clearPassword
public final void clearPassword()
Clears the internal copy of the password.
-
getPassword
public final char[] getPassword()
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.
- Throws:
IllegalStateException
- if password has been cleared by callingclearPassword
method.
-
getSalt
public final byte[] getSalt()
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.
-
getIterationCount
public final int getIterationCount()
Returns the iteration count or 0 if not specified.- Returns:
- the iteration count.
-
getKeyLength
public final int getKeyLength()
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.
-
-
Nederlandse vertaling
U hebt gevraagd om deze site in het Nederlands te bezoeken. Voor nu wordt alleen de interface vertaald, maar nog niet alle inhoud.Als je me wilt helpen met vertalingen, is je bijdrage welkom. Het enige dat u hoeft te doen, is u op de site registreren en mij een bericht sturen waarin u wordt gevraagd om u toe te voegen aan de groep vertalers, zodat u de gewenste pagina's kunt vertalen. Een link onderaan elke vertaalde pagina geeft aan dat u de vertaler bent en heeft een link naar uw profiel.
Bij voorbaat dank.
Document heeft de 11/06/2005 gemaakt, de laatste keer de 04/03/2020 gewijzigd
Bron van het afgedrukte document:https://www.gaudry.be/nl/java-api-rf-javax/crypto/spec/pbekeyspec.html
De infobrol is een persoonlijke site waarvan de inhoud uitsluitend mijn verantwoordelijkheid is. De tekst is beschikbaar onder CreativeCommons-licentie (BY-NC-SA). Meer info op de gebruiksvoorwaarden en de auteur.
Referenties
Deze verwijzingen en links verwijzen naar documenten die geraadpleegd zijn tijdens het schrijven van deze pagina, of die aanvullende informatie kunnen geven, maar de auteurs van deze bronnen kunnen niet verantwoordelijk worden gehouden voor de inhoud van deze pagina.
De auteur Deze site is als enige verantwoordelijk voor de manier waarop de verschillende concepten, en de vrijheden die met de referentiewerken worden genomen, hier worden gepresenteerd. Vergeet niet dat u meerdere broninformatie moet doorgeven om het risico op fouten te verkleinen.