org.bouncycastle.tls.crypto.impl.TlsAEADCipherImpl Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of bctls-jdk14 Show documentation

The Bouncy Castle Java APIs for TLS and DTLS.

There is a newer version: 1.78.1

package org.bouncycastle.tls.crypto.impl;

import java.io.IOException;

/**
 * Base interface for services supporting AEAD encryption/decryption.
 */
public interface TlsAEADCipherImpl
{
    /**
     * Set the key to be used by the AEAD cipher implementation supporting this service.
     *
     * @param key array holding the AEAD cipher key.
     * @param keyOff offset into the array the key starts at.
     * @param keyLen length of the key in the array.
     */
    void setKey(byte[] key, int keyOff, int keyLen) throws IOException;

    /**
     * Initialise the parameters for the AEAD operator.
     *
     * @param nonce the nonce.
     * @param macSize MAC size in bytes.
     * @param additionalData any additional data to be included in the MAC calculation.
     * @throws IOException if the parameters are inappropriate.
     */
    void init(byte[] nonce, int macSize, byte[] additionalData) throws IOException;

    /**
     * Return the maximum size of the output for input of inputLength bytes.
     *
     * @param inputLength the length (in bytes) of the proposed input.
     * @return the maximum size of the output.
     */
    int getOutputSize(int inputLength);

    /**
     * Perform the cipher encryption/decryption returning the output in output.
     * 
     * Note: we have to use doFinal() here as it is the only way to guarantee output from the underlying cipher.
     * 
     * @param input array holding input data to the cipher.
     * @param inputOffset offset into input array data starts at.
     * @param inputLength length of the input data in the array.
     * @param output array to hold the cipher output.
     * @param outputOffset offset into output array to start saving output.
     * @return the amount of data written to output.
     * @throws IOException in case of failure.
     */
    int doFinal(byte[] input, int inputOffset, int inputLength, byte[] output, int outputOffset)
        throws IOException;
}