io.vertx.ext.web.handler.impl

Class OAuth2AuthHandlerImpl

java.lang.Object

io.vertx.ext.web.handler.impl.AuthenticationHandlerImpl<T>

io.vertx.ext.web.handler.impl.HTTPAuthorizationHandler<OAuth2Auth>

io.vertx.ext.web.handler.impl.OAuth2AuthHandlerImpl

All Implemented Interfaces:

Handler<RoutingContext>, AuthenticationHandler, OAuth2AuthHandler

public class OAuth2AuthHandlerImpl
extends HTTPAuthorizationHandler<OAuth2Auth>
implements OAuth2AuthHandler

Author:

Paulo Lopes

Field Summary

Fields inherited from class io.vertx.ext.web.handler.impl.HTTPAuthorizationHandler

type

Fields inherited from class io.vertx.ext.web.handler.impl.AuthenticationHandlerImpl

authProvider, realm

Constructor Summary

Constructors

Constructor and Description
OAuth2AuthHandlerImpl(Vertx vertx, OAuth2Auth authProvider, String callbackURL)

Method Summary

Modifier and Type	Method and Description
OAuth2AuthHandler	extraParams(JsonObject extraParams) Extra parameters needed to be passed while requesting a token.
void	parseCredentials(RoutingContext context, Handler<AsyncResult<Credentials>> handler) Parses the credentials from the request into a JsonObject.
OAuth2AuthHandler	pkceVerifierLength(int length) PKCE (RFC 7636) is an extension to the Authorization Code flow to prevent several attacks and to be able to securely perform the OAuth exchange from public clients.
OAuth2AuthHandler	prompt(String prompt) Indicates the type of user interaction that is required.
OAuth2AuthHandler	setupCallback(Route route) add the callback handler to a given route.
OAuth2AuthHandler	withScope(String scope) scopes to be requested while requesting a token.

Methods inherited from class io.vertx.ext.web.handler.impl.HTTPAuthorizationHandler

authenticateHeader, parseAuthorization

Methods inherited from class io.vertx.ext.web.handler.impl.AuthenticationHandlerImpl

getAuthProvider, handle, processException

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.vertx.ext.web.handler.OAuth2AuthHandler

create, create

Methods inherited from interface io.vertx.ext.web.handler.AuthenticationHandler

authenticateHeader, parseCredentials, postAuthentication

Methods inherited from interface io.vertx.core.Handler

handle

Constructor Detail

OAuth2AuthHandlerImpl

public OAuth2AuthHandlerImpl(Vertx vertx,
                             OAuth2Auth authProvider,
                             String callbackURL)

Method Detail

parseCredentials

public void parseCredentials(RoutingContext context,
                             Handler<AsyncResult<Credentials>> handler)

Description copied from interface: AuthenticationHandler

Parses the credentials from the request into a JsonObject. The implementation should be able to extract the required info for the auth provider in the format the provider expects.

Specified by:

parseCredentials in interface AuthenticationHandler

Parameters:

context - the routing context

handler - the handler to be called once the information is available.

extraParams

public OAuth2AuthHandler extraParams(JsonObject extraParams)

Description copied from interface: OAuth2AuthHandler

Extra parameters needed to be passed while requesting a token.

Specified by:

extraParams in interface OAuth2AuthHandler

Parameters:

extraParams - extra optional parameters.

Returns:

self

withScope

public OAuth2AuthHandler withScope(String scope)

Description copied from interface: OAuth2AuthHandler

scopes to be requested while requesting a token.

Specified by:

withScope in interface OAuth2AuthHandler

Parameters:

scope - scope.

Returns:

self

prompt

public OAuth2AuthHandler prompt(String prompt)

Description copied from interface: OAuth2AuthHandler

Indicates the type of user interaction that is required. Not all providers support this or the full list. Well known values are:

• login will force the user to enter their credentials on that request, negating single-sign on.
• none is the opposite - it will ensure that the user isn't presented with any interactive prompt whatsoever. If the request can't be completed silently via single-sign on, the Microsoft identity platform endpoint will return an interaction_required error.
• consent will trigger the OAuth consent dialog after the user signs in, asking the user to grant permissions to the app.
• select_account will interrupt single sign-on providing account selection experience listing all the accounts either in session or any remembered account or an option to choose to use a different account altogether.

Specified by:

prompt in interface OAuth2AuthHandler

Parameters:

prompt - the prompt choice.

Returns:

self

pkceVerifierLength

public OAuth2AuthHandler pkceVerifierLength(int length)

Description copied from interface: OAuth2AuthHandler

PKCE (RFC 7636) is an extension to the Authorization Code flow to prevent several attacks and to be able to securely perform the OAuth exchange from public clients. It was originally designed to protect mobile apps, but its ability to prevent authorization code injection makes it useful for every OAuth client, even web apps that use a client secret.

Specified by:

pkceVerifierLength in interface OAuth2AuthHandler

Parameters:

length - A number between 43 and 128. Or -1 to disable.

Returns:

self

setupCallback

public OAuth2AuthHandler setupCallback(Route route)

Description copied from interface: OAuth2AuthHandler

add the callback handler to a given route.

Specified by:

setupCallback in interface OAuth2AuthHandler

Parameters:

route - a given route e.g.: `/callback`

Returns:

self