Crypt (de.mibos:commons-crypt 1.4 API)

java.lang.Object
- de.mibos.commons.crypt.Crypt

All Implemented Interfaces:

Serializable
```
@ThreadSafe
@Immutable
public class Crypt
extends Object
implements Serializable
```
A collection of methods for easy to use symmetric encryption and decryption. You can create your own crypt instances but it is recommended to use the predefined ones.

Since:

1.0 $Id: Crypt.java 63 2014-10-07 22:00:14Z michaels-apps $

Version:

1.4

Author:

Michael Bock

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static Crypt`	`AES128` The encryption algorithm AES with 128 Bits key size.
`static Crypt`	`AES192` The encryption algorithm AES with 192 Bits key size.
`static Crypt`	`AES256` The encryption algorithm AES with 256 Bits key size.
`static Crypt`	`Blowfish128` Bruce Schneiers encryption algorithm Blowfish with 128 Bits key size.
`static Crypt`	`Blowfish192` Bruce Schneiers encryption algorithm Blowfish with 192 Bits key size.
`static Crypt`	`Blowfish256` Bruce Schneiers encryption algorithm Blowfish with 256 Bits key size.
`static String`	`DEFAULT_BLOCK_CHAIN_MODE` Deprecated. use `BlockMode.DEFAULT_BLOCK_CHAIN_MODE` instead
`static String`	`DEFAULT_PADDING_ALGORITHM` Deprecated. use `Padding.DEFAULT_PADDING_ALGORITHM` instead
`static String`	`DEFAULT_PASSWORD_HASHING_ALGORITHM` The default algorithm for password hashing
`static Crypt`	`DES192` The encryption algorithm Triple-DES with 192 Bits key size (effective key size 168 bits, the effective key size for brute force is smaller than 168 bits).
`static Crypt`	`DES64` The encryption algorithm DES with 64 Bits key size (effective key size 56 bits!).

Constructor Summary

Constructors
Constructor and Description
`Crypt(String encryptionAlgorithm, int keySize, int blockSize)` Constructs a Crypt object with the specified parameters.
`Crypt(String encryptionAlgorithm, int keySize, int blockSize, BlockMode blockMode, Padding padding)` Constructs a Crypt object with the specified parameters
`Crypt(String encryptionAlgorithm, int keySize, int blockSize, String passwordHashingAlgorithm)` Constructs a Crypt object with the specified parameters.
`Crypt(String encryptionAlgorithm, int keySize, int blockSize, String passwordHashingAlgorithm, BlockMode blockMode, Padding padding)` Constructs a Crypt object with the specified parameters
`Crypt(String encryptionAlgorithm, int keySize, int blockSize, String passwordHashingAlgorithm, BlockMode blockMode, Padding padding, int bufferSize)` Constructs a Crypt object with the specified parameters
`Crypt(String encryptionAlgorithm, int keySize, int blockSize, String blockMode, String padding)` Deprecated. use `Crypt(String, int, int, BlockMode, Padding)` instead
`Crypt(String encryptionAlgorithm, int keySize, int blockSize, String passwordHashingAlgorithm, String blockMode, String padding)` Deprecated. use `Crypt(String, int, int, String, BlockMode, Padding)` instead
`Crypt(String encryptionAlgorithm, int keySize, int blockSize, String passwordHashingAlgorithm, String blockMode, String padding, int bufferSize)` Deprecated. use `Crypt(String, int, int, String, BlockMode, Padding, int)` instead

Method Summary

Methods
Modifier and Type	Method and Description
`byte[]`	`decrypt(byte[] input, byte[] passwordBytes)` Decrypts the input data and returns the plain text
`byte[]`	`decrypt(byte[] input, CharSequence password)` Decrypts the input data and returns the plain text
`long`	`decrypt(ByteBuffer input, ByteBuffer output, byte[] passwordBytes)` Decrypts all input from the given byte buffer to the given byte buffer
`long`	`decrypt(ByteBuffer input, ByteBuffer output, CharSequence password)` Decrypts all input from the given byte buffer to the given byte buffer
`long`	`decrypt(InputStream input, OutputStream output, byte[] passwordBytes)` Decrypts all input from the given input stream to the given output stream.
`long`	`decrypt(InputStream input, OutputStream output, CharSequence password)` Decrypts all input from the given input stream to the given outputs stream.
`byte[]`	`encrypt(byte[] input, byte[] passwordBytes)` Encrypts the input data and returns the cipher text
`byte[]`	`encrypt(byte[] input, CharSequence password)` Encrypts the input data and returns the cipher text
`long`	`encrypt(ByteBuffer input, ByteBuffer output, byte[] passwordBytes)` Encrypts all input from the given byte buffer to the given byte buffer
`long`	`encrypt(ByteBuffer input, ByteBuffer output, CharSequence password)` Encrypts all input from the given byte buffer to the given byte buffer
`long`	`encrypt(InputStream input, OutputStream output, byte[] passwordBytes)` Encrypts all input from the given input stream to the given output stream.
`long`	`encrypt(InputStream input, OutputStream output, CharSequence password)` Encrypts all input from the given input stream to the given output stream.
`boolean`	`equals(Object o)` Is this Crypt equal to the given object
`BlockMode`	`getBlockMode()` Returns the block mode
`int`	`getBlockSize()` Returns the block size in bits
`int`	`getBufferSize()` Returns the buffer size
`String`	`getEncryptionAlgorithm()` Returns the encryption algorithm
`String`	`getEncryptionMethod()` Returns the encryption method string
`byte[]`	`getHashedEncryptionKey(CharSequence password)` Hashes a password string
`CryptInputStream`	`getInputStream(InputStream input, byte[] passwordBytes)` Creates an input stream for this Crypt This is simply an extension to the standard `CipherInputStream`, which reads the initialization vector in this method.
`CryptInputStream`	`getInputStream(InputStream input, CharSequence password)` Creates an input stream for this Crypt This is simply an extension to the standard `CipherInputStream`, which reads the initialization vector in this method.
`int`	`getKeySize()` Returns the key size in bits
`long`	`getMaximumCipherTextLength(long plainTextLength)` Returns the maximum bytes needed for the cipher text for a given plain text length
`long`	`getMaximumPlainTextLength(long cipherTextLength)` Returns the maximum bytes needed for the plain text for a given cipher text length
`CryptOutputStream`	`getOutputStream(OutputStream output, byte[] passwordBytes)` Creates an output stream for this Crypt.
`CryptOutputStream`	`getOutputStream(OutputStream output, CharSequence password)` Creates an output stream for this Crypt.
`Padding`	`getPadding()` Returns the padding
`String`	`getPasswordHashingAlgorithm()` Returns the password hashing algorithm
`int`	`hashCode()` The hash code of this crypt
`String`	`toString()` String description of this Crypt

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - AES256
```
public static final Crypt AES256
```
    The encryption algorithm AES with 256 Bits key size. Block mode is CBC, the random initialization vector is putted in front of the cipher text. PKCS5 is used for padding of the last cipher block.
    This is the recommended Crypt for general purpose encryption!
  - AES192
```
public static final Crypt AES192
```
    The encryption algorithm AES with 192 Bits key size. Block mode is CBC, the random initialization vector is putted in front of the cipher text. PKCS5 is used for padding of the last cipher block.
  - AES128
```
public static final Crypt AES128
```
    The encryption algorithm AES with 128 Bits key size. Block mode is CBC, the random initialization vector is putted in front of the cipher text. PKCS5 is used for padding of the last cipher block.
  - Blowfish256
```
public static final Crypt Blowfish256
```
    Bruce Schneiers encryption algorithm Blowfish with 256 Bits key size. Block mode is CBC, the random initialization vector is putted in front of the cipher text. PKCS5 is used for padding of the last cipher block.
  - Blowfish192
```
public static final Crypt Blowfish192
```
    Bruce Schneiers encryption algorithm Blowfish with 192 Bits key size. Block mode is CBC, the random initialization vector is putted in front of the cipher text. PKCS5 is used for padding of the last cipher block.
  - Blowfish128
```
public static final Crypt Blowfish128
```
    Bruce Schneiers encryption algorithm Blowfish with 128 Bits key size. Block mode is CBC, the random initialization vector is putted in front of the cipher text. PKCS5 is used for padding of the last cipher block.
  - DES64
```
public static final Crypt DES64
```
    The encryption algorithm DES with 64 Bits key size (effective key size 56 bits!). Block mode is CBC, the random initialization vector is putted in front of the cipher text. PKCS5 is used for padding of the last cipher block.
    This Crypt is generally not recommended!
  - DES192
```
public static final Crypt DES192
```
    The encryption algorithm Triple-DES with 192 Bits key size (effective key size 168 bits, the effective key size for brute force is smaller than 168 bits). Block mode is CBC, the random initialization vector is putted in front of the cipher text. PKCS5 is used for padding of the last cipher block.
    This Crypt is not recommended!
  - DEFAULT_PASSWORD_HASHING_ALGORITHM
```
public static final String DEFAULT_PASSWORD_HASHING_ALGORITHM
```
    The default algorithm for password hashing
    
    See Also:
    Constant Field Values
  - DEFAULT_BLOCK_CHAIN_MODE
```
public static final String DEFAULT_BLOCK_CHAIN_MODE
```
    Deprecated. use BlockMode.DEFAULT_BLOCK_CHAIN_MODE instead
    
    The default algorithm for block chain mode
  - DEFAULT_PADDING_ALGORITHM
```
public static final String DEFAULT_PADDING_ALGORITHM
```
    Deprecated. use Padding.DEFAULT_PADDING_ALGORITHM instead
    
    The default algorithm for padding
- Constructor Detail
  - Crypt
```
public Crypt(@Nonnull
     String encryptionAlgorithm,
     int keySize,
     int blockSize,
     @Nonnull
     String passwordHashingAlgorithm,
     @Nonnull
     String blockMode,
     @Nonnull
     String padding,
     int bufferSize)
