Skip navigation links
A B C D E F G H J L N O R S T U V 

A

addAsk(String, String, String) - Method in class org.jsqrl.model.SqrlAuthResponse
 
addTifs(TransactionInformationFlag...) - Method in class org.jsqrl.model.SqrlAuthResponse.SqrlAuthResponseBuilder
 
authenticateNut(String, String) - Method in interface org.jsqrl.service.SqrlAuthenticationService
Authenticates the user

B

base64UrlDecode(String) - Static method in class org.jsqrl.util.SqrlUtil
 
base64UrlDecode(byte[]) - Static method in class org.jsqrl.util.SqrlUtil
 

C

checkAuthenticationStatus(String, String) - Method in class org.jsqrl.server.JSqrlServer
This method should be used to check the authentication status of a nut.
checkIpMatch(SqrlNut) - Method in class org.jsqrl.nut.SqrlNut
This method is used to check if the requesting IP address matches the provided nut.
checkIpMatch(byte[]) - Method in class org.jsqrl.nut.SqrlNut
This method is used to check if a requesting IP address matches this nut.
createAuthenticationRequest(String, Boolean) - Method in class org.jsqrl.server.JSqrlServer
This method should be the method called when a user is requesting a nut.
createAuthenticationRequest(String, String) - Method in interface org.jsqrl.service.SqrlAuthenticationService
This will create an authentication request for the user's original nut token.
createNut(String, boolean) - Method in class org.jsqrl.service.SqrlNutService
Create a new nut for the provided associated IP Address.
createNutFromString(String) - Method in class org.jsqrl.service.SqrlNutService
 

D

disableSqrlUser(String) - Method in interface org.jsqrl.service.SqrlUserService
The function that will disable the user

E

enableSqrlUser(String) - Method in interface org.jsqrl.service.SqrlUserService
The function that will re-enable the user

F

from(String) - Static method in enum org.jsqrl.model.SqrlCommand
 
from(String) - Static method in enum org.jsqrl.model.SqrlOptionFlag
 

G

getAuthenticatedSqrlIdentityKey(String, String) - Method in interface org.jsqrl.service.SqrlAuthenticationService
This is used to retrieve the user by the nut they have in their authentication request, but only after it has been authenticated.
getButton() - Method in class org.jsqrl.model.SqrlClientRequest
 
getClientParameter(String) - Method in class org.jsqrl.model.SqrlClientRequest
 
getCommand() - Method in class org.jsqrl.model.SqrlClientRequest
 
getDecodedClientData() - Method in class org.jsqrl.model.SqrlClientRequest
 
getDecodedIdentitySignature() - Method in class org.jsqrl.model.SqrlClientRequest
 
getDecodedPreviousIdSignature() - Method in class org.jsqrl.model.SqrlClientRequest
 
getDecodedServerData() - Method in class org.jsqrl.model.SqrlClientRequest
 
getDecodedUnlockRequestSignature() - Method in class org.jsqrl.model.SqrlClientRequest
 
getIdentityKey() - Method in class org.jsqrl.model.SqrlClientRequest
 
getIdentityKey() - Method in interface org.jsqrl.model.SqrlUser
Method that will return the user's identity key (idk)
getNutString(SqrlNut) - Method in class org.jsqrl.service.SqrlNutService
Create the AES encrypted and Base64 URL encoded nut string
getPreviousIdentityKey() - Method in class org.jsqrl.model.SqrlClientRequest
 
getRequestVersion() - Method in class org.jsqrl.model.SqrlClientRequest
 
getServerUnlockKey() - Method in class org.jsqrl.model.SqrlClientRequest
 
getServerUnlockKey() - Method in interface org.jsqrl.model.SqrlUser
Method that returns the user's server unlock key (suk)
getUserBySqrlKey(String) - Method in interface org.jsqrl.service.SqrlUserService
Querys for the user by their public key
getVerifyUnlockKey() - Method in class org.jsqrl.model.SqrlClientRequest
 
getVerifyUnlockKey() - Method in interface org.jsqrl.model.SqrlUser
Method that returns the user's verify unlock key (vuk)

H

handleClientRequest(SqrlClientRequest, String, String) - Method in class org.jsqrl.server.JSqrlServer
 

J

JSqrlServer - Class in org.jsqrl.server
The main service class that follows the SQRL protocol to processes a client SQRL request.
JSqrlServer(SqrlUserService, SqrlAuthenticationService, SqrlConfig, SqrlNutService) - Constructor for class org.jsqrl.server.JSqrlServer
 

L

linkNut(String, String) - Method in interface org.jsqrl.service.SqrlAuthenticationService
Links one nut with another.

N

nutBelongsToIp(String, String) - Method in class org.jsqrl.service.SqrlNutService
This method will tell you if the provided nut string actually belongs to the IP Address that is making the request.

