Josh Cummings
parent
8c508d6afa
commit
3db13de1e2
|
|
@ -54,7 +54,9 @@
|
|||
*** xref:servlet/authorization/method-security.adoc[Method Security]
|
||||
*** xref:servlet/authorization/acls.adoc[Domain Object Security ACLs]
|
||||
** xref:servlet/oauth2/index.adoc[OAuth2]
|
||||
*** xref:servlet/oauth2/oauth2-login.adoc[OAuth2 Log In]
|
||||
*** xref:servlet/oauth2/login/index.adoc[OAuth2 Log In]
|
||||
**** xref:servlet/oauth2/login/core.adoc[Core Configuration]
|
||||
**** xref:servlet/oauth2/login/advanced.adoc[Advanced Configuration]
|
||||
*** xref:servlet/oauth2/client/index.adoc[OAuth2 Client]
|
||||
**** xref:servlet/oauth2/client/core.adoc[Core Interfaces and Classes]
|
||||
**** xref:servlet/oauth2/client/authorization-grants.adoc[OAuth2 Authorization Grants]
|
||||
|
|
|
|||
|
|
@ -863,7 +863,7 @@ Maps a `ForwardAuthenticationFailureHandler` to `authenticationFailureHandler` p
|
|||
|
||||
[[nsa-oauth2-login]]
|
||||
== <oauth2-login>
|
||||
The xref:servlet/oauth2/oauth2-login.adoc#oauth2login[OAuth 2.0 Login] feature configures authentication support using an OAuth 2.0 and/or OpenID Connect 1.0 Provider.
|
||||
The xref:servlet/oauth2/login/index.adoc#oauth2login[OAuth 2.0 Login] feature configures authentication support using an OAuth 2.0 and/or OpenID Connect 1.0 Provider.
|
||||
|
||||
|
||||
[[nsa-oauth2-login-parents]]
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ These sections focus on specific ways you may want to authenticate and point bac
|
|||
// FIXME: brief description
|
||||
|
||||
* xref:servlet/authentication/passwords/index.adoc#servlet-authentication-unpwd[Username and Password] - how to authenticate with a username/password
|
||||
* xref:servlet/oauth2/oauth2-login.adoc#oauth2login[OAuth 2.0 Login] - OAuth 2.0 Log In with OpenID Connect and non-standard OAuth 2.0 Login (i.e. GitHub)
|
||||
* xref:servlet/oauth2/login/index.adoc#oauth2login[OAuth 2.0 Login] - OAuth 2.0 Log In with OpenID Connect and non-standard OAuth 2.0 Login (i.e. GitHub)
|
||||
* xref:servlet/saml2/index.adoc#servlet-saml2[SAML 2.0 Login] - SAML 2.0 Log In
|
||||
* xref:servlet/authentication/rememberme.adoc#servlet-rememberme[Remember Me] - how to remember a user past session expiration
|
||||
* xref:servlet/authentication/jaas.adoc#servlet-jaas[JAAS Authentication] - authenticate with JAAS
|
||||
|
|
|
|||
|
|
@ -1,581 +1,5 @@
|
|||
[[oauth2login]]
|
||||
= OAuth 2.0 Login
|
||||
|
||||
The OAuth 2.0 Login feature provides an application with the capability to have users log in to the application by using their existing account at an OAuth 2.0 Provider (e.g. GitHub) or OpenID Connect 1.0 Provider (such as Google).
|
||||
OAuth 2.0 Login implements the use cases: "Login with Google" or "Login with GitHub".
|
||||
|
||||
NOTE: OAuth 2.0 Login is implemented by using the *Authorization Code Grant*, as specified in the https://tools.ietf.org/html/rfc6749#section-4.1[OAuth 2.0 Authorization Framework] and https://openid.net/specs/openid-connect-core-1_0.html#CodeFlowAuth[OpenID Connect Core 1.0].
|
||||
|
||||
|
||||
[[oauth2login-sample-boot]]
|
||||
== Spring Boot 2.x Sample
|
||||
|
||||
Spring Boot 2.x brings full auto-configuration capabilities for OAuth 2.0 Login.
|
||||
|
||||
This section shows how to configure the {gh-samples-url}/servlet/spring-boot/java/oauth2/login[*OAuth 2.0 Login sample*] using _Google_ as the _Authentication Provider_ and covers the following topics:
|
||||
|
||||
* <<oauth2login-sample-initial-setup,Initial setup>>
|
||||
* <<oauth2login-sample-redirect-uri,Setting the redirect URI>>
|
||||
* <<oauth2login-sample-application-config,Configure application.yml>>
|
||||
* <<oauth2login-sample-boot-application,Boot up the application>>
|
||||
|
||||
|
||||
[[oauth2login-sample-initial-setup]]
|
||||
=== Initial setup
|
||||
|
||||
To use Google's OAuth 2.0 authentication system for login, you must set up a project in the Google API Console to obtain OAuth 2.0 credentials.
|
||||
|
||||
NOTE: https://developers.google.com/identity/protocols/OpenIDConnect[Google's OAuth 2.0 implementation] for authentication conforms to the https://openid.net/connect/[OpenID Connect 1.0] specification and is https://openid.net/certification/[OpenID Certified].
|
||||
|
||||
Follow the instructions on the https://developers.google.com/identity/protocols/OpenIDConnect[OpenID Connect] page, starting in the section, "Setting up OAuth 2.0".
|
||||
|
||||
After completing the "Obtain OAuth 2.0 credentials" instructions, you should have a new OAuth Client with credentials consisting of a Client ID and a Client Secret.
|
||||
|
||||
|
||||
[[oauth2login-sample-redirect-uri]]
|
||||
=== Setting the redirect URI
|
||||
|
||||
The redirect URI is the path in the application that the end-user's user-agent is redirected back to after they have authenticated with Google and have granted access to the OAuth Client _(<<oauth2login-sample-initial-setup,created in the previous step>>)_ on the Consent page.
|
||||
|
||||
In the "Set a redirect URI" sub-section, ensure that the *Authorized redirect URIs* field is set to `http://localhost:8080/login/oauth2/code/google`.
|
||||
|
||||
TIP: The default redirect URI template is `+{baseUrl}/login/oauth2/code/{registrationId}+`.
|
||||
The *_registrationId_* is a unique identifier for the xref:servlet/oauth2/client/index.adoc#oauth2Client-client-registration[ClientRegistration].
|
||||
|
||||
IMPORTANT: If the OAuth Client is running behind a proxy server, it is recommended to check xref:features/exploits/http.adoc#http-proxy-server[Proxy Server Configuration] to ensure the application is correctly configured.
|
||||
Also, see the supported xref:servlet/oauth2/client/authorization-grants.adoc#oauth2Client-auth-code-redirect-uri[ `URI` template variables] for `redirect-uri`.
|
||||
|
||||
|
||||
[[oauth2login-sample-application-config]]
|
||||
=== Configure application.yml
|
||||
|
||||
Now that you have a new OAuth Client with Google, you need to configure the application to use the OAuth Client for the _authentication flow_.
|
||||
To do so:
|
||||
|
||||
. Go to `application.yml` and set the following configuration:
|
||||
+
|
||||
[source,yaml]
|
||||
----
|
||||
spring:
|
||||
security:
|
||||
oauth2:
|
||||
client:
|
||||
registration: <1>
|
||||
google: <2>
|
||||
client-id: google-client-id
|
||||
client-secret: google-client-secret
|
||||
----
|
||||
+
|
||||
.OAuth Client properties
|
||||
====
|
||||
<1> `spring.security.oauth2.client.registration` is the base property prefix for OAuth Client properties.
|
||||
<2> Following the base property prefix is the ID for the xref:servlet/oauth2/client/index.adoc#oauth2Client-client-registration[ClientRegistration], such as google.
|
||||
====
|
||||
|
||||
. Replace the values in the `client-id` and `client-secret` property with the OAuth 2.0 credentials you created earlier.
|
||||
|
||||
|
||||
[[oauth2login-sample-boot-application]]
|
||||
=== Boot up the application
|
||||
|
||||
Launch the Spring Boot 2.x sample and go to `http://localhost:8080`.
|
||||
You are then redirected to the default _auto-generated_ login page, which displays a link for Google.
|
||||
|
||||
Click on the Google link, and you are then redirected to Google for authentication.
|
||||
|
||||
After authenticating with your Google account credentials, the next page presented to you is the Consent screen.
|
||||
The Consent screen asks you to either allow or deny access to the OAuth Client you created earlier.
|
||||
Click *Allow* to authorize the OAuth Client to access your email address and basic profile information.
|
||||
|
||||
At this point, the OAuth Client retrieves your email address and basic profile information from the https://openid.net/specs/openid-connect-core-1_0.html#UserInfo[UserInfo Endpoint] and establishes an authenticated session.
|
||||
|
||||
|
||||
[[oauth2login-boot-property-mappings]]
|
||||
== Spring Boot 2.x Property Mappings
|
||||
|
||||
The following table outlines the mapping of the Spring Boot 2.x OAuth Client properties to the xref:servlet/oauth2/client/index.adoc#oauth2Client-client-registration[ClientRegistration] properties.
|
||||
|
||||
|===
|
||||
|Spring Boot 2.x |ClientRegistration
|
||||
|
||||
|`spring.security.oauth2.client.registration._[registrationId]_`
|
||||
|`registrationId`
|
||||
|
||||
|`spring.security.oauth2.client.registration._[registrationId]_.client-id`
|
||||
|`clientId`
|
||||
|
||||
|`spring.security.oauth2.client.registration._[registrationId]_.client-secret`
|
||||
|`clientSecret`
|
||||
|
||||
|`spring.security.oauth2.client.registration._[registrationId]_.client-authentication-method`
|
||||
|`clientAuthenticationMethod`
|
||||
|
||||
|`spring.security.oauth2.client.registration._[registrationId]_.authorization-grant-type`
|
||||
|`authorizationGrantType`
|
||||
|
||||
|`spring.security.oauth2.client.registration._[registrationId]_.redirect-uri`
|
||||
|`redirectUri`
|
||||
|
||||
|`spring.security.oauth2.client.registration._[registrationId]_.scope`
|
||||
|`scopes`
|
||||
|
||||
|`spring.security.oauth2.client.registration._[registrationId]_.client-name`
|
||||
|`clientName`
|
||||
|
||||
|`spring.security.oauth2.client.provider._[providerId]_.authorization-uri`
|
||||
|`providerDetails.authorizationUri`
|
||||
|
||||
|`spring.security.oauth2.client.provider._[providerId]_.token-uri`
|
||||
|`providerDetails.tokenUri`
|
||||
|
||||
|`spring.security.oauth2.client.provider._[providerId]_.jwk-set-uri`
|
||||
|`providerDetails.jwkSetUri`
|
||||
|
||||
|`spring.security.oauth2.client.provider._[providerId]_.issuer-uri`
|
||||
|`providerDetails.issuerUri`
|
||||
|
||||
|`spring.security.oauth2.client.provider._[providerId]_.user-info-uri`
|
||||
|`providerDetails.userInfoEndpoint.uri`
|
||||
|
||||
|`spring.security.oauth2.client.provider._[providerId]_.user-info-authentication-method`
|
||||
|`providerDetails.userInfoEndpoint.authenticationMethod`
|
||||
|
||||
|`spring.security.oauth2.client.provider._[providerId]_.user-name-attribute`
|
||||
|`providerDetails.userInfoEndpoint.userNameAttributeName`
|
||||
|===
|
||||
|
||||
[TIP]
|
||||
A `ClientRegistration` can be initially configured using discovery of an OpenID Connect Provider's https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfig[Configuration endpoint] or an Authorization Server's https://tools.ietf.org/html/rfc8414#section-3[Metadata endpoint], by specifying the `spring.security.oauth2.client.provider._[providerId]_.issuer-uri` property.
|
||||
|
||||
|
||||
[[oauth2login-common-oauth2-provider]]
|
||||
== CommonOAuth2Provider
|
||||
|
||||
`CommonOAuth2Provider` pre-defines a set of default client properties for a number of well known providers: Google, GitHub, Facebook, and Okta.
|
||||
|
||||
For example, the `authorization-uri`, `token-uri`, and `user-info-uri` do not change often for a Provider.
|
||||
Therefore, it makes sense to provide default values in order to reduce the required configuration.
|
||||
|
||||
As demonstrated previously, when we <<oauth2login-sample-application-config,configured a Google client>>, only the `client-id` and `client-secret` properties are required.
|
||||
|
||||
The following listing shows an example:
|
||||
|
||||
[source,yaml]
|
||||
----
|
||||
spring:
|
||||
security:
|
||||
oauth2:
|
||||
client:
|
||||
registration:
|
||||
google:
|
||||
client-id: google-client-id
|
||||
client-secret: google-client-secret
|
||||
----
|
||||
|
||||
[TIP]
|
||||
The auto-defaulting of client properties works seamlessly here because the `registrationId` (`google`) matches the `GOOGLE` `enum` (case-insensitive) in `CommonOAuth2Provider`.
|
||||
|
||||
For cases where you may want to specify a different `registrationId`, such as `google-login`, you can still leverage auto-defaulting of client properties by configuring the `provider` property.
|
||||
|
||||
The following listing shows an example:
|
||||
|
||||
[source,yaml]
|
||||
----
|
||||
spring:
|
||||
security:
|
||||
oauth2:
|
||||
client:
|
||||
registration:
|
||||
google-login: <1>
|
||||
provider: google <2>
|
||||
client-id: google-client-id
|
||||
client-secret: google-client-secret
|
||||
----
|
||||
<1> The `registrationId` is set to `google-login`.
|
||||
<2> The `provider` property is set to `google`, which will leverage the auto-defaulting of client properties set in `CommonOAuth2Provider.GOOGLE.getBuilder()`.
|
||||
|
||||
|
||||
[[oauth2login-custom-provider-properties]]
|
||||
== Configuring Custom Provider Properties
|
||||
|
||||
There are some OAuth 2.0 Providers that support multi-tenancy, which results in different protocol endpoints for each tenant (or sub-domain).
|
||||
|
||||
For example, an OAuth Client registered with Okta is assigned to a specific sub-domain and have their own protocol endpoints.
|
||||
|
||||
For these cases, Spring Boot 2.x provides the following base property for configuring custom provider properties: `spring.security.oauth2.client.provider._[providerId]_`.
|
||||
|
||||
The following listing shows an example:
|
||||
|
||||
[source,yaml]
|
||||
----
|
||||
spring:
|
||||
security:
|
||||
oauth2:
|
||||
client:
|
||||
registration:
|
||||
okta:
|
||||
client-id: okta-client-id
|
||||
client-secret: okta-client-secret
|
||||
provider:
|
||||
okta: <1>
|
||||
authorization-uri: https://your-subdomain.oktapreview.com/oauth2/v1/authorize
|
||||
token-uri: https://your-subdomain.oktapreview.com/oauth2/v1/token
|
||||
user-info-uri: https://your-subdomain.oktapreview.com/oauth2/v1/userinfo
|
||||
user-name-attribute: sub
|
||||
jwk-set-uri: https://your-subdomain.oktapreview.com/oauth2/v1/keys
|
||||
----
|
||||
|
||||
<1> The base property (`spring.security.oauth2.client.provider.okta`) allows for custom configuration of protocol endpoint locations.
|
||||
|
||||
|
||||
[[oauth2login-override-boot-autoconfig]]
|
||||
== Overriding Spring Boot 2.x Auto-configuration
|
||||
|
||||
The Spring Boot 2.x auto-configuration class for OAuth Client support is `OAuth2ClientAutoConfiguration`.
|
||||
|
||||
It performs the following tasks:
|
||||
|
||||
* Registers a `ClientRegistrationRepository` `@Bean` composed of `ClientRegistration`(s) from the configured OAuth Client properties.
|
||||
* Provides a `WebSecurityConfigurerAdapter` `@Configuration` and enables OAuth 2.0 Login through `httpSecurity.oauth2Login()`.
|
||||
|
||||
If you need to override the auto-configuration based on your specific requirements, you may do so in the following ways:
|
||||
|
||||
* <<oauth2login-register-clientregistrationrepository-bean,Register a ClientRegistrationRepository @Bean>>
|
||||
* <<oauth2login-provide-websecurityconfigureradapter,Provide a WebSecurityConfigurerAdapter>>
|
||||
* <<oauth2login-completely-override-autoconfiguration,Completely Override the Auto-configuration>>
|
||||
|
||||
|
||||
[[oauth2login-register-clientregistrationrepository-bean]]
|
||||
=== Register a ClientRegistrationRepository @Bean
|
||||
|
||||
The following example shows how to register a `ClientRegistrationRepository` `@Bean`:
|
||||
|
||||
====
|
||||
.Java
|
||||
[source,java,role="primary",attrs="-attributes"]
|
||||
----
|
||||
@Configuration
|
||||
public class OAuth2LoginConfig {
|
||||
|
||||
@Bean
|
||||
public ClientRegistrationRepository clientRegistrationRepository() {
|
||||
return new InMemoryClientRegistrationRepository(this.googleClientRegistration());
|
||||
}
|
||||
|
||||
private ClientRegistration googleClientRegistration() {
|
||||
return ClientRegistration.withRegistrationId("google")
|
||||
.clientId("google-client-id")
|
||||
.clientSecret("google-client-secret")
|
||||
.clientAuthenticationMethod(ClientAuthenticationMethod.CLIENT_SECRET_BASIC)
|
||||
.authorizationGrantType(AuthorizationGrantType.AUTHORIZATION_CODE)
|
||||
.redirectUri("{baseUrl}/login/oauth2/code/{registrationId}")
|
||||
.scope("openid", "profile", "email", "address", "phone")
|
||||
.authorizationUri("https://accounts.google.com/o/oauth2/v2/auth")
|
||||
.tokenUri("https://www.googleapis.com/oauth2/v4/token")
|
||||
.userInfoUri("https://www.googleapis.com/oauth2/v3/userinfo")
|
||||
.userNameAttributeName(IdTokenClaimNames.SUB)
|
||||
.jwkSetUri("https://www.googleapis.com/oauth2/v3/certs")
|
||||
.clientName("Google")
|
||||
.build();
|
||||
}
|
||||
}
|
||||
----
|
||||
|
||||
.Kotlin
|
||||
[source,kotlin,role="secondary",attrs="-attributes"]
|
||||
----
|
||||
@Configuration
|
||||
class OAuth2LoginConfig {
|
||||
@Bean
|
||||
fun clientRegistrationRepository(): ClientRegistrationRepository {
|
||||
return InMemoryClientRegistrationRepository(googleClientRegistration())
|
||||
}
|
||||
|
||||
private fun googleClientRegistration(): ClientRegistration {
|
||||
return ClientRegistration.withRegistrationId("google")
|
||||
.clientId("google-client-id")
|
||||
.clientSecret("google-client-secret")
|
||||
.clientAuthenticationMethod(ClientAuthenticationMethod.CLIENT_SECRET_BASIC)
|
||||
.authorizationGrantType(AuthorizationGrantType.AUTHORIZATION_CODE)
|
||||
.redirectUri("{baseUrl}/login/oauth2/code/{registrationId}")
|
||||
.scope("openid", "profile", "email", "address", "phone")
|
||||
.authorizationUri("https://accounts.google.com/o/oauth2/v2/auth")
|
||||
.tokenUri("https://www.googleapis.com/oauth2/v4/token")
|
||||
.userInfoUri("https://www.googleapis.com/oauth2/v3/userinfo")
|
||||
.userNameAttributeName(IdTokenClaimNames.SUB)
|
||||
.jwkSetUri("https://www.googleapis.com/oauth2/v3/certs")
|
||||
.clientName("Google")
|
||||
.build()
|
||||
}
|
||||
}
|
||||
----
|
||||
====
|
||||
|
||||
|
||||
[[oauth2login-provide-websecurityconfigureradapter]]
|
||||
=== Provide a WebSecurityConfigurerAdapter
|
||||
|
||||
The following example shows how to provide a `WebSecurityConfigurerAdapter` with `@EnableWebSecurity` and enable OAuth 2.0 login through `httpSecurity.oauth2Login()`:
|
||||
|
||||
.OAuth2 Login Configuration
|
||||
====
|
||||
.Java
|
||||
[source,java,role="primary"]
|
||||
----
|
||||
@EnableWebSecurity
|
||||
public class OAuth2LoginSecurityConfig extends WebSecurityConfigurerAdapter {
|
||||
|
||||
@Override
|
||||
protected void configure(HttpSecurity http) throws Exception {
|
||||
http
|
||||
.authorizeRequests(authorize -> authorize
|
||||
.anyRequest().authenticated()
|
||||
)
|
||||
.oauth2Login(withDefaults());
|
||||
}
|
||||
}
|
||||
----
|
||||
|
||||
.Kotlin
|
||||
[source,kotlin,role="secondary"]
|
||||
----
|
||||
@EnableWebSecurity
|
||||
class OAuth2LoginSecurityConfig : WebSecurityConfigurerAdapter() {
|
||||
|
||||
override fun configure(http: HttpSecurity) {
|
||||
http {
|
||||
authorizeRequests {
|
||||
authorize(anyRequest, authenticated)
|
||||
}
|
||||
oauth2Login { }
|
||||
}
|
||||
}
|
||||
}
|
||||
----
|
||||
====
|
||||
|
||||
|
||||
[[oauth2login-completely-override-autoconfiguration]]
|
||||
=== Completely Override the Auto-configuration
|
||||
|
||||
The following example shows how to completely override the auto-configuration by registering a `ClientRegistrationRepository` `@Bean` and providing a `WebSecurityConfigurerAdapter`.
|
||||
|
||||
.Overriding the auto-configuration
|
||||
====
|
||||
.Java
|
||||
[source,java,role="primary",attrs="-attributes"]
|
||||
----
|
||||
@Configuration
|
||||
public class OAuth2LoginConfig {
|
||||
|
||||
@EnableWebSecurity
|
||||
public static class OAuth2LoginSecurityConfig extends WebSecurityConfigurerAdapter {
|
||||
|
||||
@Override
|
||||
protected void configure(HttpSecurity http) throws Exception {
|
||||
http
|
||||
.authorizeRequests(authorize -> authorize
|
||||
.anyRequest().authenticated()
|
||||
)
|
||||
.oauth2Login(withDefaults());
|
||||
}
|
||||
}
|
||||
|
||||
@Bean
|
||||
public ClientRegistrationRepository clientRegistrationRepository() {
|
||||
return new InMemoryClientRegistrationRepository(this.googleClientRegistration());
|
||||
}
|
||||
|
||||
private ClientRegistration googleClientRegistration() {
|
||||
return ClientRegistration.withRegistrationId("google")
|
||||
.clientId("google-client-id")
|
||||
.clientSecret("google-client-secret")
|
||||
.clientAuthenticationMethod(ClientAuthenticationMethod.CLIENT_SECRET_BASIC)
|
||||
.authorizationGrantType(AuthorizationGrantType.AUTHORIZATION_CODE)
|
||||
.redirectUri("{baseUrl}/login/oauth2/code/{registrationId}")
|
||||
.scope("openid", "profile", "email", "address", "phone")
|
||||
.authorizationUri("https://accounts.google.com/o/oauth2/v2/auth")
|
||||
.tokenUri("https://www.googleapis.com/oauth2/v4/token")
|
||||
.userInfoUri("https://www.googleapis.com/oauth2/v3/userinfo")
|
||||
.userNameAttributeName(IdTokenClaimNames.SUB)
|
||||
.jwkSetUri("https://www.googleapis.com/oauth2/v3/certs")
|
||||
.clientName("Google")
|
||||
.build();
|
||||
}
|
||||
}
|
||||
----
|
||||
|
||||
.Kotlin
|
||||
[source,kotlin,role="secondary",attrs="-attributes"]
|
||||
----
|
||||
@Configuration
|
||||
class OAuth2LoginConfig {
|
||||
|
||||
@EnableWebSecurity
|
||||
class OAuth2LoginSecurityConfig: WebSecurityConfigurerAdapter() {
|
||||
|
||||
override fun configure(http: HttpSecurity) {
|
||||
http {
|
||||
authorizeRequests {
|
||||
authorize(anyRequest, authenticated)
|
||||
}
|
||||
oauth2Login { }
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@Bean
|
||||
fun clientRegistrationRepository(): ClientRegistrationRepository {
|
||||
return InMemoryClientRegistrationRepository(googleClientRegistration())
|
||||
}
|
||||
|
||||
private fun googleClientRegistration(): ClientRegistration {
|
||||
return ClientRegistration.withRegistrationId("google")
|
||||
.clientId("google-client-id")
|
||||
.clientSecret("google-client-secret")
|
||||
.clientAuthenticationMethod(ClientAuthenticationMethod.CLIENT_SECRET_BASIC)
|
||||
.authorizationGrantType(AuthorizationGrantType.AUTHORIZATION_CODE)
|
||||
.redirectUri("{baseUrl}/login/oauth2/code/{registrationId}")
|
||||
.scope("openid", "profile", "email", "address", "phone")
|
||||
.authorizationUri("https://accounts.google.com/o/oauth2/v2/auth")
|
||||
.tokenUri("https://www.googleapis.com/oauth2/v4/token")
|
||||
.userInfoUri("https://www.googleapis.com/oauth2/v3/userinfo")
|
||||
.userNameAttributeName(IdTokenClaimNames.SUB)
|
||||
.jwkSetUri("https://www.googleapis.com/oauth2/v3/certs")
|
||||
.clientName("Google")
|
||||
.build()
|
||||
}
|
||||
}
|
||||
----
|
||||
====
|
||||
|
||||
|
||||
[[oauth2login-javaconfig-wo-boot]]
|
||||
== Java Configuration without Spring Boot 2.x
|
||||
|
||||
If you are not able to use Spring Boot 2.x and would like to configure one of the pre-defined providers in `CommonOAuth2Provider` (for example, Google), apply the following configuration:
|
||||
|
||||
.OAuth2 Login Configuration
|
||||
====
|
||||
.Java
|
||||
[source,java,role="primary"]
|
||||
----
|
||||
@Configuration
|
||||
public class OAuth2LoginConfig {
|
||||
|
||||
@EnableWebSecurity
|
||||
public static class OAuth2LoginSecurityConfig extends WebSecurityConfigurerAdapter {
|
||||
|
||||
@Override
|
||||
protected void configure(HttpSecurity http) throws Exception {
|
||||
http
|
||||
.authorizeRequests(authorize -> authorize
|
||||
.anyRequest().authenticated()
|
||||
)
|
||||
.oauth2Login(withDefaults());
|
||||
}
|
||||
}
|
||||
|
||||
@Bean
|
||||
public ClientRegistrationRepository clientRegistrationRepository() {
|
||||
return new InMemoryClientRegistrationRepository(this.googleClientRegistration());
|
||||
}
|
||||
|
||||
@Bean
|
||||
public OAuth2AuthorizedClientService authorizedClientService(
|
||||
ClientRegistrationRepository clientRegistrationRepository) {
|
||||
return new InMemoryOAuth2AuthorizedClientService(clientRegistrationRepository);
|
||||
}
|
||||
|
||||
@Bean
|
||||
public OAuth2AuthorizedClientRepository authorizedClientRepository(
|
||||
OAuth2AuthorizedClientService authorizedClientService) {
|
||||
return new AuthenticatedPrincipalOAuth2AuthorizedClientRepository(authorizedClientService);
|
||||
}
|
||||
|
||||
private ClientRegistration googleClientRegistration() {
|
||||
return CommonOAuth2Provider.GOOGLE.getBuilder("google")
|
||||
.clientId("google-client-id")
|
||||
.clientSecret("google-client-secret")
|
||||
.build();
|
||||
}
|
||||
}
|
||||
----
|
||||
|
||||
.Kotlin
|
||||
[source,kotlin,role="secondary"]
|
||||
----
|
||||
@Configuration
|
||||
open class OAuth2LoginConfig {
|
||||
@EnableWebSecurity
|
||||
open class OAuth2LoginSecurityConfig : WebSecurityConfigurerAdapter() {
|
||||
override fun configure(http: HttpSecurity) {
|
||||
http {
|
||||
authorizeRequests {
|
||||
authorize(anyRequest, authenticated)
|
||||
}
|
||||
oauth2Login { }
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@Bean
|
||||
open fun clientRegistrationRepository(): ClientRegistrationRepository {
|
||||
return InMemoryClientRegistrationRepository(googleClientRegistration())
|
||||
}
|
||||
|
||||
@Bean
|
||||
open fun authorizedClientService(
|
||||
clientRegistrationRepository: ClientRegistrationRepository?
|
||||
): OAuth2AuthorizedClientService {
|
||||
return InMemoryOAuth2AuthorizedClientService(clientRegistrationRepository)
|
||||
}
|
||||
|
||||
@Bean
|
||||
open fun authorizedClientRepository(
|
||||
authorizedClientService: OAuth2AuthorizedClientService?
|
||||
): OAuth2AuthorizedClientRepository {
|
||||
return AuthenticatedPrincipalOAuth2AuthorizedClientRepository(authorizedClientService)
|
||||
}
|
||||
|
||||
private fun googleClientRegistration(): ClientRegistration {
|
||||
return CommonOAuth2Provider.GOOGLE.getBuilder("google")
|
||||
.clientId("google-client-id")
|
||||
.clientSecret("google-client-secret")
|
||||
.build()
|
||||
}
|
||||
}
|
||||
----
|
||||
|
||||
.Xml
|
||||
[source,xml,role="secondary"]
|
||||
----
|
||||
<http auto-config="true">
|
||||
<intercept-url pattern="/**" access="authenticated"/>
|
||||
<oauth2-login authorized-client-repository-ref="authorizedClientRepository"/>
|
||||
</http>
|
||||
|
||||
<client-registrations>
|
||||
<client-registration registration-id="google"
|
||||
client-id="google-client-id"
|
||||
client-secret="google-client-secret"
|
||||
provider-id="google"/>
|
||||
</client-registrations>
|
||||
|
||||
<b:bean id="authorizedClientService"
|
||||
class="org.springframework.security.oauth2.client.InMemoryOAuth2AuthorizedClientService"
|
||||
autowire="constructor"/>
|
||||
|
||||
<b:bean id="authorizedClientRepository"
|
||||
class="org.springframework.security.oauth2.client.web.AuthenticatedPrincipalOAuth2AuthorizedClientRepository">
|
||||
<b:constructor-arg ref="authorizedClientService"/>
|
||||
</b:bean>
|
||||
----
|
||||
====
|
||||
|
||||
|
||||
[[oauth2login-advanced]]
|
||||
== Advanced Configuration
|
||||
= Advanced Configuration
|
||||
|
||||
`HttpSecurity.oauth2Login()` provides a number of configuration options for customizing OAuth 2.0 Login.
|
||||
The main configuration options are grouped into their protocol endpoint counterparts.
|
||||
|
|
@ -770,7 +194,7 @@ The following sections go into more detail on each of the configuration options
|
|||
|
||||
|
||||
[[oauth2login-advanced-login-page]]
|
||||
=== OAuth 2.0 Login Page
|
||||
== OAuth 2.0 Login Page
|
||||
|
||||
By default, the OAuth 2.0 Login Page is auto-generated by the `DefaultLoginPageGeneratingFilter`.
|
||||
The default login page shows each configured OAuth Client with its `ClientRegistration.clientName` as a link, which is capable of initiating the Authorization Request (or OAuth 2.0 Login).
|
||||
|
|
@ -865,7 +289,7 @@ The following line shows an example:
|
|||
|
||||
|
||||
[[oauth2login-advanced-redirection-endpoint]]
|
||||
=== Redirection Endpoint
|
||||
== Redirection Endpoint
|
||||
|
||||
The Redirection Endpoint is used by the Authorization Server for returning the Authorization Response (which contains the authorization credentials) to the client via the Resource Owner user-agent.
|
||||
|
||||
|
|
@ -956,7 +380,7 @@ return CommonOAuth2Provider.GOOGLE.getBuilder("google")
|
|||
|
||||
|
||||
[[oauth2login-advanced-userinfo-endpoint]]
|
||||
=== UserInfo Endpoint
|
||||
== UserInfo Endpoint
|
||||
|
||||
The UserInfo Endpoint includes a number of configuration options, as described in the following sub-sections:
|
||||
|
||||
|
|
@ -966,7 +390,7 @@ The UserInfo Endpoint includes a number of configuration options, as described i
|
|||
|
||||
|
||||
[[oauth2login-advanced-map-authorities]]
|
||||
==== Mapping User Authorities
|
||||
=== Mapping User Authorities
|
||||
|
||||
After the user successfully authenticates with the OAuth 2.0 Provider, the `OAuth2User.getAuthorities()` (or `OidcUser.getAuthorities()`) may be mapped to a new set of `GrantedAuthority` instances, which will be supplied to `OAuth2AuthenticationToken` when completing the authentication.
|
||||
|
||||
|
|
@ -980,7 +404,7 @@ There are a couple of options to choose from when mapping user authorities:
|
|||
|
||||
|
||||
[[oauth2login-advanced-map-authorities-grantedauthoritiesmapper]]
|
||||
===== Using a GrantedAuthoritiesMapper
|
||||
==== Using a GrantedAuthoritiesMapper
|
||||
|
||||
Provide an implementation of `GrantedAuthoritiesMapper` and configure it as shown in the following example:
|
||||
|
||||
|
|
@ -1126,7 +550,7 @@ class OAuth2LoginSecurityConfig : WebSecurityConfigurerAdapter() {
|
|||
====
|
||||
|
||||
[[oauth2login-advanced-map-authorities-oauth2userservice]]
|
||||
===== Delegation-based strategy with OAuth2UserService
|
||||
==== Delegation-based strategy with OAuth2UserService
|
||||
|
||||
This strategy is advanced compared to using a `GrantedAuthoritiesMapper`, however, it's also more flexible as it gives you access to the `OAuth2UserRequest` and `OAuth2User` (when using an OAuth 2.0 UserService) or `OidcUserRequest` and `OidcUser` (when using an OpenID Connect 1.0 UserService).
|
||||
|
||||
|
|
@ -1228,7 +652,7 @@ class OAuth2LoginSecurityConfig : WebSecurityConfigurerAdapter() {
|
|||
|
||||
|
||||
[[oauth2login-advanced-oauth2-user-service]]
|
||||
==== OAuth 2.0 UserService
|
||||
=== OAuth 2.0 UserService
|
||||
|
||||
`DefaultOAuth2UserService` is an implementation of an `OAuth2UserService` that supports standard OAuth 2.0 Provider's.
|
||||
|
||||
|
|
@ -1304,7 +728,7 @@ class OAuth2LoginSecurityConfig : WebSecurityConfigurerAdapter() {
|
|||
|
||||
|
||||
[[oauth2login-advanced-oidc-user-service]]
|
||||
==== OpenID Connect 1.0 UserService
|
||||
=== OpenID Connect 1.0 UserService
|
||||
|
||||
`OidcUserService` is an implementation of an `OAuth2UserService` that supports OpenID Connect 1.0 Provider's.
|
||||
|
||||
|
|
@ -1364,7 +788,7 @@ class OAuth2LoginSecurityConfig : WebSecurityConfigurerAdapter() {
|
|||
|
||||
|
||||
[[oauth2login-advanced-idtoken-verify]]
|
||||
=== ID Token Signature Verification
|
||||
== ID Token Signature Verification
|
||||
|
||||
OpenID Connect 1.0 Authentication introduces the https://openid.net/specs/openid-connect-core-1_0.html#IDToken[ID Token], which is a security token that contains Claims about the Authentication of an End-User by an Authorization Server when used by a Client.
|
||||
|
||||
|
|
@ -1409,7 +833,7 @@ If more than one `ClientRegistration` is configured for OpenID Connect 1.0 Authe
|
|||
|
||||
|
||||
[[oauth2login-advanced-oidc-logout]]
|
||||
=== OpenID Connect 1.0 Logout
|
||||
== OpenID Connect 1.0 Logout
|
||||
|
||||
OpenID Connect Session Management 1.0 allows the ability to log out the End-User at the Provider using the Client.
|
||||
One of the strategies available is https://openid.net/specs/openid-connect-session-1_0.html#RPLogout[RP-Initiated Logout].
|
||||
|
|
@ -0,0 +1,567 @@
|
|||
= Core Configuration
|
||||
|
||||
[[oauth2login-sample-boot]]
|
||||
== Spring Boot 2.x Sample
|
||||
|
||||
Spring Boot 2.x brings full auto-configuration capabilities for OAuth 2.0 Login.
|
||||
|
||||
This section shows how to configure the {gh-samples-url}/servlet/spring-boot/java/oauth2/login[*OAuth 2.0 Login sample*] using _Google_ as the _Authentication Provider_ and covers the following topics:
|
||||
|
||||
* <<oauth2login-sample-initial-setup,Initial setup>>
|
||||
* <<oauth2login-sample-redirect-uri,Setting the redirect URI>>
|
||||
* <<oauth2login-sample-application-config,Configure application.yml>>
|
||||
* <<oauth2login-sample-boot-application,Boot up the application>>
|
||||
|
||||
|
||||
[[oauth2login-sample-initial-setup]]
|
||||
=== Initial setup
|
||||
|
||||
To use Google's OAuth 2.0 authentication system for login, you must set up a project in the Google API Console to obtain OAuth 2.0 credentials.
|
||||
|
||||
NOTE: https://developers.google.com/identity/protocols/OpenIDConnect[Google's OAuth 2.0 implementation] for authentication conforms to the https://openid.net/connect/[OpenID Connect 1.0] specification and is https://openid.net/certification/[OpenID Certified].
|
||||
|
||||
Follow the instructions on the https://developers.google.com/identity/protocols/OpenIDConnect[OpenID Connect] page, starting in the section, "Setting up OAuth 2.0".
|
||||
|
||||
After completing the "Obtain OAuth 2.0 credentials" instructions, you should have a new OAuth Client with credentials consisting of a Client ID and a Client Secret.
|
||||
|
||||
|
||||
[[oauth2login-sample-redirect-uri]]
|
||||
=== Setting the redirect URI
|
||||
|
||||
The redirect URI is the path in the application that the end-user's user-agent is redirected back to after they have authenticated with Google and have granted access to the OAuth Client _(<<oauth2login-sample-initial-setup,created in the previous step>>)_ on the Consent page.
|
||||
|
||||
In the "Set a redirect URI" sub-section, ensure that the *Authorized redirect URIs* field is set to `http://localhost:8080/login/oauth2/code/google`.
|
||||
|
||||
TIP: The default redirect URI template is `+{baseUrl}/login/oauth2/code/{registrationId}+`.
|
||||
The *_registrationId_* is a unique identifier for the xref:servlet/oauth2/client/index.adoc#oauth2Client-client-registration[ClientRegistration].
|
||||
|
||||
IMPORTANT: If the OAuth Client is running behind a proxy server, it is recommended to check xref:features/exploits/http.adoc#http-proxy-server[Proxy Server Configuration] to ensure the application is correctly configured.
|
||||
Also, see the supported xref:servlet/oauth2/client/authorization-grants.adoc#oauth2Client-auth-code-redirect-uri[ `URI` template variables] for `redirect-uri`.
|
||||
|
||||
|
||||
[[oauth2login-sample-application-config]]
|
||||
=== Configure application.yml
|
||||
|
||||
Now that you have a new OAuth Client with Google, you need to configure the application to use the OAuth Client for the _authentication flow_.
|
||||
To do so:
|
||||
|
||||
. Go to `application.yml` and set the following configuration:
|
||||
+
|
||||
[source,yaml]
|
||||
----
|
||||
spring:
|
||||
security:
|
||||
oauth2:
|
||||
client:
|
||||
registration: <1>
|
||||
google: <2>
|
||||
client-id: google-client-id
|
||||
client-secret: google-client-secret
|
||||
----
|
||||
+
|
||||
.OAuth Client properties
|
||||
====
|
||||
<1> `spring.security.oauth2.client.registration` is the base property prefix for OAuth Client properties.
|
||||
<2> Following the base property prefix is the ID for the xref:servlet/oauth2/client/index.adoc#oauth2Client-client-registration[ClientRegistration], such as google.
|
||||
====
|
||||
|
||||
. Replace the values in the `client-id` and `client-secret` property with the OAuth 2.0 credentials you created earlier.
|
||||
|
||||
|
||||
[[oauth2login-sample-boot-application]]
|
||||
=== Boot up the application
|
||||
|
||||
Launch the Spring Boot 2.x sample and go to `http://localhost:8080`.
|
||||
You are then redirected to the default _auto-generated_ login page, which displays a link for Google.
|
||||
|
||||
Click on the Google link, and you are then redirected to Google for authentication.
|
||||
|
||||
After authenticating with your Google account credentials, the next page presented to you is the Consent screen.
|
||||
The Consent screen asks you to either allow or deny access to the OAuth Client you created earlier.
|
||||
Click *Allow* to authorize the OAuth Client to access your email address and basic profile information.
|
||||
|
||||
At this point, the OAuth Client retrieves your email address and basic profile information from the https://openid.net/specs/openid-connect-core-1_0.html#UserInfo[UserInfo Endpoint] and establishes an authenticated session.
|
||||
|
||||
|
||||
[[oauth2login-boot-property-mappings]]
|
||||
== Spring Boot 2.x Property Mappings
|
||||
|
||||
The following table outlines the mapping of the Spring Boot 2.x OAuth Client properties to the xref:servlet/oauth2/client/index.adoc#oauth2Client-client-registration[ClientRegistration] properties.
|
||||
|
||||
|===
|
||||
|Spring Boot 2.x |ClientRegistration
|
||||
|
||||
|`spring.security.oauth2.client.registration._[registrationId]_`
|
||||
|`registrationId`
|
||||
|
||||
|`spring.security.oauth2.client.registration._[registrationId]_.client-id`
|
||||
|`clientId`
|
||||
|
||||
|`spring.security.oauth2.client.registration._[registrationId]_.client-secret`
|
||||
|`clientSecret`
|
||||
|
||||
|`spring.security.oauth2.client.registration._[registrationId]_.client-authentication-method`
|
||||
|`clientAuthenticationMethod`
|
||||
|
||||
|`spring.security.oauth2.client.registration._[registrationId]_.authorization-grant-type`
|
||||
|`authorizationGrantType`
|
||||
|
||||
|`spring.security.oauth2.client.registration._[registrationId]_.redirect-uri`
|
||||
|`redirectUri`
|
||||
|
||||
|`spring.security.oauth2.client.registration._[registrationId]_.scope`
|
||||
|`scopes`
|
||||
|
||||
|`spring.security.oauth2.client.registration._[registrationId]_.client-name`
|
||||
|`clientName`
|
||||
|
||||
|`spring.security.oauth2.client.provider._[providerId]_.authorization-uri`
|
||||
|`providerDetails.authorizationUri`
|
||||
|
||||
|`spring.security.oauth2.client.provider._[providerId]_.token-uri`
|
||||
|`providerDetails.tokenUri`
|
||||
|
||||
|`spring.security.oauth2.client.provider._[providerId]_.jwk-set-uri`
|
||||
|`providerDetails.jwkSetUri`
|
||||
|
||||
|`spring.security.oauth2.client.provider._[providerId]_.issuer-uri`
|
||||
|`providerDetails.issuerUri`
|
||||
|
||||
|`spring.security.oauth2.client.provider._[providerId]_.user-info-uri`
|
||||
|`providerDetails.userInfoEndpoint.uri`
|
||||
|
||||
|`spring.security.oauth2.client.provider._[providerId]_.user-info-authentication-method`
|
||||
|`providerDetails.userInfoEndpoint.authenticationMethod`
|
||||
|
||||
|`spring.security.oauth2.client.provider._[providerId]_.user-name-attribute`
|
||||
|`providerDetails.userInfoEndpoint.userNameAttributeName`
|
||||
|===
|
||||
|
||||
[TIP]
|
||||
A `ClientRegistration` can be initially configured using discovery of an OpenID Connect Provider's https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfig[Configuration endpoint] or an Authorization Server's https://tools.ietf.org/html/rfc8414#section-3[Metadata endpoint], by specifying the `spring.security.oauth2.client.provider._[providerId]_.issuer-uri` property.
|
||||
|
||||
|
||||
[[oauth2login-common-oauth2-provider]]
|
||||
== CommonOAuth2Provider
|
||||
|
||||
`CommonOAuth2Provider` pre-defines a set of default client properties for a number of well known providers: Google, GitHub, Facebook, and Okta.
|
||||
|
||||
For example, the `authorization-uri`, `token-uri`, and `user-info-uri` do not change often for a Provider.
|
||||
Therefore, it makes sense to provide default values in order to reduce the required configuration.
|
||||
|
||||
As demonstrated previously, when we <<oauth2login-sample-application-config,configured a Google client>>, only the `client-id` and `client-secret` properties are required.
|
||||
|
||||
The following listing shows an example:
|
||||
|
||||
[source,yaml]
|
||||
----
|
||||
spring:
|
||||
security:
|
||||
oauth2:
|
||||
client:
|
||||
registration:
|
||||
google:
|
||||
client-id: google-client-id
|
||||
client-secret: google-client-secret
|
||||
----
|
||||
|
||||
[TIP]
|
||||
The auto-defaulting of client properties works seamlessly here because the `registrationId` (`google`) matches the `GOOGLE` `enum` (case-insensitive) in `CommonOAuth2Provider`.
|
||||
|
||||
For cases where you may want to specify a different `registrationId`, such as `google-login`, you can still leverage auto-defaulting of client properties by configuring the `provider` property.
|
||||
|
||||
The following listing shows an example:
|
||||
|
||||
[source,yaml]
|
||||
----
|
||||
spring:
|
||||
security:
|
||||
oauth2:
|
||||
client:
|
||||
registration:
|
||||
google-login: <1>
|
||||
provider: google <2>
|
||||
client-id: google-client-id
|
||||
client-secret: google-client-secret
|
||||
----
|
||||
<1> The `registrationId` is set to `google-login`.
|
||||
<2> The `provider` property is set to `google`, which will leverage the auto-defaulting of client properties set in `CommonOAuth2Provider.GOOGLE.getBuilder()`.
|
||||
|
||||
|
||||
[[oauth2login-custom-provider-properties]]
|
||||
== Configuring Custom Provider Properties
|
||||
|
||||
There are some OAuth 2.0 Providers that support multi-tenancy, which results in different protocol endpoints for each tenant (or sub-domain).
|
||||
|
||||
For example, an OAuth Client registered with Okta is assigned to a specific sub-domain and have their own protocol endpoints.
|
||||
|
||||
For these cases, Spring Boot 2.x provides the following base property for configuring custom provider properties: `spring.security.oauth2.client.provider._[providerId]_`.
|
||||
|
||||
The following listing shows an example:
|
||||
|
||||
[source,yaml]
|
||||
----
|
||||
spring:
|
||||
security:
|
||||
oauth2:
|
||||
client:
|
||||
registration:
|
||||
okta:
|
||||
client-id: okta-client-id
|
||||
client-secret: okta-client-secret
|
||||
provider:
|
||||
okta: <1>
|
||||
authorization-uri: https://your-subdomain.oktapreview.com/oauth2/v1/authorize
|
||||
token-uri: https://your-subdomain.oktapreview.com/oauth2/v1/token
|
||||
user-info-uri: https://your-subdomain.oktapreview.com/oauth2/v1/userinfo
|
||||
user-name-attribute: sub
|
||||
jwk-set-uri: https://your-subdomain.oktapreview.com/oauth2/v1/keys
|
||||
----
|
||||
|
||||
<1> The base property (`spring.security.oauth2.client.provider.okta`) allows for custom configuration of protocol endpoint locations.
|
||||
|
||||
|
||||
[[oauth2login-override-boot-autoconfig]]
|
||||
== Overriding Spring Boot 2.x Auto-configuration
|
||||
|
||||
The Spring Boot 2.x auto-configuration class for OAuth Client support is `OAuth2ClientAutoConfiguration`.
|
||||
|
||||
It performs the following tasks:
|
||||
|
||||
* Registers a `ClientRegistrationRepository` `@Bean` composed of `ClientRegistration`(s) from the configured OAuth Client properties.
|
||||
* Provides a `WebSecurityConfigurerAdapter` `@Configuration` and enables OAuth 2.0 Login through `httpSecurity.oauth2Login()`.
|
||||
|
||||
If you need to override the auto-configuration based on your specific requirements, you may do so in the following ways:
|
||||
|
||||
* <<oauth2login-register-clientregistrationrepository-bean,Register a ClientRegistrationRepository @Bean>>
|
||||
* <<oauth2login-provide-websecurityconfigureradapter,Provide a WebSecurityConfigurerAdapter>>
|
||||
* <<oauth2login-completely-override-autoconfiguration,Completely Override the Auto-configuration>>
|
||||
|
||||
|
||||
[[oauth2login-register-clientregistrationrepository-bean]]
|
||||
=== Register a ClientRegistrationRepository @Bean
|
||||
|
||||
The following example shows how to register a `ClientRegistrationRepository` `@Bean`:
|
||||
|
||||
====
|
||||
.Java
|
||||
[source,java,role="primary",attrs="-attributes"]
|
||||
----
|
||||
@Configuration
|
||||
public class OAuth2LoginConfig {
|
||||
|
||||
@Bean
|
||||
public ClientRegistrationRepository clientRegistrationRepository() {
|
||||
return new InMemoryClientRegistrationRepository(this.googleClientRegistration());
|
||||
}
|
||||
|
||||
private ClientRegistration googleClientRegistration() {
|
||||
return ClientRegistration.withRegistrationId("google")
|
||||
.clientId("google-client-id")
|
||||
.clientSecret("google-client-secret")
|
||||
.clientAuthenticationMethod(ClientAuthenticationMethod.CLIENT_SECRET_BASIC)
|
||||
.authorizationGrantType(AuthorizationGrantType.AUTHORIZATION_CODE)
|
||||
.redirectUri("{baseUrl}/login/oauth2/code/{registrationId}")
|
||||
.scope("openid", "profile", "email", "address", "phone")
|
||||
.authorizationUri("https://accounts.google.com/o/oauth2/v2/auth")
|
||||
.tokenUri("https://www.googleapis.com/oauth2/v4/token")
|
||||
.userInfoUri("https://www.googleapis.com/oauth2/v3/userinfo")
|
||||
.userNameAttributeName(IdTokenClaimNames.SUB)
|
||||
.jwkSetUri("https://www.googleapis.com/oauth2/v3/certs")
|
||||
.clientName("Google")
|
||||
.build();
|
||||
}
|
||||
}
|
||||
----
|
||||
|
||||
.Kotlin
|
||||
[source,kotlin,role="secondary",attrs="-attributes"]
|
||||
----
|
||||
@Configuration
|
||||
class OAuth2LoginConfig {
|
||||
@Bean
|
||||
fun clientRegistrationRepository(): ClientRegistrationRepository {
|
||||
return InMemoryClientRegistrationRepository(googleClientRegistration())
|
||||
}
|
||||
|
||||
private fun googleClientRegistration(): ClientRegistration {
|
||||
return ClientRegistration.withRegistrationId("google")
|
||||
.clientId("google-client-id")
|
||||
.clientSecret("google-client-secret")
|
||||
.clientAuthenticationMethod(ClientAuthenticationMethod.CLIENT_SECRET_BASIC)
|
||||
.authorizationGrantType(AuthorizationGrantType.AUTHORIZATION_CODE)
|
||||
.redirectUri("{baseUrl}/login/oauth2/code/{registrationId}")
|
||||
.scope("openid", "profile", "email", "address", "phone")
|
||||
.authorizationUri("https://accounts.google.com/o/oauth2/v2/auth")
|
||||
.tokenUri("https://www.googleapis.com/oauth2/v4/token")
|
||||
.userInfoUri("https://www.googleapis.com/oauth2/v3/userinfo")
|
||||
.userNameAttributeName(IdTokenClaimNames.SUB)
|
||||
.jwkSetUri("https://www.googleapis.com/oauth2/v3/certs")
|
||||
.clientName("Google")
|
||||
.build()
|
||||
}
|
||||
}
|
||||
----
|
||||
====
|
||||
|
||||
|
||||
[[oauth2login-provide-websecurityconfigureradapter]]
|
||||
=== Provide a WebSecurityConfigurerAdapter
|
||||
|
||||
The following example shows how to provide a `WebSecurityConfigurerAdapter` with `@EnableWebSecurity` and enable OAuth 2.0 login through `httpSecurity.oauth2Login()`:
|
||||
|
||||
.OAuth2 Login Configuration
|
||||
====
|
||||
.Java
|
||||
[source,java,role="primary"]
|
||||
----
|
||||
@EnableWebSecurity
|
||||
public class OAuth2LoginSecurityConfig extends WebSecurityConfigurerAdapter {
|
||||
|
||||
@Override
|
||||
protected void configure(HttpSecurity http) throws Exception {
|
||||
http
|
||||
.authorizeRequests(authorize -> authorize
|
||||
.anyRequest().authenticated()
|
||||
)
|
||||
.oauth2Login(withDefaults());
|
||||
}
|
||||
}
|
||||
----
|
||||
|
||||
.Kotlin
|
||||
[source,kotlin,role="secondary"]
|
||||
----
|
||||
@EnableWebSecurity
|
||||
class OAuth2LoginSecurityConfig : WebSecurityConfigurerAdapter() {
|
||||
|
||||
override fun configure(http: HttpSecurity) {
|
||||
http {
|
||||
authorizeRequests {
|
||||
authorize(anyRequest, authenticated)
|
||||
}
|
||||
oauth2Login { }
|
||||
}
|
||||
}
|
||||
}
|
||||
----
|
||||
====
|
||||
|
||||
|
||||
[[oauth2login-completely-override-autoconfiguration]]
|
||||
=== Completely Override the Auto-configuration
|
||||
|
||||
The following example shows how to completely override the auto-configuration by registering a `ClientRegistrationRepository` `@Bean` and providing a `WebSecurityConfigurerAdapter`.
|
||||
|
||||
.Overriding the auto-configuration
|
||||
====
|
||||
.Java
|
||||
[source,java,role="primary",attrs="-attributes"]
|
||||
----
|
||||
@Configuration
|
||||
public class OAuth2LoginConfig {
|
||||
|
||||
@EnableWebSecurity
|
||||
public static class OAuth2LoginSecurityConfig extends WebSecurityConfigurerAdapter {
|
||||
|
||||
@Override
|
||||
protected void configure(HttpSecurity http) throws Exception {
|
||||
http
|
||||
.authorizeRequests(authorize -> authorize
|
||||
.anyRequest().authenticated()
|
||||
)
|
||||
.oauth2Login(withDefaults());
|
||||
}
|
||||
}
|
||||
|
||||
@Bean
|
||||
public ClientRegistrationRepository clientRegistrationRepository() {
|
||||
return new InMemoryClientRegistrationRepository(this.googleClientRegistration());
|
||||
}
|
||||
|
||||
private ClientRegistration googleClientRegistration() {
|
||||
return ClientRegistration.withRegistrationId("google")
|
||||
.clientId("google-client-id")
|
||||
.clientSecret("google-client-secret")
|
||||
.clientAuthenticationMethod(ClientAuthenticationMethod.CLIENT_SECRET_BASIC)
|
||||
.authorizationGrantType(AuthorizationGrantType.AUTHORIZATION_CODE)
|
||||
.redirectUri("{baseUrl}/login/oauth2/code/{registrationId}")
|
||||
.scope("openid", "profile", "email", "address", "phone")
|
||||
.authorizationUri("https://accounts.google.com/o/oauth2/v2/auth")
|
||||
.tokenUri("https://www.googleapis.com/oauth2/v4/token")
|
||||
.userInfoUri("https://www.googleapis.com/oauth2/v3/userinfo")
|
||||
.userNameAttributeName(IdTokenClaimNames.SUB)
|
||||
.jwkSetUri("https://www.googleapis.com/oauth2/v3/certs")
|
||||
.clientName("Google")
|
||||
.build();
|
||||
}
|
||||
}
|
||||
----
|
||||
|
||||
.Kotlin
|
||||
[source,kotlin,role="secondary",attrs="-attributes"]
|
||||
----
|
||||
@Configuration
|
||||
class OAuth2LoginConfig {
|
||||
|
||||
@EnableWebSecurity
|
||||
class OAuth2LoginSecurityConfig: WebSecurityConfigurerAdapter() {
|
||||
|
||||
override fun configure(http: HttpSecurity) {
|
||||
http {
|
||||
authorizeRequests {
|
||||
authorize(anyRequest, authenticated)
|
||||
}
|
||||
oauth2Login { }
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@Bean
|
||||
fun clientRegistrationRepository(): ClientRegistrationRepository {
|
||||
return InMemoryClientRegistrationRepository(googleClientRegistration())
|
||||
}
|
||||
|
||||
private fun googleClientRegistration(): ClientRegistration {
|
||||
return ClientRegistration.withRegistrationId("google")
|
||||
.clientId("google-client-id")
|
||||
.clientSecret("google-client-secret")
|
||||
.clientAuthenticationMethod(ClientAuthenticationMethod.CLIENT_SECRET_BASIC)
|
||||
.authorizationGrantType(AuthorizationGrantType.AUTHORIZATION_CODE)
|
||||
.redirectUri("{baseUrl}/login/oauth2/code/{registrationId}")
|
||||
.scope("openid", "profile", "email", "address", "phone")
|
||||
.authorizationUri("https://accounts.google.com/o/oauth2/v2/auth")
|
||||
.tokenUri("https://www.googleapis.com/oauth2/v4/token")
|
||||
.userInfoUri("https://www.googleapis.com/oauth2/v3/userinfo")
|
||||
.userNameAttributeName(IdTokenClaimNames.SUB)
|
||||
.jwkSetUri("https://www.googleapis.com/oauth2/v3/certs")
|
||||
.clientName("Google")
|
||||
.build()
|
||||
}
|
||||
}
|
||||
----
|
||||
====
|
||||
|
||||
|
||||
[[oauth2login-javaconfig-wo-boot]]
|
||||
== Java Configuration without Spring Boot 2.x
|
||||
|
||||
If you are not able to use Spring Boot 2.x and would like to configure one of the pre-defined providers in `CommonOAuth2Provider` (for example, Google), apply the following configuration:
|
||||
|
||||
.OAuth2 Login Configuration
|
||||
====
|
||||
.Java
|
||||
[source,java,role="primary"]
|
||||
----
|
||||
@Configuration
|
||||
public class OAuth2LoginConfig {
|
||||
|
||||
@EnableWebSecurity
|
||||
public static class OAuth2LoginSecurityConfig extends WebSecurityConfigurerAdapter {
|
||||
|
||||
@Override
|
||||
protected void configure(HttpSecurity http) throws Exception {
|
||||
http
|
||||
.authorizeRequests(authorize -> authorize
|
||||
.anyRequest().authenticated()
|
||||
)
|
||||
.oauth2Login(withDefaults());
|
||||
}
|
||||
}
|
||||
|
||||
@Bean
|
||||
public ClientRegistrationRepository clientRegistrationRepository() {
|
||||
return new InMemoryClientRegistrationRepository(this.googleClientRegistration());
|
||||
}
|
||||
|
||||
@Bean
|
||||
public OAuth2AuthorizedClientService authorizedClientService(
|
||||
ClientRegistrationRepository clientRegistrationRepository) {
|
||||
return new InMemoryOAuth2AuthorizedClientService(clientRegistrationRepository);
|
||||
}
|
||||
|
||||
@Bean
|
||||
public OAuth2AuthorizedClientRepository authorizedClientRepository(
|
||||
OAuth2AuthorizedClientService authorizedClientService) {
|
||||
return new AuthenticatedPrincipalOAuth2AuthorizedClientRepository(authorizedClientService);
|
||||
}
|
||||
|
||||
private ClientRegistration googleClientRegistration() {
|
||||
return CommonOAuth2Provider.GOOGLE.getBuilder("google")
|
||||
.clientId("google-client-id")
|
||||
.clientSecret("google-client-secret")
|
||||
.build();
|
||||
}
|
||||
}
|
||||
----
|
||||
|
||||
.Kotlin
|
||||
[source,kotlin,role="secondary"]
|
||||
----
|
||||
@Configuration
|
||||
open class OAuth2LoginConfig {
|
||||
@EnableWebSecurity
|
||||
open class OAuth2LoginSecurityConfig : WebSecurityConfigurerAdapter() {
|
||||
override fun configure(http: HttpSecurity) {
|
||||
http {
|
||||
authorizeRequests {
|
||||
authorize(anyRequest, authenticated)
|
||||
}
|
||||
oauth2Login { }
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@Bean
|
||||
open fun clientRegistrationRepository(): ClientRegistrationRepository {
|
||||
return InMemoryClientRegistrationRepository(googleClientRegistration())
|
||||
}
|
||||
|
||||
@Bean
|
||||
open fun authorizedClientService(
|
||||
clientRegistrationRepository: ClientRegistrationRepository?
|
||||
): OAuth2AuthorizedClientService {
|
||||
return InMemoryOAuth2AuthorizedClientService(clientRegistrationRepository)
|
||||
}
|
||||
|
||||
@Bean
|
||||
open fun authorizedClientRepository(
|
||||
authorizedClientService: OAuth2AuthorizedClientService?
|
||||
): OAuth2AuthorizedClientRepository {
|
||||
return AuthenticatedPrincipalOAuth2AuthorizedClientRepository(authorizedClientService)
|
||||
}
|
||||
|
||||
private fun googleClientRegistration(): ClientRegistration {
|
||||
return CommonOAuth2Provider.GOOGLE.getBuilder("google")
|
||||
.clientId("google-client-id")
|
||||
.clientSecret("google-client-secret")
|
||||
.build()
|
||||
}
|
||||
}
|
||||
----
|
||||
|
||||
.Xml
|
||||
[source,xml,role="secondary"]
|
||||
----
|
||||
<http auto-config="true">
|
||||
<intercept-url pattern="/**" access="authenticated"/>
|
||||
<oauth2-login authorized-client-repository-ref="authorizedClientRepository"/>
|
||||
</http>
|
||||
|
||||
<client-registrations>
|
||||
<client-registration registration-id="google"
|
||||
client-id="google-client-id"
|
||||
client-secret="google-client-secret"
|
||||
provider-id="google"/>
|
||||
</client-registrations>
|
||||
|
||||
<b:bean id="authorizedClientService"
|
||||
class="org.springframework.security.oauth2.client.InMemoryOAuth2AuthorizedClientService"
|
||||
autowire="constructor"/>
|
||||
|
||||
<b:bean id="authorizedClientRepository"
|
||||
class="org.springframework.security.oauth2.client.web.AuthenticatedPrincipalOAuth2AuthorizedClientRepository">
|
||||
<b:constructor-arg ref="authorizedClientService"/>
|
||||
</b:bean>
|
||||
----
|
||||
====
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
[[oauth2login]]
|
||||
= OAuth 2.0 Login
|
||||
:page-section-summary-toc: 1
|
||||
|
||||
The OAuth 2.0 Login feature provides an application with the capability to have users log in to the application by using their existing account at an OAuth 2.0 Provider (e.g. GitHub) or OpenID Connect 1.0 Provider (such as Google).
|
||||
OAuth 2.0 Login implements the use cases: "Login with Google" or "Login with GitHub".
|
||||
|
||||
NOTE: OAuth 2.0 Login is implemented by using the *Authorization Code Grant*, as specified in the https://tools.ietf.org/html/rfc6749#section-4.1[OAuth 2.0 Authorization Framework] and https://openid.net/specs/openid-connect-core-1_0.html#CodeFlowAuth[OpenID Connect Core 1.0].
|
||||
|
|
@ -3,7 +3,7 @@
|
|||
:icondir: icons
|
||||
|
||||
Let's take a look at how SAML 2.0 Relying Party Authentication works within Spring Security.
|
||||
First, we see that, like xref:servlet/oauth2/oauth2-login.adoc[OAuth 2.0 Login], Spring Security takes the user to a third-party for performing authentication.
|
||||
First, we see that, like xref:servlet/oauth2/login/index.adoc[OAuth 2.0 Login], Spring Security takes the user to a third-party for performing authentication.
|
||||
It does this through a series of redirects.
|
||||
|
||||
.Redirecting to Asserting Party Authentication
|
||||
|
|
|
|||
Loading…
Reference in New Issue