com.nimbusds.srp6.ClientEvidenceRoutine Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of srp6a Show documentation

Complete Secure Remote Password (SRP-6a) implementation for Java.

There is a newer version: 2.1.0

package com.nimbusds.srp6;


import java.math.BigInteger;


/**
 * Custom routine interface for computing the client evidence message 'M1'.
 *
 * If you don't want to employ the default 
 * {@link SRP6Routines#computeClientEvidence routine} for computing the client 
 * evidence message you can use this interface to define your own. Remember to 
 * make sure that exactly the same routine is used by both client and server
 * session, else authentication will fail.
 *
 * @author Vladimir Dzhuvinov
 */
public interface ClientEvidenceRoutine {


	/**
	 * Computes a client evidence message 'M1'.
	 *
	 * @param cryptoParams The crypto parameters for the SRP-6a protocol.
	 * @param ctx          Snapshot of the SRP-6a client session variables 
	 *                     which may be used in the computation of the 
	 *                     client evidence message.
	 *
	 * @return The resulting client evidence message 'M1'.
	 */
	public BigInteger computeClientEvidence(final SRP6CryptoParams cryptoParams,
	                                        final SRP6ClientEvidenceContext ctx);

}