org.jsqrl.service

Class SqrlNutService

java.lang.Object

org.jsqrl.service.SqrlNutService

public class SqrlNutService
extends java.lang.Object

The service for creating SQRL Nut Objects. It requires you to provide a random number generator, your SQRL configuration object, a hashing method, and your server's private key.

Created by Brent Nichols

Constructor Summary

Constructors

Constructor and Description
SqrlNutService(java.util.Random rng, SqrlConfig config, java.security.MessageDigest hasher, java.security.Key serverEncryptionKey)

Method Summary

Modifier and Type	Method and Description
SqrlNut	createNut(java.lang.String ipAddress, boolean qr) Create a new nut for the provided associated IP Address.
SqrlNut	createNutFromString(java.lang.String encryptedAndEncodedNut)
java.lang.String	getNutString(SqrlNut sqrlNut) Create the AES encrypted and Base64 URL encoded nut string
java.lang.Boolean	nutBelongsToIp(java.lang.String nutString, java.lang.String ipAddress) This method will tell you if the provided nut string actually belongs to the IP Address that is making the request.

Methods inherited from class java.lang.Object

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

Constructor Detail

SqrlNutService

public SqrlNutService(java.util.Random rng,
                      SqrlConfig config,
                      java.security.MessageDigest hasher,
                      java.security.Key serverEncryptionKey)

Method Detail

createNut

public SqrlNut createNut(java.lang.String ipAddress,
                         boolean qr)

Create a new nut for the provided associated IP Address. IP Address can be IPv4 or IPv6, we will only be using its hash for verification.

Parameters:

ipAddress - The IP Address to be associated with the nut

Returns:

The AES encrypted and Base64 encoded string representation of the nut

nutBelongsToIp

public java.lang.Boolean nutBelongsToIp(java.lang.String nutString,
                                        java.lang.String ipAddress)

This method will tell you if the provided nut string actually belongs to the IP Address that is making the request. This can be used to check the validity of a nut before even attempting to check the data store

Parameters:

nutString - The nut string the user is providing

ipAddress - The IP Address they are authenticating from

Returns:

Returns true if the nut belongs to the provided IP Address

getNutString

public java.lang.String getNutString(SqrlNut sqrlNut)

Create the AES encrypted and Base64 URL encoded nut string

Parameters:

sqrlNut - The SQRL Nut to encrypt and encode

Returns:

The AES encrypted and Base64 encoded string representation of the nut

createNutFromString

public SqrlNut createNutFromString(java.lang.String encryptedAndEncodedNut)