PasswordBasedCipher (XWiki Commons - Crypto - Password API 15.0 API)

All Superinterfaces:

Cipher
```
public interface PasswordBasedCipher
extends Cipher
```
Password based cipher.

Since:

5.4M1

Version:

$Id: fbdcae1ffc596d829ca6d85c5adf6e31df7546e2 $

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`byte[]`	`getEncoded()`	Serialize the definition of this password based cipher.
`KeyDerivationFunction`	`getKeyDerivationFunction()`
`SymmetricCipherParameters`	`getParameters()`

Methods inherited from interface org.xwiki.crypto.cipher.Cipher
doFinal, doFinal, doFinal, getAlgorithmName, getInputBlockSize, getInputStream, getOutputBlockSize, getOutputStream, isForEncryption, update, update

- Method Detail
  - getKeyDerivationFunction
```
KeyDerivationFunction getKeyDerivationFunction()
```
    Returns:
    
    the key derivation function that has been used to derive the password of this cipher.
  - getParameters
```
SymmetricCipherParameters getParameters()
```
    Returns:
    
    the cipher parameters that has been used to initialize this cipher.
  - getEncoded
```
byte[] getEncoded()
           throws IOException
```
    Serialize the definition of this password based cipher. This serialization could be provided to an appropriate factory (like the one that have been used to create this cipher) to produce an equivalent cipher. The serialization contains the derivation function algorithm and parameters, and the cipher parameters. For best interoperability, the recommended encoding is ASN.1 in DER format.
    
    Returns:
    
    an encoded definition of this password based cipher.
    
    Throws:
    
    IOException - on error