```
    Deprecated. use Crypt(String, int, int, String, BlockMode, Padding, int) instead
    
    Constructs a Crypt object with the specified parameters
    
    Parameters:
    encryptionAlgorithm - the encryption algorithm (see http://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html)
    keySize - the key size in bits. Compatibility to the encryption algorithm is not checked, so a CryptoInitializationProblem may be throw later
    blockSize - the block size in bits. Compatibility to the encryption algorithm is not checked!
    passwordHashingAlgorithm - the password hashing algorithm for String passwords
    blockMode - the block encoding mode. Modes other than CBC are not always supported. ECB is strongly discouraged
    padding - the padding mode (see http://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html)
    bufferSize - size of the buffer for io operations
    Since:
    
    1.0
  - Crypt
```
public Crypt(@Nonnull
     String encryptionAlgorithm,
     int keySize,
     int blockSize,
     @Nonnull
     String passwordHashingAlgorithm,
     @Nonnull
     BlockMode blockMode,
     @Nonnull
     Padding padding,
     int bufferSize)
```
    Constructs a Crypt object with the specified parameters
    
    Parameters:
    encryptionAlgorithm - the encryption algorithm (see http://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html)
    keySize - the key size in bits. Compatibility to the encryption algorithm is not checked, so a CryptoInitializationProblem may be throw later
    blockSize - the block size in bits. Compatibility to the encryption algorithm is not checked!
    passwordHashingAlgorithm - the password hashing algorithm for String passwords
    blockMode - the block encoding mode. Modes other than CBC are not always supported. ECB is strongly discouraged
    padding - the padding mode (see http://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html)
    bufferSize - size of the buffer for io operations
    Since:
    
    1.4
  - Crypt
```
public Crypt(@Nonnull
     String encryptionAlgorithm,
     int keySize,
     int blockSize,
     @Nonnull
     String passwordHashingAlgorithm,
     @Nonnull
     String blockMode,
     @Nonnull
     String padding)
