com.github.dbadia.sqrl.server

Class SqrlConfig

java.lang.Object

com.github.dbadia.sqrl.server.SqrlConfig

public class SqrlConfig
extends Object

Bean which stores our server-side SQRL configuration settings.

Requiredfields to be set are:

• aesKeyBytes -
• backchannelServletPath

Recommended fields to be set are: All other fields are optional with sensible defaults

Author:

Dave Badia

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SqrlConfig.ImageFormat

Constructor Summary

Constructors

Constructor and Description
SqrlConfig()

Method Summary

Modifier and Type	Method and Description
byte[]	getAESKeyBytes()
long	getAuthSyncCheckInMillis()
String	getBackchannelServletPath()
int	getCleanupTaskExecInMinutes()
String	getClientAuthStateUpdaterClass()
String	getCookieDomain()
String	getCookiePath()
String	getCorrelatorCookieName()
long	getCurrentTimeMs()
String	getFirstNutCookieName()
String[]	getIpForwardedForHeaders()
long	getNutValidityInMillis()
int	getNutValidityInSeconds()
SqrlConfig.ImageFormat	getQrCodeFileType()
SecureRandom	getSecureRandom()
String	getServerFriendlyName()
String	getSqrlPersistenceFactoryClass()
void	setAESKeyBytes(byte[] aesKeyBytes)
void	setAuthSyncCheckInMillis(long authSyncCheckInMillis)
void	setBackchannelServletPath(String backchannelServletPath) Required: sets the URL to the servlet endpoint which will handle SQRL client requests, can be either a full URL, a full URI, or a partial URI.
void	setCleanupTaskExecInMinutes(int cleanupTaskExecInMinutes)
void	setClientAuthStateUpdaterClass(String clientAuthStateUpdaterClass)
void	setCookieDomain(String cookieDomain)
void	setCookiePath(String cookiePath)
void	setCorrelatorCookieName(String correlatorCookieName)
void	setFirstNutCookieName(String firstNutCookieName)
void	setIpForwardedForHeaders(String[] ipForwardedForHeaders)
void	setNutValidityInSeconds(int nutValidityInSeconds) Set the length of time (in seconds) that the nut will be valid for
void	setQrCodeFileType(SqrlConfig.ImageFormat qrCodeFileType)
void	setSecureRandom(SecureRandom secureRandom)
void	setServerFriendlyName(String serverFriendlyName)
void	setSqrlPersistenceFactoryClass(String sqrlPersistenceFactoryClass)

Methods inherited from class java.lang.Object

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

Constructor Detail

SqrlConfig

public SqrlConfig()

Method Detail

getIpForwardedForHeaders

public String[] getIpForwardedForHeaders()

setIpForwardedForHeaders

public void setIpForwardedForHeaders(String[] ipForwardedForHeaders)

getNutValidityInSeconds

public int getNutValidityInSeconds()

getNutValidityInMillis

public long getNutValidityInMillis()

setNutValidityInSeconds

public void setNutValidityInSeconds(int nutValidityInSeconds)

Set the length of time (in seconds) that the nut will be valid for

Parameters:

nutValidityInSeconds -

Throws:

IllegalArgumentException - if nutValidityInSeconds is less than 0

getQrCodeFileType

public SqrlConfig.ImageFormat getQrCodeFileType()

setQrCodeFileType

public void setQrCodeFileType(SqrlConfig.ImageFormat qrCodeFileType)

getSecureRandom

public SecureRandom getSecureRandom()

setSecureRandom

public void setSecureRandom(SecureRandom secureRandom)

setAESKeyBytes

public void setAESKeyBytes(byte[] aesKeyBytes)

getAESKeyBytes

public byte[] getAESKeyBytes()

getBackchannelServletPath

public String getBackchannelServletPath()

setBackchannelServletPath

public void setBackchannelServletPath(String backchannelServletPath)

Required: sets the URL to the servlet endpoint which will handle SQRL client requests, can be either a full URL, a full URI, or a partial URI.

Setting	Login URL	Computed BC url
https://sqrljava.tech/sqrlexample/sqrlbc	https://sqrljava.tech/sqrlexample/login	https://sqrljava.tech/sqrlexample/sqrlbc
/sqrl/sqrlbc	https://sqrljava.tech/myapp/login	https://sqrljava.tech/sqrl/sqrlbc
sqrlbc	https://sqrljava.tech/sqrlexample/login	https://sqrljava.tech/sqrlexample/sqrlbc

Parameters:

backchannelServletPath - the servlet endpoint which will handle SQRL client requests. Can be a full URL, a full URI, or a partial URI

getServerFriendlyName

public String getServerFriendlyName()

setServerFriendlyName

public void setServerFriendlyName(String serverFriendlyName)

getCurrentTimeMs

public long getCurrentTimeMs()

getSqrlPersistenceFactoryClass

public String getSqrlPersistenceFactoryClass()

getCorrelatorCookieName

public String getCorrelatorCookieName()

getFirstNutCookieName

public String getFirstNutCookieName()

setFirstNutCookieName

public void setFirstNutCookieName(String firstNutCookieName)

setSqrlPersistenceFactoryClass

public void setSqrlPersistenceFactoryClass(String sqrlPersistenceFactoryClass)

setCorrelatorCookieName

public void setCorrelatorCookieName(String correlatorCookieName)

getCleanupTaskExecInMinutes

public int getCleanupTaskExecInMinutes()

setCleanupTaskExecInMinutes

public void setCleanupTaskExecInMinutes(int cleanupTaskExecInMinutes)

getClientAuthStateUpdaterClass

public String getClientAuthStateUpdaterClass()

setClientAuthStateUpdaterClass

public void setClientAuthStateUpdaterClass(String clientAuthStateUpdaterClass)

getCookieDomain

public String getCookieDomain()

setCookieDomain

public void setCookieDomain(String cookieDomain)

getCookiePath

public String getCookiePath()

setCookiePath

public void setCookiePath(String cookiePath)

getAuthSyncCheckInMillis

public long getAuthSyncCheckInMillis()

setAuthSyncCheckInMillis

public void setAuthSyncCheckInMillis(long authSyncCheckInMillis)