Package org.bouncycastle.jcajce

## Class PBKDF2Key

- java.lang.Object
- - org.bouncycastle.jcajce.PBKDF2Key

- All Implemented Interfaces:
    `java.io.Serializable`, `java.security.Key`, `javax.crypto.SecretKey`, `javax.security.auth.Destroyable`, `PBKDFKey`
  Direct Known Subclasses:
    `PBKDF2KeyWithParameters`

      public class PBKDF2Key
      extends java.lang.Object
      implements PBKDFKey

  A password based key for use with PBKDF2 as defined in PKCS#5.
  See Also:
    Serialized Form

- - ### Field Summary

    - ### Fields inherited from interface javax.crypto.SecretKey

      `serialVersionUID`

  - ### Constructor Summary

    Constructors
    Constructor | Description
    --- | ---
    `PBKDF2Key​(char[] password, CharToByteConverter converter)` | Basic constructor for a password based key using PBKDF - secret key generation parameters will be passed separately..

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method | Description
    --- | --- | ---
    `java.lang.String` | `getAlgorithm()` | Return the password based key derivation function this key is for,
    `byte[]` | `getEncoded()` | Return the password converted to bytes.
    `java.lang.String` | `getFormat()` | Return the format encoding.
    `char[]` | `getPassword()` | Return a reference to the char[] array holding the password.

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

    - ### Methods inherited from interface javax.security.auth.Destroyable

      `destroy, isDestroyed`

- - ### Constructor Detail

    - #### PBKDF2Key

          public PBKDF2Key​(char[] password,
                           CharToByteConverter converter)

      Basic constructor for a password based key using PBKDF - secret key generation parameters will be passed separately..
      Parameters:
        `password` - password to use.

  - ### Method Detail

    - #### getPassword

          public char[] getPassword()

      Return a reference to the char[] array holding the password.
      Returns:
        a reference to the password array.

    - #### getAlgorithm

          public java.lang.String getAlgorithm()

      Return the password based key derivation function this key is for,
      Specified by:
        `getAlgorithm` in interface `java.security.Key`
      Returns:
        the string "PBKDF2"

    - #### getFormat

          public java.lang.String getFormat()

      Return the format encoding.
      Specified by:
        `getFormat` in interface `java.security.Key`
      Returns:
        the type name representing a char[] to byte[] conversion.

    - #### getEncoded

          public byte[] getEncoded()

      Return the password converted to bytes.
      Specified by:
        `getEncoded` in interface `java.security.Key`
      Returns:
        the password converted to a byte array.