java.lang.Object
- io.github.mmm.crypto.CryptoConfig
- - io.github.mmm.crypto.algorithm.CryptoAlgorithmConfig
  - - io.github.mmm.crypto.crypt.CryptorConfig

All Implemented Interfaces:

CryptoAlgorithm, AbstractGetNonceSize

Direct Known Subclasses:

AsymmetricCryptorConfig, SymmetricCryptorConfig
```
public class CryptorConfig
extends CryptoAlgorithmConfig
implements AbstractGetNonceSize
```
Class of an algorithm configuration for encryption and decryption.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary
- Fields inherited from class io.github.mmm.crypto.algorithm.CryptoAlgorithmConfig
  algorithm
- Fields inherited from class io.github.mmm.crypto.CryptoConfig
  provider

Constructor Summary

Constructors
Constructor Description

CryptorConfig(CipherTransformation transformation, SecurityProvider provider, int nonceSize)
The constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`getNonceSize()`	Unlike `Cipher` this API is designed for ease of use.
`CipherTransformation`	`getTransformation()`
`boolean`	`isCreateRandomNonce()`	This method returns `false` by default.

Methods inherited from class io.github.mmm.crypto.algorithm.CryptoAlgorithmConfig
getAlgorithm

Methods inherited from class io.github.mmm.crypto.CryptoConfig
getProvider

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

- Constructor Detail
  - CryptorConfig
```
public CryptorConfig(CipherTransformation transformation,
                     SecurityProvider provider,
                     int nonceSize)
```
    The constructor.
    
    Parameters:
    
    transformation - the transfomation for the Cipher.
    
    provider - the SecurityProvider.
    
    nonceSize - the nonce size.
- Method Detail
  - getTransformation
```
public CipherTransformation getTransformation()
```
    Returns:
    
    the CipherTransformation.
  - isCreateRandomNonce
```
public boolean isCreateRandomNonce()
```
    This method returns false by default. You may override this method to create a random nonce individually but only if you know exactly what you are doing and what are the details about the cryptographic algorithm.
    
    Returns:
    
    true if the nonce should be created individually from SecureRandom, false to get from initialization vector.
  - getNonceSize
```
public final int getNonceSize()
```
    Description copied from interface: AbstractGetNonceSize
    
    Unlike Cipher this API is designed for ease of use. Some cryptographic algorithms require an initialization vector (IV) and others do not. With this API you do not have to care and cannot do things wrong. The nonce will be prepended automatically to the encrypted payload and reconstructed from there on decryption. This works both for crypt and for streaming.
    
    Specified by:
    
    getNonceSize in interface AbstractGetNonceSize
    
    Returns:
    
    the size of the nonce in bytes or 0 for none.
    
    See Also:
    
    Cipher.getIV()

Class CryptorConfig

Field Summary

Fields inherited from class io.github.mmm.crypto.algorithm.CryptoAlgorithmConfig

Fields inherited from class io.github.mmm.crypto.CryptoConfig

Constructor Summary

Method Summary

Methods inherited from class io.github.mmm.crypto.algorithm.CryptoAlgorithmConfig

Methods inherited from class io.github.mmm.crypto.CryptoConfig

Methods inherited from class java.lang.Object

Constructor Detail

CryptorConfig

Method Detail

getTransformation

isCreateRandomNonce

getNonceSize