O

org.jsqrl.config - package org.jsqrl.config
 
org.jsqrl.error - package org.jsqrl.error
 
org.jsqrl.model - package org.jsqrl.model
 
org.jsqrl.nut - package org.jsqrl.nut
 
org.jsqrl.server - package org.jsqrl.server
 
org.jsqrl.service - package org.jsqrl.service
 
org.jsqrl.util - package org.jsqrl.util
 

R

registerSqrlUser(String, String, String) - Method in interface org.jsqrl.service.SqrlUserService
Registers the user
removeSqrlUser(String) - Method in interface org.jsqrl.service.SqrlUserService
The function that will remove the user

S

setClient(String) - Method in class org.jsqrl.model.SqrlClientRequest
 
SqrlAuthenticationService - Interface in org.jsqrl.service
A required service implementation to interact with server authentication data.
SqrlAuthResponse - Class in org.jsqrl.model
The standard server response.
SqrlAuthResponse() - Constructor for class org.jsqrl.model.SqrlAuthResponse
 
SqrlAuthResponse.SqrlAuthResponseBuilder - Class in org.jsqrl.model
 
SqrlAuthResponseBuilder() - Constructor for class org.jsqrl.model.SqrlAuthResponse.SqrlAuthResponseBuilder
 
SqrlClientRequest - Class in org.jsqrl.model
An object representing a SQRL Client Request.
SqrlClientRequest() - Constructor for class org.jsqrl.model.SqrlClientRequest
 
SqrlCommand - Enum in org.jsqrl.model
The known SQRL Commands Created by Brent Nichols
SqrlConfig - Class in org.jsqrl.config
This is the configuration bean class.
SqrlConfig() - Constructor for class org.jsqrl.config.SqrlConfig
 
sqrlEnabled() - Method in interface org.jsqrl.model.SqrlUser
Method to determine if SQRL authentication is enabled for the user
SqrlException - Exception in org.jsqrl.error
The base SQRL Exception class.
SqrlException(String) - Constructor for exception org.jsqrl.error.SqrlException
 
SqrlException(String, Throwable) - Constructor for exception org.jsqrl.error.SqrlException
 
SqrlNut - Class in org.jsqrl.nut
The object representation of a SQRL nut.
SqrlNut(byte[], int, int, boolean) - Constructor for class org.jsqrl.nut.SqrlNut
 
SqrlNut(int, int, boolean) - Constructor for class org.jsqrl.nut.SqrlNut
 
SqrlNut(byte[]) - Constructor for class org.jsqrl.nut.SqrlNut
Recreate a SQRL Nut from a byte array
SqrlNutService - Class in org.jsqrl.service
The service for creating SQRL Nut Objects.
SqrlNutService(Random, SqrlConfig, MessageDigest, Key) - Constructor for class org.jsqrl.service.SqrlNutService
 
SqrlOptionFlag - Enum in org.jsqrl.model
Enumerations for the various SQRL Options (opt) flags that can be set
SqrlUser - Interface in org.jsqrl.model
The interface for a user that can be authenticated with SQRL.
SqrlUserService<T extends SqrlUser> - Interface in org.jsqrl.service
A required service for retrieving users that can authenticate with SQRL.
SqrlUtil - Class in org.jsqrl.util
A utility class to handle various SQRL functionality.
stripEndEquals(String) - Static method in class org.jsqrl.util.SqrlUtil
Strips the end equals characters from a base64 encoded string

T

toByteArray() - Method in class org.jsqrl.nut.SqrlNut
 
toEncodedString() - Method in class org.jsqrl.model.SqrlAuthResponse
 
toString() - Method in class org.jsqrl.model.SqrlAuthResponse
 
TransactionInformationFlag - Enum in org.jsqrl.model
Enumeration for the SQRL Transaction Information Flags (tif) Created by Brent Nichols

U

unpaddedBase64UrlEncoded(String) - Static method in class org.jsqrl.util.SqrlUtil
 
unpaddedBase64UrlEncoded(byte[]) - Static method in class org.jsqrl.util.SqrlUtil
 
updateIdentityKey(String, String) - Method in interface org.jsqrl.service.SqrlUserService
If the client was identified by a previous identity, update that old identity with the new on they are carrying

V

valueOf(String) - Static method in enum org.jsqrl.model.SqrlCommand
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.jsqrl.model.SqrlOptionFlag
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.jsqrl.model.TransactionInformationFlag
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.jsqrl.model.SqrlCommand
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.jsqrl.model.SqrlOptionFlag
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.jsqrl.model.TransactionInformationFlag
Returns an array containing the constants of this enum type, in the order they are declared.
A B C D E F G H J L N O R S T U V 
Skip navigation links