com.nimbusds.srp6

Enum SRP6ClientSession.State

java.lang.Object

java.lang.Enum<SRP6ClientSession.State>

com.nimbusds.srp6.SRP6ClientSession.State

All Implemented Interfaces:

Serializable, Comparable<SRP6ClientSession.State>

Enclosing class:

SRP6ClientSession

public static enum SRP6ClientSession.State
extends Enum<SRP6ClientSession.State>

Enumerates the states of a client-side SRP-6a authentication session.

Enum Constant Summary

Enum Constants

Enum Constant and Description
INIT The session is initialised and ready to begin authentication by proceeding to STEP_1.
STEP_1 The authenticating user has input their identity 'I' (username) and password 'P'.
STEP_2 The user identity 'I' is submitted to the server which has replied with the matching salt 's' and its public value 'B' based on the user's password verifier 'v'.
STEP_3 The client public key 'A' and evidence message 'M1' are submitted and the server has replied with own evidence message 'M2'.

Method Summary

Modifier and Type	Method and Description
static SRP6ClientSession.State	valueOf(String name) Returns the enum constant of this type with the specified name.
static SRP6ClientSession.State[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INIT

public static final SRP6ClientSession.State INIT

The session is initialised and ready to begin authentication by proceeding to STEP_1.

STEP_1

public static final SRP6ClientSession.State STEP_1

The authenticating user has input their identity 'I' (username) and password 'P'. The session is ready to proceed to STEP_2.

STEP_2

public static final SRP6ClientSession.State STEP_2

The user identity 'I' is submitted to the server which has replied with the matching salt 's' and its public value 'B' based on the user's password verifier 'v'. The session is ready to proceed to STEP_3.

STEP_3

public static final SRP6ClientSession.State STEP_3

The client public key 'A' and evidence message 'M1' are submitted and the server has replied with own evidence message 'M2'. The session is finished (authentication was successful or failed).

Method Detail

values

public static SRP6ClientSession.State[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SRP6ClientSession.State c : SRP6ClientSession.State.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SRP6ClientSession.State valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null