org.jsqrl.server

Class JSqrlServer

java.lang.Object

org.jsqrl.server.JSqrlServer

public class JSqrlServer
extends java.lang.Object

The main service class that follows the SQRL protocol to processes a client SQRL request. Created by Brent Nichols

Constructor Summary

Constructors

Constructor and Description
JSqrlServer(SqrlUserService userService, SqrlAuthenticationService sqrlAuthenticationService, SqrlConfig config, SqrlNutService nutService)

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	checkAuthenticationStatus(java.lang.String nut, java.lang.String ipAddress) This method should be used to check the authentication status of a nut.
java.lang.String	createAuthenticationRequest(java.lang.String ipAddress, java.lang.Boolean qr) This method should be the method called when a user is requesting a nut.
SqrlAuthResponse	handleClientRequest(SqrlClientRequest request, java.lang.String nut, java.lang.String ipAddress)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JSqrlServer

public JSqrlServer(SqrlUserService userService,
                   SqrlAuthenticationService sqrlAuthenticationService,
                   SqrlConfig config,
                   SqrlNutService nutService)

Method Detail

createAuthenticationRequest

public java.lang.String createAuthenticationRequest(java.lang.String ipAddress,
                                                    java.lang.Boolean qr)

This method should be the method called when a user is requesting a nut. This creates the nut that signifies the authentication request, which should get marked as authenticated when the user uses a SQRL client to authenticate.

Parameters:

ipAddress - The requesting IP Address

qr - If the user used the QR code or not

Returns:

Returns the nut to be provided to the user

checkAuthenticationStatus

public java.lang.Boolean checkAuthenticationStatus(java.lang.String nut,
                                                   java.lang.String ipAddress)

This method should be used to check the authentication status of a nut. This should be a nut created by the createAuthenticationRequest method that was marked as authenticated by using a SQRL client.

Parameters:

nut - The nut provided by the user

ipAddress - The requesting IP Address

Returns:

Returns true if the nut was marked as authenticated

handleClientRequest

public SqrlAuthResponse handleClientRequest(SqrlClientRequest request,
                                            java.lang.String nut,
                                            java.lang.String ipAddress)