Package uk.co.spudsoft.jwtvalidatorvertx.impl

Class IssuerAcceptabilityHandlerImpl

java.lang.Object

uk.co.spudsoft.jwtvalidatorvertx.impl.IssuerAcceptabilityHandlerImpl

All Implemented Interfaces:

IssuerAcceptabilityHandler

public class IssuerAcceptabilityHandlerImpl
extends Object
implements IssuerAcceptabilityHandler

The standard IssuerAcceptabilityHandler. Provides two approaches, which can be used in isolation or together:

1. A list of acceptable issuers can be provided in a file. The file can be changed whilst the system is up, but the path to the file is fixed. It is recommended that the file be updated atomically (e.g. by changing a soft link).
2. A list of regular expressions can be provided. Each regular expression will be checked, one at a time.

The use of a file is generally more secure, but there are some situations in which a small number of regular expressions can be useful. Each line in the file is trimmed before adding to an internal Set, so leading and trailing whitespace is removed (and the line ending of the file is irrelevant). It is strongly recommended that each line of the file be an https URL.

Author:

yaytay

Constructor Summary

Constructors

Constructor	Description
IssuerAcceptabilityHandlerImpl(List<String> acceptableIssuerRegexes, String acceptableIssuersFile, Duration pollPeriod)	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	isAcceptable(String issuer)	Confirm that the issuer matches at least one of the configured acceptable issuer regular expressions or is found in the acceptableIssuersFile.
void	validate()	Validate the configuration.

Methods inherited from class java.lang.Object

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

Constructor Details

IssuerAcceptabilityHandlerImpl

public IssuerAcceptabilityHandlerImpl(List<String> acceptableIssuerRegexes,
 String acceptableIssuersFile,
 Duration pollPeriod)

Constructor.

Parameters:

acceptableIssuerRegexes - The List of regular expressions (as Strings) that are acceptable.

acceptableIssuersFile - The path to a file that contains valid issuers, one per line.

pollPeriod - The time period between file checks (the check just looks at the last modified time, so make this about a minute).

Method Details

validate

public void validate()
              throws IllegalArgumentException

Description copied from interface: IssuerAcceptabilityHandler

Validate the configuration.

Specified by:

validate in interface IssuerAcceptabilityHandler

Throws:

IllegalArgumentException - if the configuration is not usable, or is not configured with usable values.

isAcceptable

public boolean isAcceptable(String issuer)

Description copied from interface: IssuerAcceptabilityHandler

Confirm that the issuer matches at least one of the configured acceptable issuer regular expressions or is found in the acceptableIssuersFile.

Specified by:

isAcceptable in interface IssuerAcceptabilityHandler

Parameters:

issuer - the issuer to confirm.

Returns:

true if the issuer is acceptable.