org.spongycastle.tls.crypto.TlsAgreement Maven / Gradle / Ivy

Go to download

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

Spongy Castle is a package-rename (org.bouncycastle.* to org.spongycastle.*) of Bouncy Castle intended for the Android platform. Android unfortunately ships with a stripped-down version of Bouncy Castle, which prevents easy upgrades - Spongy Castle overcomes this and provides a full, up-to-date version of the Bouncy Castle cryptographic libs.

The newest version!

package org.spongycastle.tls.crypto;

import java.io.IOException;

/**
 * Base interface for ephemeral key agreement calculator.
 */
public interface TlsAgreement
{
    /**
     * Generate an ephemeral key pair, returning the encoding of the public key.
     *
     * @return a byte encoding of the public key.
     * @throws IOException in case of error.
     */
    byte[] generateEphemeral() throws IOException;

    /**
     * Pass in the public key for the peer to the agreement calculator.
     *
     * @param peerValue a byte encoding of the peer public key.
     * @throws IOException in case of error.
     */
    void receivePeerValue(byte[] peerValue) throws IOException;

    /**
     * Calculate the agreed secret based on the calculator's current state.
     * @return the calculated secret.
     * @throws IOException in case of error.
     */
    TlsSecret calculateSecret() throws IOException;
}