```
    Deprecated. use Crypt(String, int, int, String, BlockMode, Padding) instead
    
    Constructs a Crypt object with the specified parameters
    
    Parameters:
    encryptionAlgorithm - the encryption algorithm (see http://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html)
    keySize - the key size in bits. Compatibility to the encryption algorithm is not checked, so a CryptoInitializationProblem may be throw later
    blockSize - the block size in bits. Compatibility to the encryption algorithm is not checked!
    passwordHashingAlgorithm - the password hashing algorithm for String passwords
    blockMode - the block encoding mode. Modes other than CBC are not always supported. ECB is strongly discouraged
    padding - the padding mode (see http://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html)
    Since:
    
    1.0
  - Crypt
```
public Crypt(@Nonnull
     String encryptionAlgorithm,
     int keySize,
     int blockSize,
     @Nonnull
     String passwordHashingAlgorithm,
     @Nonnull
     BlockMode blockMode,
     @Nonnull
     Padding padding)
```
    Constructs a Crypt object with the specified parameters
    
    Parameters:
    encryptionAlgorithm - the encryption algorithm (see http://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html)
    keySize - the key size in bits. Compatibility to the encryption algorithm is not checked, so a CryptoInitializationProblem may be throw later
    blockSize - the block size in bits. Compatibility to the encryption algorithm is not checked!
    passwordHashingAlgorithm - the password hashing algorithm for String passwords
    blockMode - the block encoding mode. Modes other than CBC are not always supported. ECB is strongly discouraged
    padding - the padding mode (see http://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html)
    Since:
    
    1.4
  - Crypt
```
public Crypt(@Nonnull
     String encryptionAlgorithm,
     int keySize,
     int blockSize,
     @Nonnull
     String blockMode,
     @Nonnull
     String padding)
