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

import java.security.SecureRandom;

/**
 * Interface describing an encapsulated secret generator, such as for RSA KTS.
 *
 * @param  the type for the parameters used by this generator.
 */
public interface EncapsulatingSecretGenerator
    extends OperatorUsingSecureRandom>
{
    /**
     * Return the parameters being used by this extractor.
     *
     * @return the extractor parameters.
     */
    T getParameters();

    /**
     * Generate an encapsulated secret, returning the encapsulation of the key material,
     * and the key material, or secret, as well.
     *
     * @return details for a new encapsulated secret.
     * @throws PlainInputProcessingException if an exception occurs on encapsulation.
     */
    SecretWithEncapsulation generate() throws PlainInputProcessingException;

    /**
     * Return a new generator which will use the passed in SecureRandom for generating the
     * key material, or secret, to be encapsulated.
     *
     * @param random the SecureRandom to use.
     * @return a generator using the passed in random as its source of key material.
     */
    EncapsulatingSecretGenerator withSecureRandom(SecureRandom random);
}