io.vertx.ext.auth.impl.jose

Class JWT

java.lang.Object

io.vertx.ext.auth.impl.jose.JWT

public final class JWT
extends Object

JWT and JWS implementation draft-ietf-oauth-json-web-token-32.

Author:

Paulo Lopes

Constructor Summary

Constructors

Constructor and Description
JWT()

Method Summary

Modifier and Type	Method and Description
JWT	addJWK(JWK jwk) Adds a JSON Web Key (rfc7517) to the crypto map.
JWT	allowEmbeddedKey(boolean allowEmbeddedKey) Enable/Disable support for embedded keys.
Collection<String>	availableAlgorithms()
JsonObject	decode(String token)
JsonObject	decode(String token, boolean full)
boolean	isScopeGranted(JsonObject jwt, JWTOptions options) Scope claim are used to grant access to a specific resource.
boolean	isUnsecure()
JWT	nonceAlgorithm(String alg)
static JsonObject	parse(byte[] token)
static JsonObject	parse(String token)
String	sign(JsonObject payload, JWTOptions options)

Methods inherited from class java.lang.Object

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

Constructor Detail

JWT

public JWT()

Method Detail

addJWK

public JWT addJWK(JWK jwk)

Adds a JSON Web Key (rfc7517) to the crypto map.

Parameters:

jwk - a JSON Web Key

Returns:

self

allowEmbeddedKey

public JWT allowEmbeddedKey(boolean allowEmbeddedKey)

Enable/Disable support for embedded keys. Default false. By default this is disabled as it could be used as an attack vector to the application. A malicious user could generate a self signed certificate and embed the public certificate on the token, which would always pass the validation. Users of this feature should regardless of the validation status, ensure that the chain is valid by adding a well known root certificate (that has been previously agreed with the server).

Parameters:

allowEmbeddedKey - when true embedded keys are used to check the signature.

Returns:

fluent self.

nonceAlgorithm

public JWT nonceAlgorithm(String alg)

parse

public static JsonObject parse(byte[] token)

parse

public static JsonObject parse(String token)

decode

public JsonObject decode(String token)

decode

public JsonObject decode(String token,
                         boolean full)

isScopeGranted

public boolean isScopeGranted(JsonObject jwt,
                              JWTOptions options)

Scope claim are used to grant access to a specific resource. They are included into the JWT when the user consent access to the resource, or sometimes without user consent (bypass approval).

Parameters:

jwt - JsonObject decoded json web token value.

options - JWTOptions coming from the provider.

Returns:

true if required scopes are into the JWT.

sign

public String sign(JsonObject payload,
                   JWTOptions options)

isUnsecure

public boolean isUnsecure()

availableAlgorithms

public Collection<String> availableAlgorithms()