```
    Deprecated. use Crypt(String, int, int, BlockMode, Padding) instead
    
    Constructs a Crypt object with the specified parameters
    
    Parameters:
    encryptionAlgorithm - the encryption algorithm (see http://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html)
    keySize - the key size in bits. Compatibility to the encryption algorithm is not checked, so a CryptoInitializationProblem may be throw later
    blockSize - the block size in bits. Compatibility to the encryption algorithm is not checked!
    blockMode - the block encoding mode. Modes other than CBC are not always supported. ECB is unsupported
    padding - the padding mode (see http://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html)
    Since:
    
    1.0
  - Crypt
```
public Crypt(@Nonnull
     String encryptionAlgorithm,
     int keySize,
     int blockSize,
     @Nonnull
     BlockMode blockMode,
     @Nonnull
     Padding padding)
```
    Constructs a Crypt object with the specified parameters
    
    Parameters:
    encryptionAlgorithm - the encryption algorithm (see http://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html)
    keySize - the key size in bits. Compatibility to the encryption algorithm is not checked, so a CryptoInitializationProblem may be throw later
    blockSize - the block size in bits. Compatibility to the encryption algorithm is not checked!
    blockMode - the block encoding mode. Modes other than CBC are not always supported. ECB is unsupported
    padding - the padding mode (see http://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html)
    Since:
    
    1.4
  - Crypt
```
public Crypt(@Nonnull
     String encryptionAlgorithm,
     int keySize,
     int blockSize,
     @Nonnull
     String passwordHashingAlgorithm)
```
    Constructs a Crypt object with the specified parameters. For blockMode CBC is used. For padding PKCS5Padding is used
    
    Parameters:
    encryptionAlgorithm - the encryption algorithm (see http://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html)
    keySize - the key size in bits. Compatibility to the encryption algorithm is not checked!
    blockSize - the block size in bits. Compatibility to the encryption algorithm is not checked!
    passwordHashingAlgorithm - the password hashing algorithm for String passwords
    Since:
    
    1.0
  - Crypt
```
public Crypt(@Nonnull
     String encryptionAlgorithm,
     int keySize,
     int blockSize)
```
    Constructs a Crypt object with the specified parameters. For blockMode CBC is used. For padding PKCS5Padding is used. SHA-256 is used as password hashing algorithm.
    
    Parameters:
    encryptionAlgorithm - the encryption algorithm (see http://docs.oracle.com/javase/7/docs/technotes/guides/security/StandardNames.html)
    keySize - the key size in bits. Compatibility to the encryption algorithm is not checked!
    blockSize - the block size in bits. Compatibility to the encryption algorithm is not checked!
    Since:
    
    1.0
- Method Detail
  - getKeySize
```
public int getKeySize()
```
    Returns the key size in bits
    
    Returns:
    the key size in bits
    Since:
    
    1.0
  - getBlockSize
```
public int getBlockSize()
```
    Returns the block size in bits
    
    Returns:
    the block size in bits
  - getEncryptionMethod
```
@Nonnull
public String getEncryptionMethod()
```
    Returns the encryption method string
    
    Returns:
    the encryption method string
  - encrypt
```
public long encrypt(@Nonnull@WillClose
           InputStream input,
           @Nonnull@WillClose
           OutputStream output,
           @Nonnull
           CharSequence password)
             throws IOException
