Package io.helidon.security.jwt

Class Jwt

java.lang.Object

io.helidon.security.jwt.Jwt

public class Jwt
extends java.lang.Object

JWT token.

Representation of a JSON web token (a generic one).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Jwt.Builder	Builder of a Jwt.
static class	Jwt.ExpirationValidator	Validator of expiration claim.
static class	Jwt.FieldValidator	Validator of a string field obtained from a JWT.
static class	Jwt.IssueTimeValidator	Validator of issue time claim.
static class	Jwt.NotBeforeValidator	Validator of not before claim.

Constructor Summary

Constructors

Constructor	Description
Jwt(javax.json.JsonObject headerJson, javax.json.JsonObject payloadJson)	Create a token based on json.

Method Summary

Modifier and Type	Method	Description
static void	addAudienceValidator(java.util.Collection<Validator<Jwt>> validators, java.lang.String audience, boolean mandatory)	Add validator of audience to the collection of validators.
static void	addIssuerValidator(java.util.Collection<Validator<Jwt>> validators, java.lang.String issuer, boolean mandatory)	Add validator of issuer to the collection of validators.
static Jwt.Builder	builder()	Get a builder to create a JWT.
static java.util.List<Validator<Jwt>>	defaultTimeValidators()	Return a list of validators to validate expiration time, issue time and not-before time.
static java.util.List<Validator<Jwt>>	defaultTimeValidators(java.time.Instant now, int timeSkewAmount, java.time.temporal.ChronoUnit timeSkewUnit, boolean mandatory)	Return a list of validators to validate expiration time, issue time and not-before time.
java.util.Optional<JwtUtil.Address>	getAddress()
java.util.Optional<java.lang.String>	getAlgorithm()
java.util.Optional<byte[]>	getAtHash()
java.util.Optional<java.util.List<java.lang.String>>	getAudience()
java.util.Optional<java.time.LocalDate>	getBirthday()
java.util.Optional<byte[]>	getCHash()
java.util.Optional<java.lang.String>	getContentType()
java.util.Optional<java.lang.String>	getEmail()
java.util.Optional<java.lang.Boolean>	getEmailVerified()
java.util.Optional<java.time.Instant>	getExpirationTime()
java.util.Optional<java.lang.String>	getFamilyName()
java.util.Optional<java.lang.String>	getFullName()
java.util.Optional<java.lang.String>	getGender()
java.util.Optional<java.lang.String>	getGivenName()
java.util.Optional<javax.json.JsonValue>	getHeaderClaim(java.lang.String claim)	Get a claim by its name from header.
javax.json.JsonObject	getHeaderJson()	Create a JSON header object.
java.util.Optional<java.lang.String>	getIssuer()
java.util.Optional<java.time.Instant>	getIssueTime()
java.util.Optional<java.lang.String>	getJwtId()
java.util.Optional<java.lang.String>	getKeyId()
java.util.Optional<java.util.Locale>	getLocale()
java.util.Optional<java.lang.String>	getMiddleName()
java.util.Optional<java.lang.String>	getNickname()
java.util.Optional<java.lang.String>	getNonce()
java.util.Optional<java.time.Instant>	getNotBefore()
java.util.Optional<javax.json.JsonValue>	getPayloadClaim(java.lang.String claim)	Get a claim by its name from payload.
java.util.Map<java.lang.String,javax.json.JsonValue>	getPayloadClaims()
javax.json.JsonObject	getPayloadJson()	Create a JSON payload object.
java.util.Optional<java.lang.String>	getPhoneNumber()
java.util.Optional<java.lang.Boolean>	getPhoneNumberVerified()
java.util.Optional<java.net.URI>	getPicture()
java.util.Optional<java.lang.String>	getPreferredUsername()
java.util.Optional<java.net.URI>	getProfile()
java.util.Optional<java.util.List<java.lang.String>>	getScopes()
java.util.Optional<java.lang.String>	getSubject()
java.util.Optional<java.time.ZoneId>	getTimeZone()
java.util.Optional<java.lang.String>	getType()
java.util.Optional<java.time.Instant>	getUpdatedAt()
java.util.Optional<java.net.URI>	getWebsite()
io.helidon.common.Errors	validate(java.lang.String issuer, java.lang.String audience)	Validates all default values.
io.helidon.common.Errors	validate(java.util.List<Validator<Jwt>> validators)	Validate this JWT against provided validators.

Methods inherited from class java.lang.Object

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

Constructor Detail

Jwt

public Jwt(javax.json.JsonObject headerJson,
           javax.json.JsonObject payloadJson)

Create a token based on json.

Parameters:

headerJson - headers

payloadJson - payload

Method Detail

defaultTimeValidators

public static java.util.List<Validator<Jwt>> defaultTimeValidators()

Return a list of validators to validate expiration time, issue time and not-before time. By default the time skew allowed is 5 seconds and all fields are optional.

Returns:

list of validators

defaultTimeValidators

public static java.util.List<Validator<Jwt>> defaultTimeValidators(java.time.Instant now,
                                                                   int timeSkewAmount,
                                                                   java.time.temporal.ChronoUnit timeSkewUnit,
                                                                   boolean mandatory)

Return a list of validators to validate expiration time, issue time and not-before time.

Parameters:

now - Time that acts as the "now" instant (this allows us to validate if a token was valid at an instant in the past

timeSkewAmount - time skew allowed when validating (amount - such as 5)

timeSkewUnit - time skew allowed when validating (unit - such as ChronoUnit.SECONDS)

mandatory - whether the field is mandatory. True for mandatory, false for optional (for all default time validators)

Returns:

list of validators

addIssuerValidator

public static void addIssuerValidator(java.util.Collection<Validator<Jwt>> validators,
                                      java.lang.String issuer,
                                      boolean mandatory)

Add validator of issuer to the collection of validators.

Parameters:

validators - collection of validators

issuer - issuer expected to be in the token

mandatory - whether issuer field is mandatory in the token (true - mandatory, false - optional)

addAudienceValidator

public static void addAudienceValidator(java.util.Collection<Validator<Jwt>> validators,
                                        java.lang.String audience,
                                        boolean mandatory)

Add validator of audience to the collection of validators.

Parameters:

validators - collection of validators

audience - audience expected to be in the token

mandatory - whether the audience field is mandatory in the token

builder

public static Jwt.Builder builder()

Get a builder to create a JWT.

Returns:

new builder

getScopes

public java.util.Optional<java.util.List<java.lang.String>> getScopes()

getHeaderClaim

public java.util.Optional<javax.json.JsonValue> getHeaderClaim(java.lang.String claim)

Get a claim by its name from header.

Parameters:

claim - name of a claim

Returns:

claim value if present

getPayloadClaim

public java.util.Optional<javax.json.JsonValue> getPayloadClaim(java.lang.String claim)

Get a claim by its name from payload.

Parameters:

claim - name of a claim

Returns:

claim value if present

getPayloadClaims

public java.util.Map<java.lang.String,javax.json.JsonValue> getPayloadClaims()

getAlgorithm

public java.util.Optional<java.lang.String> getAlgorithm()

getKeyId

public java.util.Optional<java.lang.String> getKeyId()

getType

public java.util.Optional<java.lang.String> getType()

getContentType

public java.util.Optional<java.lang.String> getContentType()

getIssuer

public java.util.Optional<java.lang.String> getIssuer()

getExpirationTime

public java.util.Optional<java.time.Instant> getExpirationTime()

getIssueTime

public java.util.Optional<java.time.Instant> getIssueTime()

getNotBefore

public java.util.Optional<java.time.Instant> getNotBefore()

getSubject

public java.util.Optional<java.lang.String> getSubject()

getAudience

public java.util.Optional<java.util.List<java.lang.String>> getAudience()

getJwtId

public java.util.Optional<java.lang.String> getJwtId()

getEmail

public java.util.Optional<java.lang.String> getEmail()

getEmailVerified

public java.util.Optional<java.lang.Boolean> getEmailVerified()

getFullName

public java.util.Optional<java.lang.String> getFullName()

getGivenName

public java.util.Optional<java.lang.String> getGivenName()

getMiddleName

public java.util.Optional<java.lang.String> getMiddleName()

getFamilyName

public java.util.Optional<java.lang.String> getFamilyName()

getLocale

public java.util.Optional<java.util.Locale> getLocale()

getNickname

public java.util.Optional<java.lang.String> getNickname()

getPreferredUsername

public java.util.Optional<java.lang.String> getPreferredUsername()

getProfile

public java.util.Optional<java.net.URI> getProfile()

getPicture

public java.util.Optional<java.net.URI> getPicture()

getWebsite

public java.util.Optional<java.net.URI> getWebsite()

getGender

public java.util.Optional<java.lang.String> getGender()

getBirthday

public java.util.Optional<java.time.LocalDate> getBirthday()

getTimeZone

public java.util.Optional<java.time.ZoneId> getTimeZone()

getPhoneNumber

public java.util.Optional<java.lang.String> getPhoneNumber()

getPhoneNumberVerified

public java.util.Optional<java.lang.Boolean> getPhoneNumberVerified()

getUpdatedAt

public java.util.Optional<java.time.Instant> getUpdatedAt()

getAddress

public java.util.Optional<JwtUtil.Address> getAddress()

getAtHash

public java.util.Optional<byte[]> getAtHash()

getCHash

public java.util.Optional<byte[]> getCHash()

getNonce

public java.util.Optional<java.lang.String> getNonce()

getHeaderJson

public javax.json.JsonObject getHeaderJson()

Create a JSON header object.

Returns:

JsonObject for header

getPayloadJson

public javax.json.JsonObject getPayloadJson()

Create a JSON payload object.

Returns:

JsonObject for payload

validate

public io.helidon.common.Errors validate(java.util.List<Validator<Jwt>> validators)

Validate this JWT against provided validators.

Parameters:

validators - Validators to validate with. Obtain them through (e.g.) defaultTimeValidators() , addAudienceValidator(Collection, String, boolean) , addIssuerValidator(Collection, String, boolean)

Returns:

errors instance to check if valid and access error messages

validate

public io.helidon.common.Errors validate(java.lang.String issuer,
                                         java.lang.String audience)

Validates all default values. Values validated:

• Expiration time if defined
• Issue time if defined
• Not before time if defined
• getIssuer() Issuer} if defined
• Audience if defined

Parameters:

issuer - validates that this JWT was issued by this issuer. Setting this to non-null value will make issuer claim mandatory

audience - validates that this JWT was issued for this audience. Setting this to non-null value will make audience claim mandatory

Returns:

errors instance to check for validation result