org.bouncycastle.crypto.AEADOperatorFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bc-fips-debug Show documentation

The FIPS 140-2 Bouncy Castle Crypto package is a Java implementation of cryptographic algorithms certified to FIPS 140-2 level 1. This jar contains the debug version JCE provider and low-level API for the BC-FJA version 1.0.2.3, FIPS Certificate #3514. Please note the debug jar is not certified.

There is a newer version: 2.0.0

Show newest version

package org.bouncycastle.crypto;

/**
 * Interface for factories producing encryptor/decryptor objects supporting AEAD modes.
 *
 * @param  the type for the parameters for the operator made by this factory.
 */
public interface AEADOperatorFactory
{
    /**
     * Create an object for encrypting output and handling AAD data.
     *
     * @param key the key to use to set up the encryptor.
     * @param parameters any additional parameters required to set up the encryptor.
     *
     * @return an AEAD encryptor which can be used wrap an output stream.
     */
    public OutputAEADEncryptor createOutputAEADEncryptor(SymmetricKey key, T parameters);

    /**
     * Create an object for decrypting output and handling AAD data.
     *
     * @param key the key to use to set up the decryptor.
     * @param parameters any additional parameters required to set up the decryptor.
     *
     * @return an AEAD decryptor which can be used wrap an output stream.
     */
    public OutputAEADDecryptor createOutputAEADDecryptor(SymmetricKey key, T parameters);

    /**
     * Create an object for decrypting input and handling AAD data.
     *
     * @param key the key to use to set up the decryptor.
     * @param parameters any additional parameters required to set up the decryptor.
     *
     * @return an AEAD decryptor which can be used wrap an input stream.
     */
    public InputAEADDecryptor createInputAEADDecryptor(SymmetricKey key, T parameters);
}