```
    Encrypts all input from the given input stream to the given output stream. Both streams will be closed.
    
    Parameters:
    input - plain text input stream
    output - cipher text output stream
    password - password for encryption. The password used actually used will be the hash of this String using the specified password hashing algorithm
    
    Returns:
    the number of bytes written to the cipher text output stream
    
    Throws:
    
    IOException - in case of an underlying IOException of the streams
    
    CryptoInitializationProblem - in case of a CryptoInitializationProblem problem
    Since:
    
    1.0
  - encrypt
```
public long encrypt(@Nonnull@WillClose
           InputStream input,
           @Nonnull@WillClose
           OutputStream output,
           @Nonnull
           byte[] passwordBytes)
             throws IOException
```
    Encrypts all input from the given input stream to the given output stream. Both streams will be closed.
    
    Parameters:
    input - plain text input stream
    output - cipher text output stream
    passwordBytes - the used password. The length must be compatible to the used encryption algorithm
    
    Returns:
    the number of bytes written to the cipher text output stream
    
    Throws:
    
    IOException - in case of an underlying IOException of the streams
    
    CryptoInitializationProblem - in case of a CryptoInitializationProblem problem
    Since:
    
    1.0
  - encrypt
```
@Nonnull
public byte[] encrypt(@Nonnull
                     byte[] input,
                     @Nonnull
                     CharSequence password)
```
    Encrypts the input data and returns the cipher text
    
    Parameters:
    input - plain text
    password - password for encryption. The password used actually used will be the hash of this String using the specified password hashing algorithm
    
    Returns:
    cipher text
    
    Throws:
    
    CryptoInitializationProblem - in case of a CryptoInitializationProblem problem
    Since:
    
    1.0
  - encrypt
```
@Nonnull
public byte[] encrypt(@Nonnull
                     byte[] input,
                     @Nonnull
                     byte[] passwordBytes)
```
    Encrypts the input data and returns the cipher text
    
    Parameters:
    input - plain text
    passwordBytes - the used password. The length must be compatible to the used encryption algorithm
    
    Returns:
    cipher text
    
    Throws:
    
    CryptoInitializationProblem - in case of a CryptoInitializationProblem problem
    Since:
    
    1.0
  - encrypt
```
public long encrypt(@Nonnull
           ByteBuffer input,
           @Nonnull
           ByteBuffer output,
           @Nonnull
           CharSequence password)
```
    Encrypts all input from the given byte buffer to the given byte buffer
    
    Parameters:
    input - plain text byte buffer
    output - cipher text byte buffer
    password - password for encryption. The password used actually used will be the hash of this String using the specified password hashing algorithm
    
    Returns:
    cipher text
    
    Throws:
    
    CryptoInitializationProblem - in case of a CryptoInitializationProblem problem
    Since:
    
    1.3
  - encrypt
```
public long encrypt(@Nonnull
           ByteBuffer input,
           @Nonnull
           ByteBuffer output,
           @Nonnull
           byte[] passwordBytes)
```
    Encrypts all input from the given byte buffer to the given byte buffer
    
    Parameters:
    input - plain text byte buffer
    output - cipher text byte buffer
    passwordBytes - the used password. The length must be compatible to the used encryption algorithm
    
    Returns:
    the number of bytes written to the cipher text byte buffer
    
    Throws:
    
    CryptoInitializationProblem - in case of a CryptoInitializationProblem problem
    Since:
    
    1.3
  - decrypt
```
public long decrypt(@Nonnull@WillClose
           InputStream input,
           @Nonnull@WillClose
           OutputStream output,
           @Nonnull
           CharSequence password)
             throws IOException
```
    Decrypts all input from the given input stream to the given outputs stream. Both streams will be closed.
    
    Parameters:
    input - cipher text input stream
    output - plain text output stream
    password - password for decryption. The password used actually used will be the hash of this String using the specified password hashing algorithm
    
    Returns:
    the number of bytes written to the plain text output stream
    
    Throws:
    
    IOException - in case of an underlying IOException of the streams
    
    CryptoInitializationProblem - in case of a CryptoInitializationProblem problem
    Since:
    
    1.0
  - decrypt
```
public long decrypt(@Nonnull@WillClose
           InputStream input,
           @Nonnull@WillClose
           OutputStream output,
           @Nonnull
           byte[] passwordBytes)
             throws IOException
