net.sf.mmm.crypto.crypt.AbstractGetNonceSize 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 java.io.OutputStream;

/**
 * Interface to {@link #getNonceSize() get} the nonce size.
 *
 * @author Joerg Hohwiller (hohwille at users.sourceforge.net)
 * @since 1.0.0
 */
public interface AbstractGetNonceSize {

  /**
   * Unlike {@link javax.crypto.Cipher} this API is designed for ease of use. Some cryptographic algorithms require an
   * {@link javax.crypto.Cipher#getIV() 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 {@link Cryptor#crypt(byte[], boolean) crypt}
   * and for {@link Encryptor#wrapStream(OutputStream) streaming}.
   *
   * @return the size of the nonce in bytes or {@code 0} for none.
   * @see javax.crypto.Cipher#getIV()
   */
  int getNonceSize();

}