Eclipse
/
jetty.project
mirror of https://github.com/jetty/jetty.project.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

OpenIdAuthenticator javadoc update 

Signed-off-by: Lachlan Roberts <lachlan@webtide.com>
This commit is contained in:
Lachlan Roberts 2019-09-09 17:34:39 +10:00
parent dc26739502
commit 9134def345
1 changed files with 10 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
jetty-openid/src/main/java/org/eclipse/jetty/security/openid/OpenIdAuthenticator.java
View File

@ -50,14 +50,17 @@ import org.eclipse.jetty.util.log.Logger;
import org.eclipse.jetty.util.security.Constraint; import org.eclipse.jetty.util.security.Constraint;
/** /**
* OpenId Connect Authenticator. * <p>Implements authentication using OpenId Connect on top of OAuth 2.0.
* *
* <p>This authenticator implements authentication using OpenId Connect on top of OAuth 2.0. * <p>The OpenIdAuthenticator redirects unauthenticated requests to the OpenID Connect Provider. The End-User is
* * eventually redirected back with an Authorization Code to the /j_security_check URI within the context.
* <p>The authenticator redirects unauthenticated requests to the identity providers authorization endpoint * The Authorization Code is then used to authenticate the user through the {@link OpenIdCredentials} and {@link OpenIdLoginService}.
* which will eventually redirect back to the redirectUri with an authorization code which will be exchanged with * </p>
* the token_endpoint for an id_token. The request is then restored back to the original uri requested. * <p>
* {@link SessionAuthentication} is then used to wrap Authentication results so that they are associated with the session.</p> * Once a user is authenticated the OpenID Claims can be retrieved through an attribute on the session with the key {@link #CLAIMS}.
* The full response containing the OAuth 2.0 Access Token can be obtained with the session attribute {@link #RESPONSE}.
* </p>
* <p>{@link SessionAuthentication} is then used to wrap Authentication results so that they are associated with the session.</p>
*/ */
public class OpenIdAuthenticator extends LoginAuthenticator public class OpenIdAuthenticator extends LoginAuthenticator
{ {