org.bouncycastle.tls.TlsCredentialedAgreement Maven / Gradle / Ivy

Go to download

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

The Bouncy Castle Java APIs for the TLS, including a JSSE provider. 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 and used appropriately.

There is a newer version: 2.0.19

Show newest version

package org.bouncycastle.tls;

import java.io.IOException;

import org.bouncycastle.tls.crypto.TlsCertificate;
import org.bouncycastle.tls.crypto.TlsSecret;

/**
 * Support interface for generating a secret based on the credentials sent by a TLS peer.
 */
public interface TlsCredentialedAgreement
    extends TlsCredentials
{
    /**
     * Calculate an agreed secret based on our credentials and the public key credentials of our peer.
     *
     * @param peerCertificate public key certificate of our TLS peer.
     * @return the agreed secret.
     * @throws IOException in case of an exception on generation of the secret.
     */
    TlsSecret generateAgreement(TlsCertificate peerCertificate) throws IOException;
}