org.bouncycastle.operator.AADProcessor 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;

/**
 * Base interface for extra methods required for handling associated data in AEAD ciphers.
 */
public interface AADProcessor
{
    /**
     * Return a stream to write associated data to in order to have it incorporated into the
     * AEAD cipher's MAC.
     *
     * @return a stream for collecting associated data.
     */
    OutputStream getAADStream();

    /**
     * Return the final value of AEAD cipher's MAC.
     *
     * @return MAC value for the AEAD cipher.
     */
    byte[] getMAC();
}