Module org.eclipse.jetty.security.openid

Package org.eclipse.jetty.security.openid

Class OpenIdAuthenticator

java.lang.Object

org.eclipse.jetty.security.authentication.LoginAuthenticator

org.eclipse.jetty.security.openid.OpenIdAuthenticator

All Implemented Interfaces:

org.eclipse.jetty.security.Authenticator

public class OpenIdAuthenticator
extends org.eclipse.jetty.security.authentication.LoginAuthenticator

Implements authentication using OpenId Connect on top of OAuth 2.0.

The OpenIdAuthenticator redirects unauthenticated requests to the OpenID Connect Provider. The End-User is eventually redirected back with an Authorization Code to the path set by setRedirectPath(String) within the context. The Authorization Code is then used to authenticate the user through the OpenIdCredentials and OpenIdLoginService.

Once a user is authenticated the OpenID Claims can be retrieved through an attribute on the session with the key CLAIMS. The full response containing the OAuth 2.0 Access Token can be obtained with the session attribute RESPONSE.

SessionAuthentication is then used to wrap Authentication results so that they are associated with the session.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OpenIdAuthenticator.OpenIdAuthentication	This Authentication represents a just completed OpenId Connect authentication.

Nested classes/interfaces inherited from interface org.eclipse.jetty.security.Authenticator

org.eclipse.jetty.security.Authenticator.AuthConfiguration, org.eclipse.jetty.security.Authenticator.Factory

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CLAIMS
static final String	CSRF_TOKEN	Deprecated.
static final String	ERROR_PAGE
static final String	ERROR_PARAMETER
static final String	ISSUER
static final String	J_METHOD
static final String	J_POST
static final String	J_SECURITY_CHECK
static final String	J_URI
static final String	REDIRECT_PATH
static final String	RESPONSE

Fields inherited from class org.eclipse.jetty.security.authentication.LoginAuthenticator

_identityService, _loginService

Constructor Summary

Constructors

Constructor	Description
OpenIdAuthenticator()
OpenIdAuthenticator(OpenIdConfiguration configuration)
OpenIdAuthenticator(OpenIdConfiguration configuration, String errorPage)
OpenIdAuthenticator(OpenIdConfiguration configuration, String redirectPath, String errorPage)

Method Summary

Modifier and Type	Method	Description
String	getAuthMethod()
protected String	getChallengeUri(org.eclipse.jetty.server.Request request)
boolean	isAlwaysSaveUri()	Deprecated.
boolean	isErrorPage(String pathInContext)
boolean	isJSecurityCheck(String uri)
org.eclipse.jetty.server.UserIdentity	login(String username, Object credentials, jakarta.servlet.ServletRequest request)
void	logout(jakarta.servlet.ServletRequest request)
void	prepareRequest(jakarta.servlet.ServletRequest request)
boolean	secureResponse(jakarta.servlet.ServletRequest req, jakarta.servlet.ServletResponse res, boolean mandatory, org.eclipse.jetty.server.Authentication.User validatedUser)
void	setAlwaysSaveUri(boolean alwaysSave)	Deprecated.
void	setConfiguration(org.eclipse.jetty.security.Authenticator.AuthConfiguration authConfig)
void	setErrorPage(String path)
void	setRedirectPath(String redirectPath)
org.eclipse.jetty.server.Authentication	validateRequest(jakarta.servlet.ServletRequest req, jakarta.servlet.ServletResponse res, boolean mandatory)

Methods inherited from class org.eclipse.jetty.security.authentication.LoginAuthenticator

getLoginService, renewSession

Methods inherited from class java.lang.Object

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

Field Details

CLAIMS

public static final String CLAIMS

See Also:

• Constant Field Values

RESPONSE

public static final String RESPONSE

See Also:

• Constant Field Values

ISSUER

public static final String ISSUER

See Also:

• Constant Field Values

REDIRECT_PATH

public static final String REDIRECT_PATH

See Also:

• Constant Field Values

ERROR_PAGE

public static final String ERROR_PAGE

See Also:

• Constant Field Values

J_URI

public static final String J_URI

See Also:

• Constant Field Values

J_POST

public static final String J_POST

See Also:

• Constant Field Values

J_METHOD

public static final String J_METHOD

See Also:

• Constant Field Values

J_SECURITY_CHECK

public static final String J_SECURITY_CHECK

See Also:

• Constant Field Values

ERROR_PARAMETER

public static final String ERROR_PARAMETER

See Also:

• Constant Field Values

CSRF_TOKEN

@Deprecated
public static final String CSRF_TOKEN

Deprecated.

See Also:

• Constant Field Values

Constructor Details

OpenIdAuthenticator

public OpenIdAuthenticator()

OpenIdAuthenticator

public OpenIdAuthenticator(OpenIdConfiguration configuration)

OpenIdAuthenticator

public OpenIdAuthenticator(OpenIdConfiguration configuration,
 String errorPage)

OpenIdAuthenticator

public OpenIdAuthenticator(OpenIdConfiguration configuration,
 String redirectPath,
 String errorPage)

Method Details

setConfiguration

public void setConfiguration(org.eclipse.jetty.security.Authenticator.AuthConfiguration authConfig)

Specified by:

setConfiguration in interface org.eclipse.jetty.security.Authenticator

Overrides:

setConfiguration in class org.eclipse.jetty.security.authentication.LoginAuthenticator

getAuthMethod

public String getAuthMethod()

setAlwaysSaveUri

@Deprecated
public void setAlwaysSaveUri(boolean alwaysSave)

Deprecated.

isAlwaysSaveUri

@Deprecated
public boolean isAlwaysSaveUri()

Deprecated.

setRedirectPath

public void setRedirectPath(String redirectPath)

setErrorPage

public void setErrorPage(String path)

login

public org.eclipse.jetty.server.UserIdentity login(String username,
 Object credentials,
 jakarta.servlet.ServletRequest request)

Overrides:

login in class org.eclipse.jetty.security.authentication.LoginAuthenticator

logout

public void logout(jakarta.servlet.ServletRequest request)

Overrides:

logout in class org.eclipse.jetty.security.authentication.LoginAuthenticator

prepareRequest

public void prepareRequest(jakarta.servlet.ServletRequest request)

Specified by:

prepareRequest in interface org.eclipse.jetty.security.Authenticator

Overrides:

prepareRequest in class org.eclipse.jetty.security.authentication.LoginAuthenticator

validateRequest

public org.eclipse.jetty.server.Authentication validateRequest(jakarta.servlet.ServletRequest req,
 jakarta.servlet.ServletResponse res,
 boolean mandatory)
                                                        throws org.eclipse.jetty.security.ServerAuthException

Throws:

org.eclipse.jetty.security.ServerAuthException

isJSecurityCheck

public boolean isJSecurityCheck(String uri)

isErrorPage

public boolean isErrorPage(String pathInContext)

getChallengeUri

protected String getChallengeUri(org.eclipse.jetty.server.Request request)

secureResponse

public boolean secureResponse(jakarta.servlet.ServletRequest req,
 jakarta.servlet.ServletResponse res,
 boolean mandatory,
 org.eclipse.jetty.server.Authentication.User validatedUser)