org.forgerock.authz.modules.oauth2

Class RestOAuth2AccessTokenValidator

java.lang.Object

org.forgerock.authz.modules.oauth2.RestOAuth2AccessTokenValidator

All Implemented Interfaces:

OAuth2AccessTokenValidator

public class RestOAuth2AccessTokenValidator
extends Object
implements OAuth2AccessTokenValidator

Access Token Validator for validating OAuth2 tokens issued by an OAuth2 Provider using REST requests.
This validator requires the configuration given at construction to contain the following entries:

• token-info-endpoint - the URI of OAuth2 Provider's tokeninfo endpoint (not including the access_token query parameter
• user-info-endpoint - the URI of OAuth2 Provider's userinfo endpoint

Since:

1.4.0

Constructor Summary

Constructors

Constructor and Description
RestOAuth2AccessTokenValidator(JsonValue config, Client httpClient) Creates a new instance of the RestOAuth2AccessTokenValidator.

Method Summary

Modifier and Type	Method and Description
protected Set<String>	getScope(JsonValue tokenInfo) Gets the scopes for the access token.
Promise<AccessTokenValidationResponse,OAuth2Exception>	validate(String accessToken) Validates whether the given access token is valid, by referring to the OAuth2 Provider and gaining user profile information as well.

Methods inherited from class java.lang.Object

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

Constructor Detail

RestOAuth2AccessTokenValidator

public RestOAuth2AccessTokenValidator(JsonValue config,
                                      Client httpClient)

Creates a new instance of the RestOAuth2AccessTokenValidator.

Parameters:

config - The configuration for the validator.

httpClient - The Handler to use to make HTTP requests.

Method Detail

validate

public Promise<AccessTokenValidationResponse,OAuth2Exception> validate(String accessToken)

Validates whether the given access token is valid, by referring to the OAuth2 Provider and gaining user profile information as well.

Specified by:

validate in interface OAuth2AccessTokenValidator

Parameters:

accessToken - The access token to validate.

Returns:

An AccessTokenValidationResponse containing the result of the validation and scope and profile information.

getScope

protected Set<String> getScope(JsonValue tokenInfo)

Gets the scopes for the access token.

Parameters:

tokenInfo - The response from the token info endpoint.

Returns:

The Set of scopes.