com.github.dbadia.sqrl.server.util

Class SqrlUtil

java.lang.Object

com.github.dbadia.sqrl.server.util.SqrlUtil

public class SqrlUtil
extends Object

Various utility methods used by the rest of the SQRL code, including base64URL

Author:

Dave Badia

Method Summary

Modifier and Type	Method and Description
static byte[]	base64UrlDecode(String toDecodeParam) Performs the SQRL required base64URL decoding
static String	base64UrlDecodeToString(String toDecode) Performs the SQRL required base64URL decoding
static String	base64UrlDecodeToStringOrErrorMessage(String toDecode)
static String	buildLogMessageForSqrlClientRequest(javax.servlet.http.HttpServletRequest request)
static String	buildRequestParamList(javax.servlet.http.HttpServletRequest servletRequest) Internal use only.
static String	computeCookieDomain(javax.servlet.http.HttpServletRequest request, SqrlConfig config)
static String	computeSfnFromUrl(javax.servlet.http.HttpServletRequest request) Internal use only.
static String	cookiesToString(javax.servlet.http.Cookie[] cookieArray)
static javax.servlet.http.Cookie	createOrUpdateCookie(javax.servlet.http.HttpServletRequest request, String cookieDomain, String name, String value, int maxAgeInSeconds, SqrlConfig config)
static void	deleteCookies(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, SqrlConfig sqrlConfig, String... cookiesToDelete)
static String	findCookieValue(javax.servlet.http.HttpServletRequest request, String toFind)
static InetAddress	ipStringToInetAddresss(String ipAddressString) Internal use only.
static boolean	isBlank(String string) Provides the functionality of Apache commons StringUtils.isBlank() without bringing in the dependency
static boolean	isNotBlank(String string) Provides the functionality of Apache commons StringUtils.isNotBlank() without bringing in the dependency
static String	logEnterServlet(javax.servlet.http.HttpServletRequest request)
static String	parameterMapToString(Map<String,String[]> parameterMap)
static String	sqrlBase64UrlEncode(byte[] bytes) Performs the SQRL required base64URL encoding
static String	sqrlBase64UrlEncode(String toEncode) Performs the SQRL required base64URL encoding
static boolean	verifyED25519(byte[] signatureFromMessage, byte[] messageBytes, byte[] publicKeyBytes) Internal use only.

Methods inherited from class java.lang.Object

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

Method Detail

sqrlBase64UrlEncode

public static String sqrlBase64UrlEncode(byte[] bytes)

Performs the SQRL required base64URL encoding

Parameters:

bytes - the data to be encoded

Returns:

the encoded string

sqrlBase64UrlEncode

public static String sqrlBase64UrlEncode(String toEncode)

Performs the SQRL required base64URL encoding

Parameters:

toEncode - the string to be encoded

Returns:

the encoded string

base64UrlDecode

public static byte[] base64UrlDecode(String toDecodeParam)
                              throws SqrlException

Performs the SQRL required base64URL decoding

Parameters:

toDecodeParam - the data to be decoded

Returns:

the decoded byte array

Throws:

SqrlException - if an error occurs

base64UrlDecodeToString

public static String base64UrlDecodeToString(String toDecode)
                                      throws SqrlException

Performs the SQRL required base64URL decoding

Parameters:

toDecodeParam - the data to be decoded

Returns:

the decoded data as a string using the UTF-8 character set

Throws:

SqrlException - if UTF8 is not supported

base64UrlDecodeToStringOrErrorMessage

public static String base64UrlDecodeToStringOrErrorMessage(String toDecode)

verifyED25519

public static boolean verifyED25519(byte[] signatureFromMessage,
                                    byte[] messageBytes,
                                    byte[] publicKeyBytes)
                             throws SqrlException

Internal use only. Verifies the ED25519 signature

Parameters:

signatureFromMessage - the signature data

messageBytes - the message that was signed

publicKeyBytes - the public key to be used for verification

Returns:

true if verification was successful

Throws:

SqrlException - if an error occurs during ED25519 operations

isBlank

public static boolean isBlank(String string)

Provides the functionality of Apache commons StringUtils.isBlank() without bringing in the dependency

Parameters:

string - the string to check

Returns:

true if blank, false otherwise

isNotBlank

public static boolean isNotBlank(String string)

Provides the functionality of Apache commons StringUtils.isNotBlank() without bringing in the dependency

Parameters:

string - the string to check

Returns:

true if not blank, false otherwise

ipStringToInetAddresss

public static InetAddress ipStringToInetAddresss(String ipAddressString)
                                          throws SqrlException

Internal use only.

Parameters:

ipAddressString - the ip address to parse

Returns:

the IP address

Throws:

SqrlException - if an UnknownHostException occurs

computeSfnFromUrl

public static String computeSfnFromUrl(javax.servlet.http.HttpServletRequest request)

Internal use only. Computes the SQRL server friendly name (SFN) from the servers URl. Typically used if a SFN is not specified in the config

Parameters:

request -

Returns:

buildRequestParamList

public static String buildRequestParamList(javax.servlet.http.HttpServletRequest servletRequest)

Internal use only. Builds a string of name value pairs from the request

Parameters:

servletRequest - the request

Returns:

a string of the name value pairs that were in the request

createOrUpdateCookie

public static javax.servlet.http.Cookie createOrUpdateCookie(javax.servlet.http.HttpServletRequest request,
                                                             String cookieDomain,
                                                             String name,
                                                             String value,
                                                             int maxAgeInSeconds,
                                                             SqrlConfig config)

findCookieValue

public static String findCookieValue(javax.servlet.http.HttpServletRequest request,
                                     String toFind)

deleteCookies

public static void deleteCookies(javax.servlet.http.HttpServletRequest request,
                                 javax.servlet.http.HttpServletResponse response,
                                 SqrlConfig sqrlConfig,
                                 String... cookiesToDelete)

cookiesToString

public static final String cookiesToString(javax.servlet.http.Cookie[] cookieArray)

computeCookieDomain

public static String computeCookieDomain(javax.servlet.http.HttpServletRequest request,
                                         SqrlConfig config)

logEnterServlet

public static String logEnterServlet(javax.servlet.http.HttpServletRequest request)

parameterMapToString

public static String parameterMapToString(Map<String,String[]> parameterMap)

buildLogMessageForSqrlClientRequest

public static String buildLogMessageForSqrlClientRequest(javax.servlet.http.HttpServletRequest request)