SqrlTif (SQRL Server Base Library 0.9.2 API)

java.lang.Object
- com.github.dbadia.sqrl.server.backchannel.SqrlTif

```
public class SqrlTif
extends Object
```
Valid values for the SQRL tif indicator, see https://www.grc.com/sqrl/semantics.htm

Author:

Dave Badia

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SqrlTif.TifBuilder

Nested Classes
Modifier and Type	Class and Description
`static class`	`SqrlTif.TifBuilder`

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`TIF_BAD_ID_ASSOCIATION` Bad ID Association: This bit is set by the server when a SQRL identity which may be associated with the query nut does not match the SQRL ID used to submit the query.
`static int`	`TIF_CLIENT_FAILURE` Client failure: This bit is set by the server when some aspect of the client's submitted query ‑ other than expired but otherwise valid transaction state information ‑ was incorrect and prevented the server from understanding and/or completing the requested action.
`static int`	`TIF_COMMAND_FAILED` Command failed: When set, this bit indicates that the web server has encountered a problem successfully processing the client's query.
`static int`	`TIF_CURRENT_ID_MATCH` (Current) ID match: When set, this bit indicates that the web server has found an identity association for the user based upon the default (current) identity credentials supplied by the client: the IDentity Key (idk) and the IDentity Signature (ids).
`static int`	`TIF_DEPRECATED_INVALID_LINK_ORIGIN` Deprecated. per SQRL spec: NO LONGER DEFINED - DO NOT USE
`static int`	`TIF_DEPRECATED_SUPRESS_SFN_ORIGIN` Deprecated. per SQRL spec: NO LONGER DEFINED - DO NOT USE
`static int`	`TIF_FUNCTIONS_NOT_SUPPORTED` Function(s) not supported: This bit indicates that the client requested one or more SQRL functions (through command verbs) that the server does not currently support.
`static int`	`TIF_IPS_MATCHED` IPs matched: When set, this bit indicates that the IP address of the entity which requested the initial logon web page containing the SQRL link URL (and probably encoded into the SQRL link URL's “nut”) is the same IP address from which the SQRL client's query was received for this reply.
`static int`	`TIF_PREVIOUS_ID_MATCH` Previous ID match: When set, this bit indicates that the web server has found an identity association for the user based upon the previous identity credentials supplied by the client in the previous IDentity Key (pidk) and the previous IDentity Signature (pids).
`static int`	`TIF_SQRL_DISABLED` SQRL disabled: When set, this bit indicates that SQRL authentication for this identity has previously been disabled.
`static int`	`TIF_TRANSIENT_ERROR` Transient error: The server replies with this bit set to indicate that the client's signature(s) are correct, but something about the client's query prevented the command from completing.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method and Description

protected int toHexInt()

protected int toInt()

String toString()
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected int`	`toHexInt()`
`protected int`	`toInt()`
`String`	`toString()`

- Field Detail
  - TIF_CURRENT_ID_MATCH
```
public static final int TIF_CURRENT_ID_MATCH
```
    (Current) ID match: When set, this bit indicates that the web server has found an identity association for the user based upon the default (current) identity credentials supplied by the client: the IDentity Key (idk) and the IDentity Signature (ids).
    
    See Also:
    
    Constant Field Values
  - TIF_PREVIOUS_ID_MATCH
```
public static final int TIF_PREVIOUS_ID_MATCH
```
    Previous ID match: When set, this bit indicates that the web server has found an identity association for the user based upon the previous identity credentials supplied by the client in the previous IDentity Key (pidk) and the previous IDentity Signature (pids). Note: When neither of the ID match bits are set, none of the identity credentials supplied by the client are known to the web server.
    
    See Also:
    
    Constant Field Values
  - TIF_IPS_MATCHED
```
public static final int TIF_IPS_MATCHED
```
    IPs matched: When set, this bit indicates that the IP address of the entity which requested the initial logon web page containing the SQRL link URL (and probably encoded into the SQRL link URL's “nut”) is the same IP address from which the SQRL client's query was received for this reply. Note that the server must retain the IP embedded in, or associated with, the original SQRL URL, not any subsequent query, and compare the current query IP against that original IP.
    
    See Also:
    
    Constant Field Values
  - TIF_SQRL_DISABLED
```
public static final int TIF_SQRL_DISABLED
```
    SQRL disabled: When set, this bit indicates that SQRL authentication for this identity has previously been disabled. While this bit is set, the “ident” command and any attempt at authentication will fail. This bit can only be reset, and the identity re-enabled for authentication, by the client issuing an “enable” command signed by the unlock request signature (urs) for the identity known to the server. Since this signature requires the presence of the identity's RescueCode, only SQRL's strongest identity authentication is permitted to re-enable a disabled identity.
    
    See Also:
    
    Constant Field Values
  - TIF_FUNCTIONS_NOT_SUPPORTED
```
public static final int TIF_FUNCTIONS_NOT_SUPPORTED
```
    Function(s) not supported: This bit indicates that the client requested one or more SQRL functions (through command verbs) that the server does not currently support. The client will likely need to advise its user that whatever they were trying to do is not possible at the target website. The SQRL server will fail this query, thus also setting the “40h” Command Failed bit.
    
    See Also:
    
    Constant Field Values
  - TIF_TRANSIENT_ERROR
```
public static final int TIF_TRANSIENT_ERROR
```
    Transient error: The server replies with this bit set to indicate that the client's signature(s) are correct, but something about the client's query prevented the command from completing. This is the server's way of instructing the client to retry and reissue the immediately previous command using the fresh ‘nut=’ crypto material and ‘qry=’ url the server will have also just returned in its reply. Although we don't want to overly restrict the specification of this error, the trouble is almost certainly static, expired, or previously used nut= or qry= data. Thus, reissuing the previous command under the newly supplied server parameters would be expected to succeed. The “0x40” “Command failed” bit (shown next) will also be set since the client's command will not have been processed.
    
    See Also:
    
    Constant Field Values
  - TIF_COMMAND_FAILED
```
public static final int TIF_COMMAND_FAILED
```
    Command failed: When set, this bit indicates that the web server has encountered a problem successfully processing the client's query. In any such case, no change will be made to the user's account status. All SQRL server-side actions are atomic. This means that either everything succeeds or nothing is changed. This is important since clients can request multiple updates and changes at once. If this bit is set without the 80h bit set (see below) the trouble was not with the client's provided data, protocol, etc. but with some other aspect of completing the client's request. With the exception of the following “Client failure” status bit, the SQRL semantics do not attempt to enumerate every conceivable web server failure reason. The web server is free to use its “ask” feature to explain the problem to the client's user.
    
    See Also:
    
    Constant Field Values
  - TIF_CLIENT_FAILURE
```
public static final int TIF_CLIENT_FAILURE
```
    Client failure: This bit is set by the server when some aspect of the client's submitted query ‑ other than expired but otherwise valid transaction state information ‑ was incorrect and prevented the server from understanding and/or completing the requested action. This could be the result of a communications error, a mistake in the client's SQRL protocol, a signature that doesn't verify, or required signatures for the requested actions which are not present. And more specifically, this is NOT an error that the server knows would likely be fixed by having the client silently reissue it previous command using updated entropy . . . although that might still be the first recourse for the client. Since any such client failure will also result in a failure of the command, the 40h bit will also be set.
    
    See Also:
    
    Constant Field Values
  - TIF_BAD_ID_ASSOCIATION
```
public static final int TIF_BAD_ID_ASSOCIATION
```
    Bad ID Association: This bit is set by the server when a SQRL identity which may be associated with the query nut does not match the SQRL ID used to submit the query. If the server is maintaining session state, such as a logged on session, it may generate SQRL query nuts associated with that logged-on session's SQRL identity. If it then receives a SQRL query using that nut, but issued with a different SQRL identity, it should fail the command (setting both the 0x40 and 0x80 bits) and also return this 0x100 error bit so that the client may inform its user that the wrong SQRL identity was used with a nut that was already associated with a different identity.
    
    See Also:
    
    Constant Field Values
  - TIF_DEPRECATED_INVALID_LINK_ORIGIN
```
@Deprecated
public static final int TIF_DEPRECATED_INVALID_LINK_ORIGIN
```
    Deprecated. per SQRL spec: NO LONGER DEFINED - DO NOT USE
    
    DEPRECATED NO LONGER DEFINED - DO NOT USE
    
    See Also:
    
    Constant Field Values
  - TIF_DEPRECATED_SUPRESS_SFN_ORIGIN
```
@Deprecated
public static final int TIF_DEPRECATED_SUPRESS_SFN_ORIGIN
```
    Deprecated. per SQRL spec: NO LONGER DEFINED - DO NOT USE
    
    DEPRECATED NO LONGER DEFINED - DO NOT USE
    
    See Also:
    
    Constant Field Values
- Method Detail
  - toInt
```
protected int toInt()
```
  - toHexInt
```
protected int toHexInt()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class SqrlTif

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TIF_CURRENT_ID_MATCH

TIF_PREVIOUS_ID_MATCH

TIF_IPS_MATCHED

TIF_SQRL_DISABLED

TIF_FUNCTIONS_NOT_SUPPORTED

TIF_TRANSIENT_ERROR

TIF_COMMAND_FAILED

TIF_CLIENT_FAILURE

TIF_BAD_ID_ASSOCIATION

TIF_DEPRECATED_INVALID_LINK_ORIGIN

TIF_DEPRECATED_SUPRESS_SFN_ORIGIN

Method Detail

toInt

toHexInt

toString