diff --git a/openid-connect-client/.settings/org.eclipse.wst.common.component b/openid-connect-client/.settings/org.eclipse.wst.common.component index d46f50e39..6227d3014 100755 --- a/openid-connect-client/.settings/org.eclipse.wst.common.component +++ b/openid-connect-client/.settings/org.eclipse.wst.common.component @@ -3,5 +3,6 @@ + diff --git a/openid-connect-client/README.md b/openid-connect-client/README.md index 2af7313d6..d4ec8dfa5 100644 --- a/openid-connect-client/README.md +++ b/openid-connect-client/README.md @@ -1,12 +1,14 @@ -# OpenID Connect Client +# OpenID Connect Client # -## Overview +## Overview ## -This is the Client, a Spring Security AuthenticationFilter, to the OpenID Connect Java Spring Server following the [OpenID Connect Standard] described protocol. +You are reading the documentation for the OIDC Client implemented as a Spring Security AuthenticationFilter. The client facilitates a user's authentication into the secured application to an OpenID Connect Java Spring Server following the [OpenID Connect Standard] described protocol. -## Configuration of OIDCAuthenticationFilter +## Configuring ## -Configure the OIDCAuthenticationFilter by adding the XML to your application context security like so making changes where necessary for your deployment: +Configure the client by adding the following XML to your application context security making changes where necessary for your specific deployment. + +Open and define an HTTP security configuration with a reference to a bean defined custom ***AuthenticationEntryPoint***: +Specify the access attributes and/or filter list for a particular set of URLs needing protection: + + pattern="/**" + access="hasAnyRole('ROLE_USER','ROLE_ADMIN')" /> + +Indicate that ***OpenIdConnectAuthenticationFilter*** authentication filter should be incorporated into the security filter chain: - - + +Set up remember-me authentication referencing the yet to be defined ***UserDetailsService***: - + + +Define a custom ***AuthenticationEntryPoint*** via a bean declaration: @@ -37,13 +46,34 @@ Configure the OIDCAuthenticationFilter by adding the XML to your application con value="/openid_connect_login"/> - +NOTE: The ***loginFormUrl*** value is post-pended to the URI of the application being secured to define the ***redirect_uri***, the value passed to the OIDC Server and, if the ***OIDCAuthenticationUsingChooserFilter*** is configured, also the Account Chooser Application. + +Define an ***AuthenticationManager*** with a reference to a custom authentication provider, ***OpenIDConnectAuthenticationProvider***: + + + + + +Define the custom authentication provider referencing the your yet to be defined implementation of a ***UserDetailsService***: