com.atlassian.asap.core.validator

Class ValidatedKeyId

java.lang.Object

com.atlassian.asap.core.validator.ValidatedKeyId

public final class ValidatedKeyId
extends Object

Represents a validated key id of the JWT Header. A validated key id is safe to be used in the path component of a url without causing path traversal.

Field Summary

Fields

Modifier and Type	Field and Description
static Pattern	PATH_PATTERN Subset of the valid characters for URI Paths derived from RFC3986.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getKeyId()
int	hashCode()
String	toString()
static ValidatedKeyId	validate(String unvalidatedKeyId) Validates the given key id and upon successful validation returns a ValidatedKeyId instance.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

PATH_PATTERN

public static final Pattern PATH_PATTERN

Subset of the valid characters for URI Paths derived from RFC3986. The subset has been chosen to minimise security risks, including variable expansion, query parameters injection and unexpected string terminators.

Method Detail

validate

public static ValidatedKeyId validate(String unvalidatedKeyId)
                               throws InvalidHeaderException

Validates the given key id and upon successful validation returns a ValidatedKeyId instance.

Parameters:

unvalidatedKeyId - a key identifier for public or private key

Returns:

a validated key id instance if the given key id passes the validation

Throws:

InvalidHeaderException - if the key id is invalid or unsafe to use

getKeyId

public String getKeyId()

Returns:

a validated key id that is safe to be used in the path component of a url without causing path traversal

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object