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

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

```
@ThreadSafe
@Immutable
public class Crypt
extends Object
```
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.

Version:

$Id: Crypt.java 17 2014-09-11 22:39:42Z michaels-apps $

Author:

Michael Bock

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 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, String passwordHashingAlgorithm)` Constructs a Crypt object with the specified parameters.
`Crypt(String encryptionAlgorithm, int keySize, int blockSize, String passwordHashingAlgorithm, String blockMode, String padding)` Constructs a Crypt object with the specified parameters

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, String password)` Decrypts the input data and returns the plain text
`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, String password)` Decrypts all input from the given input stream to the given outputs tream.
`byte[]`	`encrypt(byte[] input, byte[] passwordBytes)` Encrypts the input data and returns the cipher text
`byte[]`	`encrypt(byte[] input, String password)` Encrypts the input data and returns the cipher text
`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, String password)` Encrypts all input from the given input stream to the given output stream.
`int`	`getBlockSize()` Returns the block size in bits
`byte[]`	`getHashedEncryptionKey(String password)` Hashes an password string
`int`	`getKeySize()` Returns the key size in bits

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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!
- Constructor Detail
  - Crypt
```
public Crypt(@Nonnull
     String encryptionAlgorithm,
     int keySize,
     int blockSize,
     @Nonnull
     String passwordHashingAlgorithm,
     @Nonnull
     String blockMode,
     @Nonnull
     String 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!
    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)
  - 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
  - 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 hasing 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!
- Method Detail
  - getKeySize
```
public int getKeySize()
```
    Returns the key size in bits
    
    Returns:
    the key size in bits
  - getBlockSize
```
public int getBlockSize()
```
    Returns the block size in bits
    
    Returns:
    the block size in bits
  - encrypt
```
public long encrypt(@Nonnull@WillNotClose
           InputStream input,
           @Nonnull@WillClose
           OutputStream output,
           @Nonnull
           String password)
             throws IOException
```
    Encrypts all input from the given input stream to the given output stream. The input stream will not be closed. The output stream 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
  - encrypt
```
public long encrypt(@Nonnull@WillNotClose
           InputStream input,
           @Nonnull@WillClose
           OutputStream output,
           @Nonnull
           byte[] passwordBytes)
             throws IOException
```
    Encrypts all input from the given input stream to the given output stream. The input stream will not be closed. The output stream 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
  - decrypt
```
public long decrypt(@Nonnull@WillNotClose
           InputStream input,
           @Nonnull@WillClose
           OutputStream output,
           @Nonnull
           String password)
             throws IOException
```
    Decrypts all input from the given input stream to the given outputs tream. The input stream will not be closed. The output stream 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
  - decrypt
```
public long decrypt(@Nonnull@WillNotClose
           InputStream input,
           @Nonnull@WillClose
           OutputStream output,
           @Nonnull
           byte[] passwordBytes)
             throws IOException
```
    Decrypts all input from the given input stream to the given output stream. The input stream will not be closed. The output stream 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
  - encrypt
```
@Nonnull
public byte[] encrypt(@Nonnull
                     byte[] input,
                     @Nonnull
                     String 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
  - 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
  - decrypt
```
@Nonnull
public byte[] decrypt(@Nonnull
                     byte[] input,
                     @Nonnull
                     String 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
  - 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
  - getHashedEncryptionKey
```
@Nonnull
public byte[] getHashedEncryptionKey(@Nonnull
                                    String password)
```
    Hashes an password string
    
    Parameters:
    password - the string password
    
    Returns:
    the hashed password bytes

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

Constructor Detail

Crypt

Crypt

Crypt

Method Detail

getKeySize

getBlockSize

encrypt

encrypt

decrypt

decrypt

encrypt

encrypt

decrypt

decrypt

getHashedEncryptionKey