org.jsqrl.nut

Class SqrlNut

java.lang.Object

org.jsqrl.nut.SqrlNut

public class SqrlNut
extends java.lang.Object

The object representation of a SQRL nut. Methods are provided to return the 128-bit representation, and to recreate a SqrlNut object from a 128-bit representation.

Created by Brent Nichols

Constructor Summary

Constructors

Constructor and Description
SqrlNut(byte[] bytes) Recreate a SQRL Nut from a byte array
SqrlNut(byte[] hashedIp, int count, int random, boolean qr)
SqrlNut(int count, int random, boolean qr)

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	checkIpMatch(byte[] otherHashedIp) This method is used to check if a requesting IP address matches this nut.
java.lang.Boolean	checkIpMatch(SqrlNut otherNut) This method is used to check if the requesting IP address matches the provided nut.
byte[]	toByteArray()

Methods inherited from class java.lang.Object

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

Constructor Detail

SqrlNut

public SqrlNut(byte[] hashedIp,
               int count,
               int random,
               boolean qr)

SqrlNut

public SqrlNut(int count,
               int random,
               boolean qr)

SqrlNut

public SqrlNut(byte[] bytes)

Recreate a SQRL Nut from a byte array

Parameters:

bytes - The 128-bit recreated representation of the nut

Method Detail

toByteArray

public byte[] toByteArray()

Returns:

Returns the 16 byte (128 bit) nut

checkIpMatch

public java.lang.Boolean checkIpMatch(SqrlNut otherNut)

This method is used to check if the requesting IP address matches the provided nut. Since it's the least significant part of the IP hash that's saved, we will compare the hashed values byte for byte.

Parameters:

otherNut - The nut to compare IP addresses with

Returns:

Returns true if the IP's match, false otherwise

checkIpMatch

public java.lang.Boolean checkIpMatch(byte[] otherHashedIp)

This method is used to check if a requesting IP address matches this nut. Since it's the least significant part of the IP hash that's saved, we will compare the hashed values byte for byte.

Parameters:

otherHashedIp - The nut to compare IP addresses with

Returns:

Returns true if the IP's match, false otherwise