com.github.dbadia.sqrl.server.backchannel

Enum SqrlClientOpt

java.lang.Object

java.lang.Enum<SqrlClientOpt>

com.github.dbadia.sqrl.server.backchannel.SqrlClientOpt

All Implemented Interfaces:

Serializable, Comparable<SqrlClientOpt>

public enum SqrlClientOpt
extends Enum<SqrlClientOpt>

Valid values for the opt parameter

Author:

Dave Badia

Enum Constant Summary

Enum Constants

Enum Constant and Description
cps “cps” is the abbreviation for Client Provided Session.
hardlock When present, this option requests the web server to set a flag on this user's account to disable any alternative “out of band” change to this user's SQRL identity, such as traditional and weak “what as your favorite pet's name” non-SQRL identity authentication.
sqrlonly When present, this option requests the web server to set a flag on this user's account to disable any alternative non-SQRL authentication capability, such as weaker traditional username and password authentication.
suk “suk” is the abbreviation for Server Unlock Key.

Method Summary

Modifier and Type	Method and Description
boolean	isNonQueryOnly()
static SqrlClientOpt	valueOf(String name) Returns the enum constant of this type with the specified name.
static SqrlClientOpt[]	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

suk

public static final SqrlClientOpt suk

“suk” is the abbreviation for Server Unlock Key. The presence of this flag instructs the SQRL server to return the stored server unlock key (SUK) associated with whichever identity matches the identity supplied by the SQRL client. The SQRL specification requires the SQRL server to automatically return the account's matching SUK whenever it is able to anticipate that the client is likely to require it, such as when the server contains a previous identity key, or when the account is disabled. However, there are instances where the client may know that it is going to need the stored SUK from the server, such as when it wishes to remove a non-disabled account. The client could first disable the account to induce the server to return the SUK, but it's simpler for the client to request the SUK from the server whenever it wants it. It's also conceivable that future extensions of this specification will incorporate other instances where the server's stored SUK is required for RescueCode based authentication. from https://www.grc.com/sqrl/semantics.htm

sqrlonly

public static final SqrlClientOpt sqrlonly

When present, this option requests the web server to set a flag on this user's account to disable any alternative non-SQRL authentication capability, such as weaker traditional username and password authentication. Users who have become confident of their use of SQRL may ask their client to include this optional request. The web server should only assume this intention if the option is present in any successful non-query transaction. Its absence from any successful non-query transaction should immediately reset the flag and the prohibition in the web server. The web server may, at its option, notice when any change has occurred and explicitly ask the user to affirm their changed intention. from https://www.grc.com/sqrl/semantics.htm

hardlock

public static final SqrlClientOpt hardlock

When present, this option requests the web server to set a flag on this user's account to disable any alternative “out of band” change to this user's SQRL identity, such as traditional and weak “what as your favorite pet's name” non-SQRL identity authentication. Users who have become confident of their use of SQRL may ask their client to include this optional request. The web server should only assume this intention if the option is present in any successful non-query transaction. Its absence from any successful non-query transaction should immediately reset the flag and the prohibition in the web server. The web server may, at its option, notice when any change has occurred and explicitly ask the user to affirm their changed intention. from https://www.grc.com/sqrl/semantics.htm

cps

public static final SqrlClientOpt cps

“cps” is the abbreviation for Client Provided Session. The presence of this flag alters the system's final authentication action. In the traditional case when this flag is NOT present, the web server arranges to refresh the web browser's page or redirect the web browser to an authenticated (typically, logged-on) page. However, for increased security the “cps” option may be specified by a SQRL client to request the server to abandon its pending authentication with the user's browser and instead provide the web URL to the client for subsequent handling. The client then might present its user with a URL link to click, or it might arrange its own private communications channel to the users web browser so that the user will be taken to the identity-authenticated web page. This higher security mode has the advantage of completely defeating any known man-in-the-middle attack where an attacking third-party might have inserted themselves into the loop. This cuts that party out of the loop, preventing them from obtaining the user's authentication. The server provides the authenticated page URL in its “url={url}” response parameter for the final non-query command. from https://www.grc.com/sqrl/semantics.htm

Method Detail

values

public static SqrlClientOpt[] 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 (SqrlClientOpt c : SqrlClientOpt.values())
    System.out.println(c);

Returns:

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

valueOf

public static SqrlClientOpt 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

isNonQueryOnly

public boolean isNonQueryOnly()