```
    Decrypts all input from the given input stream to the given output stream. Both streams will be closed.
    
    Parameters:
    input - cipher text input stream
    output - plain text output stream
    passwordBytes - the used password. The length must be compatible to the used encryption algorithm
    
    Returns:
    the number of bytes written to the plain text output stream
    
    Throws:
    
    IOException - in case of an underlying IOException of the streams
    
    CryptoInitializationProblem - in case of a CryptoInitializationProblem problem
    Since:
    
    1.0
  - decrypt
```
@Nonnull
public byte[] decrypt(@Nonnull
                     byte[] input,
                     @Nonnull
                     CharSequence password)
```
    Decrypts the input data and returns the plain text
    
    Parameters:
    input - cipher text
    password - password for decryption. The password used actually used will be the hash of this String using the specified password hashing algorithm
    
    Returns:
    plain text
    
    Throws:
    
    CryptoInitializationProblem - in case of a CryptoInitializationProblem problem
    Since:
    
    1.0
  - decrypt
```
@Nonnull
public byte[] decrypt(@Nonnull
                     byte[] input,
                     @Nonnull
                     byte[] passwordBytes)
```
    Decrypts the input data and returns the plain text
    
    Parameters:
    input - cipher text
    passwordBytes - the used password. The length must be compatible to the used encryption algorithm
    
    Returns:
    plain text
    
    Throws:
    
    CryptoInitializationProblem - in case of a CryptoInitializationProblem problem
    Since:
    
    1.0
  - decrypt
```
public long decrypt(@Nonnull
           ByteBuffer input,
           @Nonnull
           ByteBuffer output,
           @Nonnull
           CharSequence password)
```
    Decrypts all input from the given byte buffer to the given byte buffer
    
    Parameters:
    input - cipher text byte buffer
    output - test text byte buffer
    password - password for decryption. The password used actually used will be the hash of this String using the specified password hashing algorithm
    
    Returns:
    cipher text
    
    Throws:
    
    CryptoInitializationProblem - in case of a CryptoInitializationProblem problem
    
    CryptoBufferOverflowException - not enough bytes in output
    
    CryptoInvalidCipherTextException - invalid cipher text
    Since:
    
    1.3
  - decrypt
```
public long decrypt(@Nonnull
           ByteBuffer input,
           @Nonnull
           ByteBuffer output,
           @Nonnull
           byte[] passwordBytes)
```
    Decrypts all input from the given byte buffer to the given byte buffer
    
    Parameters:
    input - cipher text byte buffer
    output - test text byte buffer
    passwordBytes - the used password. The length must be compatible to the used encryption algorithm
    
    Returns:
    the number of bytes written to the cipher text byte buffer
    
    Throws:
    
    CryptoInitializationProblem - in case of a CryptoInitializationProblem problem
    
    CryptoBufferOverflowException - not enough bytes in output
    
    CryptoInvalidCipherTextException - invalid cipher text
    Since:
    
    1.3
  - getInputStream
```
public CryptInputStream getInputStream(@Nonnull
                              InputStream input,
                              @Nonnull
                              CharSequence password)
                                throws IOException
```
    Creates an input stream for this Crypt This is simply an extension to the standard CipherInputStream, which reads the initialization vector in this method. Please ensure that close is always called explicitly for this stream object. Failing to do so will result in missing plain text bytes.
    
    Parameters:
    input - the cipher input stream
    password - the password
    
    Throws:
    
    IOException - IOException if failing to read the initialization vector
    
    CryptoInitializationProblem - in case of a CryptoInitializationProblem problem
    Since:
    
    1.3
  - getInputStream
```
public CryptInputStream getInputStream(@Nonnull
                              InputStream input,
                              @Nonnull
                              byte[] passwordBytes)
                                throws IOException
```
    Creates an input stream for this Crypt This is simply an extension to the standard CipherInputStream, which reads the initialization vector in this method. to read the initialization vector. Please ensure that close is always called explicitly for this stream object. Failing to do so will result in missing plain text bytes.
    
    Parameters:
    input - the cipher input stream
    passwordBytes - the password bytes
    
    Throws:
    
    IOException - IOException if failing to read the initialization vector
    
    CryptoInitializationProblem - in case of a CryptoInitializationProblem problem
    Since:
    
    1.3
  - getOutputStream
```
public CryptOutputStream getOutputStream(@Nonnull
                                OutputStream output,
                                @Nonnull
                                CharSequence password)
                                  throws IOException
