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

Go to download

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

The FIPS 140-3 Bouncy Castle Crypto package is a Java implementation of cryptographic algorithms certified to FIPS 140-3 level 1. This jar contains JCE provider and low-level API for the BC-FJA version 2.0.0, FIPS Certificate #4743. Please see certificate for certified platform details.

There is a newer version: 2.0.0

Show newest version

package org.bouncycastle.crypto;

/**
 * Interface describing an operator factory that creates operators for doing
 * encryption and decryption using symmetric ciphers.
 *
 * @param  the parameters type for the operators the factory creates.
 */
public interface SymmetricOperatorFactory
{
    /**
     * Return an encryptor that operates on an output stream.
     *
     * @param key the key to initialize the encryptor with.
     * @param parameter the parameters to use to initialize the encryptor.
     * @return an OutputEncryptor
     */
    OutputEncryptor createOutputEncryptor(SymmetricKey key, T parameter);

    /**
     * Return a decryptor that operates on an output stream.
     *
     * @param key the key to initialize the encryptor with.
     * @param parameter the parameters to use to initialize the encryptor.
     * @return an OutputDecryptor.
     */
    OutputDecryptor createOutputDecryptor(SymmetricKey key, T parameter);

    /**
     * Return a decryptor that operates on an input stream.
     *
     * @param key the key to initialize the encryptor with.
     * @param parameter the parameters to use to initialize the encryptor.
     * @return an InputDecryptor.
     */
    InputDecryptor createInputDecryptor(SymmetricKey key, T parameter);
}