net.sf.mmm.crypto.crypt.CryptorConfig Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mmm-crypto-jce Show documentation

Library for simple and more secure usage of cryptography (JCA and JCE).

The newest version!

package net.sf.mmm.crypto.crypt;

import net.sf.mmm.crypto.algorithm.CryptoAlgorithmConfig;
import net.sf.mmm.crypto.provider.SecurityProvider;

/**
 * Class of an {@link CryptoAlgorithmConfig algorithm configuration} for
 * {@link Encryptor#crypt(byte[], boolean) encryption} and {@link Decryptor#crypt(byte[], boolean)
 * decryption}.
 *
 * @author Joerg Hohwiller (hohwille at users.sourceforge.net)
 * @since 1.0.0
 */
public class CryptorConfig extends CryptoAlgorithmConfig implements AbstractGetNonceSize {

  private final CipherTransformation transformation;

  private final int nonceSize;

  /**
   * The constructor.
   *
   * @param transformation the {@link #getTransformation() transfomation} for the {@link javax.crypto.Cipher}.
   * @param provider the {@link SecurityProvider}.
   * @param nonceSize the {@link #getNonceSize() nonce size}.
   */
  public CryptorConfig(CipherTransformation transformation, SecurityProvider provider, int nonceSize) {

    super(transformation.getTransformation(), provider);
    this.transformation = transformation;
    this.nonceSize = nonceSize;
  }

  /**
   * @return the {@link CipherTransformation}.
   */
  public CipherTransformation getTransformation() {

    return this.transformation;
  }

  /**
   * This method returns {@code 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.
   *
   * @return {@code true} if the {@link #getNonceSize() nonce} should be created individually from
   *         {@link java.security.SecureRandom}, {@code false} to get from {@link javax.crypto.Cipher#getIV()
   *         initialization vector}.
   */
  public boolean isCreateRandomNonce() {

    return false;
  }

  @Override
  public final int getNonceSize() {

    return this.nonceSize;
  }

}