```
    Creates an output stream for this Crypt. This is simply an extension to the standard CipherOutputStream, which writes the initialization vector in this method. Please ensure that close is always called explicitly for this stream object. Failing to do so will result in missing cipher text bytes.
    
    Parameters:
    output - the cipher output stream
    password - the password
    
    Throws:
    
    IOException - IOException if failing to write the initialization vector
    
    CryptoInitializationProblem - in case of a CryptoInitializationProblem problem
    Since:
    
    1.3
  - getOutputStream
```
public CryptOutputStream getOutputStream(@Nonnull
                                OutputStream output,
                                @Nonnull
                                byte[] passwordBytes)
                                  throws IOException
```
    Creates an output stream for this Crypt. This is simply an extension to the standard CipherOutputStream, which writes the initialization vector in this method. Please ensure that close is always called explicitly for this stream object. Failing to do so will result in missing cipher text bytes.
    
    Parameters:
    output - the cipher output stream
    passwordBytes - the password bytes
    
    Throws:
    
    IOException - IOException if failing to write the initialization vector
    
    CryptoInitializationProblem - in case of a CryptoInitializationProblem problem
    Since:
    
    1.3
  - getMaximumCipherTextLength
```
public long getMaximumCipherTextLength(long plainTextLength)
```
    Returns the maximum bytes needed for the cipher text for a given plain text length
    
    Parameters:
    plainTextLength - plain text length
    
    Returns:
    maximum bytes needed for the cipher text
    Since:
    
    1.4
  - getMaximumPlainTextLength
```
public long getMaximumPlainTextLength(long cipherTextLength)
```
    Returns the maximum bytes needed for the plain text for a given cipher text length
    
    Parameters:
    cipherTextLength - cipher text length
    
    Returns:
    maximum bytes needed for the plain text
    Since:
    
    1.4
  - getHashedEncryptionKey
```
@Nonnull
public byte[] getHashedEncryptionKey(@Nonnull
                                    CharSequence password)
```
    Hashes a password string
    
    Parameters:
    password - the string password
    
    Returns:
    the hashed password bytes
    
    Throws:
    
    CryptoInitializationProblem - in case of a CryptoInitializationProblem problem
  - toString
```
public String toString()
```
    String description of this Crypt
    
    Overrides:
    
    toString in class Object
    
    Returns:
    String description of this Crypt
  - equals
```
public boolean equals(@CheckForNull
             Object o)
```
    Is this Crypt equal to the given object
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    o - the object to compare
    
    Returns:
    true, if this Crypt is equal to the given object
  - hashCode
```
public int hashCode()
```
    The hash code of this crypt
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    the hash code of this crypt
  - getEncryptionAlgorithm
```
@Nonnull
public String getEncryptionAlgorithm()
```
    Returns the encryption algorithm
    
    Returns:
    the encryption algorithm
    Since:
    
    1.4
  - getPasswordHashingAlgorithm
```
@Nonnull
public String getPasswordHashingAlgorithm()
```
    Returns the password hashing algorithm
    
    Returns:
    the password hashing algorithm
    Since:
    
    1.4
  - getBlockMode
```
@Nonnull
public BlockMode getBlockMode()
```
    Returns the block mode
    
    Returns:
    the block mode
    Since:
    
    1.4
  - getPadding
```
@Nonnull
public Padding getPadding()
```
    Returns the padding
    
    Returns:
    the padding
    Since:
    
    1.4
  - getBufferSize
```
public int getBufferSize()
```
    Returns the buffer size
    
    Returns:
    the buffer size
    Since:
    
    1.4

Class Crypt

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

AES256

AES192

AES128

Blowfish256

Blowfish192

Blowfish128

DES64

DES192

DEFAULT_PASSWORD_HASHING_ALGORITHM

DEFAULT_BLOCK_CHAIN_MODE

DEFAULT_PADDING_ALGORITHM

Constructor Detail

Crypt

Crypt

Crypt

Crypt

Crypt

Crypt

Crypt

Crypt

Method Detail

getKeySize

getBlockSize

getEncryptionMethod

encrypt

encrypt

encrypt

encrypt

encrypt

encrypt

decrypt

decrypt

decrypt

decrypt

decrypt

decrypt

getInputStream

getInputStream

getOutputStream

getOutputStream

getMaximumCipherTextLength

getMaximumPlainTextLength

getHashedEncryptionKey

toString

equals

hashCode

getEncryptionAlgorithm

getPasswordHashingAlgorithm

getBlockMode

getPadding

getBufferSize