org.jsqrl.service

Interface SqrlUserService<T extends SqrlUser>

public interface SqrlUserService<T extends SqrlUser>

A required service for retrieving users that can authenticate with SQRL. Have your service which manages user data implement this interface and implement the required functionality.

Created by Brent Nichols

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	disableSqrlUser(java.lang.String identityKey) The function that will disable the user
java.lang.Boolean	enableSqrlUser(java.lang.String identityKey) The function that will re-enable the user
T	getUserBySqrlKey(java.lang.String identityKey) Querys for the user by their public key
T	registerSqrlUser(java.lang.String identityKey, java.lang.String serverUnlockKey, java.lang.String verifyUnlockKey) Registers the user
java.lang.Boolean	removeSqrlUser(java.lang.String identityKey) The function that will remove the user
java.lang.Boolean	updateIdentityKey(java.lang.String previousIdentityKey, java.lang.String identityKey) If the client was identified by a previous identity, update that old identity with the new on they are carrying

Method Detail

getUserBySqrlKey

T getUserBySqrlKey(java.lang.String identityKey)

Querys for the user by their public key

Parameters:

identityKey - The user's public key

Returns:

Returns an object representing the user

updateIdentityKey

java.lang.Boolean updateIdentityKey(java.lang.String previousIdentityKey,
                                    java.lang.String identityKey)

If the client was identified by a previous identity, update that old identity with the new on they are carrying

Parameters:

previousIdentityKey - The old identity key to be replaced

identityKey - The user's updated identity key

Returns:

Returns true if the update was successful

registerSqrlUser

T registerSqrlUser(java.lang.String identityKey,
                   java.lang.String serverUnlockKey,
                   java.lang.String verifyUnlockKey)

Registers the user

Parameters:

identityKey - The user's public key

serverUnlockKey - The user's server unlock key

verifyUnlockKey - The user's verify unlock key

Returns:

Returns an object to represent the user

disableSqrlUser

java.lang.Boolean disableSqrlUser(java.lang.String identityKey)

The function that will disable the user

Parameters:

identityKey - The user's public key

Returns:

Returns true if the disable was successful, otherwise false

enableSqrlUser

java.lang.Boolean enableSqrlUser(java.lang.String identityKey)

The function that will re-enable the user

Parameters:

identityKey - The user's public key

Returns:

Returns true if the enable was successful, otherwise false

removeSqrlUser

java.lang.Boolean removeSqrlUser(java.lang.String identityKey)

The function that will remove the user

Parameters:

identityKey - The user's public key

Returns:

Returns true if the disable was successful, otherwise false