org.bouncycastle.operator.OutputEncryptor Maven / Gradle / Ivy

Go to download

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

The Bouncy Castle Java APIs for CMS, PKCS, EAC, TSP, CMP, CRMF, OCSP, and certificate generation. The APIs are designed primarily to be used in conjunction with the BC FIPS provider. The APIs may also be used with other providers although if being used in a FIPS context it is the responsibility of the user to ensure that any other providers used are FIPS certified.

There is a newer version: 2.0.7

Show newest version

package org.bouncycastle.operator;

import java.io.OutputStream;

import org.bouncycastle.asn1.x509.AlgorithmIdentifier;

/**
 * General interface for an operator that is able to produce
 * an OutputStream that will output encrypted data.
 */
public interface OutputEncryptor
{
    /**
     * Return the algorithm identifier describing the encryption
     * algorithm and parameters this encryptor uses.
     *
     * @return algorithm oid and parameters.
     */
    AlgorithmIdentifier getAlgorithmIdentifier();

    /**
     * Wrap the passed in output stream encOut, returning an output stream
     * that encrypts anything passed in before sending on to encOut.
     *
     * @param encOut output stream for encrypted output.
     * @return an encrypting OutputStream
     */
    OutputStream getOutputStream(OutputStream encOut);

    /**
     * Return the key used for encrypting the output.
     *
     * @return the encryption key.
     */
    GenericKey getKey();
}