org.bouncycastle.tls.TlsSRPIdentityManager 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;

/**
 * Base interface for an object that can return login parameters from an SRP identity.
 */
public interface TlsSRPIdentityManager
{
    /**
     * Lookup the {@link TlsSRPLoginParameters} corresponding to the specified identity.
     * 
     * NOTE: To avoid "identity probing", unknown identities SHOULD be handled as recommended in RFC
     * 5054 2.5.1.3. {@link SimulatedTlsSRPIdentityManager} is provided for this purpose.
     * 
     * @param identity
     *            the SRP identity sent by the connecting client
     * @return the {@link TlsSRPLoginParameters} for the specified identity, or else 'simulated'
     *         parameters if the identity is not recognized. A null value is also allowed, but not
     *         recommended.
     */
    TlsSRPLoginParameters getLoginParameters(byte[] identity);
}