org.bouncycastle.crypto.OutputSigner 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;

/**
 * Base interface for an output signer.
 *
 * @param  the parameters type for the signer.
 */
public interface OutputSigner
{
    /**
     * Return the parameters for this output signer.
     *
     * @return the signer's parameters.
     */
    T getParameters();

    /**
     * Returns a stream that will accept data for the purpose of calculating
     * a signature. Use org.bouncycastle.util.io.TeeOutputStream if you want to accumulate
     * the data on the fly as well.
     *
     * @return an UpdateOutputStream
     */
    UpdateOutputStream getSigningStream();

    /**
     * Return the signature calculated on what has been written to the calculator's output stream.
     *
     * @return a signature.
     * @throws PlainInputProcessingException if the input provided cannot be processed.
     */
    byte[] getSignature()
        throws PlainInputProcessingException;

    /**
     * Output the signature  value for what has been written to the signer's output stream.
     *
     * @param output output array to write the signature to.
     * @param off offset to start writing the signature at.
     * @return the number of bytes output.
     * @throws PlainInputProcessingException if the input provided cannot be processed.
     */
    int getSignature(byte[] output, int off)
        throws PlainInputProcessingException;
}