org.jsqrl.service

Interface SqrlAuthenticationService

public interface SqrlAuthenticationService

A required service implementation to interact with server authentication data. Have your service that handles authentication requests implement this interface.

Created by Brent Nichols

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	authenticateNut(java.lang.String nut, java.lang.String identityKey) Authenticates the user
java.lang.Boolean	createAuthenticationRequest(java.lang.String originalNut, java.lang.String ipAddress) This will create an authentication request for the user's original nut token.
java.lang.String	getAuthenticatedSqrlIdentityKey(java.lang.String nut, java.lang.String ipAddress) This is used to retrieve the user by the nut they have in their authentication request, but only after it has been authenticated.
java.lang.Boolean	linkNut(java.lang.String oldNut, java.lang.String newNut) Links one nut with another.

Method Detail

createAuthenticationRequest

java.lang.Boolean createAuthenticationRequest(java.lang.String originalNut,
                                              java.lang.String ipAddress)

This will create an authentication request for the user's original nut token. It will get updated to authenticated when the server receives and verifies an IDENT command.

Parameters:

originalNut - The original nut token the user received

ipAddress - The new nut that will be passed back to the SQRL client.

Returns:

Returns true if the authentication request was created

linkNut

java.lang.Boolean linkNut(java.lang.String oldNut,
                          java.lang.String newNut)

Links one nut with another. If the original nut is the user's nut that they are trying to authenticate with, then the initial link should be created. If it is not then the link between that original nut should be updated from the oldNut to the newNut.

Parameters:

oldNut - The "old" nut that was provided by the client. Will be discarded unless it's the original authenticating nut.

newNut - The new nut that's generated by the server.

Returns:

Return true if the link was successfully created or updated

authenticateNut

java.lang.Boolean authenticateNut(java.lang.String nut,
                                  java.lang.String identityKey)

Authenticates the user

Parameters:

nut - The linked nut token being used to authenticate the user

identityKey - The user's public key

Returns:

Returns an object to represent the user

getAuthenticatedSqrlIdentityKey

java.lang.String getAuthenticatedSqrlIdentityKey(java.lang.String nut,
                                                 java.lang.String ipAddress)

This is used to retrieve the user by the nut they have in their authentication request, but only after it has been authenticated.

Parameters:

nut - The nut that was initially provided to the user

ipAddress - The IP Address that the user is attempting to authenticate from

Returns:

Returns the user's SQRL public key