":reactive:webflux:oauth2:login"
This commit is contained in:
Rob Winch
parent
e6f9b427f9
commit
0d1e1aba47
|
|
@ -1,6 +1,6 @@
|
||||||
plugins {
|
plugins {
|
||||||
id "checkstyle"
|
id "checkstyle"
|
||||||
id "io.spring.javaformat" version "0.0.23-SNAPSHOT"
|
id "io.spring.javaformat" version "0.0.24-SNAPSHOT"
|
||||||
id 'io.spring.nohttp' version '0.0.3.RELEASE'
|
id 'io.spring.nohttp' version '0.0.3.RELEASE'
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -4,60 +4,9 @@
|
||||||
"https://checkstyle.org/dtds/configuration_1_3.dtd">
|
"https://checkstyle.org/dtds/configuration_1_3.dtd">
|
||||||
<module name="com.puppycrawl.tools.checkstyle.Checker">
|
<module name="com.puppycrawl.tools.checkstyle.Checker">
|
||||||
<module name="io.spring.javaformat.checkstyle.SpringChecks">
|
<module name="io.spring.javaformat.checkstyle.SpringChecks">
|
||||||
<property name="excludes" value="com.puppycrawl.tools.checkstyle.checks.imports.AvoidStaticImportCheck" />
|
<property name="avoidStaticImportExcludes" value="org.springframework.security.test.web.reactive.server.SecurityMockServerConfigurers.*" />
|
||||||
</module>
|
</module>
|
||||||
<module name="com.puppycrawl.tools.checkstyle.TreeWalker">
|
<module name="com.puppycrawl.tools.checkstyle.TreeWalker">
|
||||||
<module name="com.puppycrawl.tools.checkstyle.checks.imports.AvoidStaticImportCheck">
|
|
||||||
<property name="excludes" value="
|
|
||||||
io.restassured.RestAssured.*,
|
|
||||||
org.assertj.core.api.Assertions.*,
|
|
||||||
org.assertj.core.api.Assumptions.*,
|
|
||||||
org.assertj.core.api.HamcrestCondition.*,
|
|
||||||
org.awaitility.Awaitility.*,
|
|
||||||
org.hamcrest.CoreMatchers.*,
|
|
||||||
org.hamcrest.Matchers.*,
|
|
||||||
org.junit.Assert.*,
|
|
||||||
org.junit.Assume.*,
|
|
||||||
org.junit.internal.matchers.ThrowableMessageMatcher.*,
|
|
||||||
org.junit.jupiter.api.Assertions.*,
|
|
||||||
org.junit.jupiter.api.Assumptions.*,
|
|
||||||
org.junit.jupiter.api.Assertions.*,
|
|
||||||
org.mockito.ArgumentMatchers.*,
|
|
||||||
org.mockito.BDDMockito.*,
|
|
||||||
org.mockito.Matchers.*,
|
|
||||||
org.mockito.Mockito.*,
|
|
||||||
org.springframework.boot.configurationprocessor.ConfigurationMetadataMatchers.*,
|
|
||||||
org.springframework.boot.configurationprocessor.TestCompiler.*,
|
|
||||||
org.springframework.boot.test.autoconfigure.AutoConfigurationImportedCondition.*,
|
|
||||||
org.springframework.hateoas.mvc.ControllerLinkBuilder.linkTo,
|
|
||||||
org.springframework.restdocs.headers.HeaderDocumentation.*,
|
|
||||||
org.springframework.restdocs.hypermedia.HypermediaDocumentation.*,
|
|
||||||
org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.*,
|
|
||||||
org.springframework.restdocs.mockmvc.RestDocumentationRequestBuilders.*,
|
|
||||||
org.springframework.restdocs.operation.preprocess.Preprocessors.*,
|
|
||||||
org.springframework.restdocs.payload.PayloadDocumentation.*,
|
|
||||||
org.springframework.restdocs.request.RequestDocumentation.*,
|
|
||||||
org.springframework.restdocs.restassured3.operation.preprocess.RestAssuredPreprocessors.*,
|
|
||||||
org.springframework.restdocs.restassured3.RestAssuredRestDocumentation.*,
|
|
||||||
org.springframework.restdocs.snippet.Attributes.*,
|
|
||||||
org.springframework.restdocs.webtestclient.WebTestClientRestDocumentation.*,
|
|
||||||
org.springframework.security.config.Customizer.*,
|
|
||||||
org.springframework.security.test.web.servlet.request.SecurityMockMvcRequestBuilders.*,
|
|
||||||
org.springframework.security.test.web.servlet.request.SecurityMockMvcRequestPostProcessors.*,
|
|
||||||
org.springframework.security.test.web.servlet.setup.SecurityMockMvcConfigurers.*,
|
|
||||||
org.springframework.test.web.client.ExpectedCount.*,
|
|
||||||
org.springframework.test.web.client.match.MockRestRequestMatchers.*,
|
|
||||||
org.springframework.test.web.client.response.MockRestResponseCreators.*,
|
|
||||||
org.springframework.test.web.servlet.request.MockMvcRequestBuilders.*,
|
|
||||||
org.springframework.test.web.servlet.result.MockMvcResultHandlers.*,
|
|
||||||
org.springframework.test.web.servlet.result.MockMvcResultMatchers.*,
|
|
||||||
org.springframework.test.web.servlet.setup.MockMvcBuilders.*,
|
|
||||||
org.springframework.web.reactive.function.BodyInserters.*,
|
|
||||||
org.springframework.web.reactive.function.server.RequestPredicates.*,
|
|
||||||
org.springframework.web.reactive.function.server.RouterFunctions.*,
|
|
||||||
org.springframework.ws.test.client.RequestMatchers.*,
|
|
||||||
org.springframework.ws.test.client.ResponseCreators.*" />
|
|
||||||
</module>
|
|
||||||
<module name="io.spring.javaformat.checkstyle.check.SpringJUnit5Check" />
|
<module name="io.spring.javaformat.checkstyle.check.SpringJUnit5Check" />
|
||||||
<module
|
<module
|
||||||
name="com.puppycrawl.tools.checkstyle.checks.imports.IllegalImportCheck">
|
name="com.puppycrawl.tools.checkstyle.checks.imports.IllegalImportCheck">
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,324 @@
|
||||||
|
NOTE: Spring Security Reactive OAuth only supports authentication using a user info endpoint.
|
||||||
|
Support for JWT validation will be added in https://github.com/spring-projects/spring-security/issues/5330[gh-5330].
|
||||||
|
|
||||||
|
= OAuth 2.0 Login Sample
|
||||||
|
|
||||||
|
This guide provides instructions on setting up the sample application with OAuth 2.0 Login using an OAuth 2.0 Provider or OpenID Connect 1.0 Provider.
|
||||||
|
The sample application uses Spring Boot 2.0.0.M6 and the `spring-security-oauth2-client` module which is new in Spring Security 5.0.
|
||||||
|
|
||||||
|
The following sections provide detailed steps for setting up OAuth 2.0 Login for these Providers:
|
||||||
|
|
||||||
|
* <<google-login, Google>>
|
||||||
|
* <<github-login, GitHub>>
|
||||||
|
* <<facebook-login, Facebook>>
|
||||||
|
* <<okta-login, Okta>>
|
||||||
|
|
||||||
|
[[google-login]]
|
||||||
|
== Login with Google
|
||||||
|
|
||||||
|
This section shows how to configure the sample application using Google as the Authentication Provider and covers the following topics:
|
||||||
|
|
||||||
|
* <<google-initial-setup,Initial setup>>
|
||||||
|
* <<google-redirect-uri,Setting the redirect URI>>
|
||||||
|
* <<google-application-config,Configure application.yml>>
|
||||||
|
* <<google-boot-application,Boot up the application>>
|
||||||
|
|
||||||
|
[[google-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.
|
||||||
|
|
||||||
|
[[google-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 _(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 `ClientRegistration`.
|
||||||
|
|
||||||
|
IMPORTANT: If the application is running behind a proxy server, it is recommended to check https://docs.spring.io/spring-security/site/docs/current/reference/htmlsingle/#appendix-proxy-server[Proxy Server Configuration] to ensure the application is correctly configured.
|
||||||
|
Also, see the supported https://docs.spring.io/spring-security/site/docs/current/reference/htmlsingle/#oauth2Client-auth-code-redirect-uri[`URI` template variables] for `redirect-uri`.
|
||||||
|
|
||||||
|
[[google-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 `ClientRegistration`, such as google.
|
||||||
|
====
|
||||||
|
|
||||||
|
. Replace the values in the `client-id` and `client-secret` property with the OAuth 2.0 credentials you created earlier.
|
||||||
|
|
||||||
|
[[google-boot-application]]
|
||||||
|
=== Boot up the application
|
||||||
|
|
||||||
|
Launch the Spring Boot 2.0 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.
|
||||||
|
|
||||||
|
[[github-login]]
|
||||||
|
== Login with GitHub
|
||||||
|
|
||||||
|
This section shows how to configure the sample application using GitHub as the Authentication Provider and covers the following topics:
|
||||||
|
|
||||||
|
* <<github-register-application,Register OAuth application>>
|
||||||
|
* <<github-application-config,Configure application.yml>>
|
||||||
|
* <<github-boot-application,Boot up the application>>
|
||||||
|
|
||||||
|
[[github-register-application]]
|
||||||
|
=== Register OAuth application
|
||||||
|
|
||||||
|
To use GitHub's OAuth 2.0 authentication system for login, you must https://github.com/settings/applications/new[Register a new OAuth application].
|
||||||
|
|
||||||
|
When registering the OAuth application, ensure the *Authorization callback URL* is set to `http://localhost:8080/login/oauth2/code/github`.
|
||||||
|
|
||||||
|
The Authorization callback URL (redirect URI) is the path in the application that the end-user's user-agent is redirected back to after they have authenticated with GitHub
|
||||||
|
and have granted access to the OAuth application on the _Authorize application_ page.
|
||||||
|
|
||||||
|
TIP: The default redirect URI template is `{baseUrl}/login/oauth2/code/{registrationId}`.
|
||||||
|
The *_registrationId_* is a unique identifier for the `ClientRegistration`.
|
||||||
|
|
||||||
|
IMPORTANT: If the application is running behind a proxy server, it is recommended to check https://docs.spring.io/spring-security/site/docs/current/reference/htmlsingle/#appendix-proxy-server[Proxy Server Configuration] to ensure the application is correctly configured.
|
||||||
|
Also, see the supported https://docs.spring.io/spring-security/site/docs/current/reference/htmlsingle/#oauth2Client-auth-code-redirect-uri[`URI` template variables] for `redirect-uri`.
|
||||||
|
|
||||||
|
[[github-application-config]]
|
||||||
|
=== Configure application.yml
|
||||||
|
|
||||||
|
Now that you have a new OAuth application with GitHub, you need to configure the application to use the OAuth application for the _authentication flow_. To do so:
|
||||||
|
|
||||||
|
. Go to `application.yml` and set the following configuration:
|
||||||
|
+
|
||||||
|
[source,yaml]
|
||||||
|
----
|
||||||
|
spring:
|
||||||
|
security:
|
||||||
|
oauth2:
|
||||||
|
client:
|
||||||
|
registration: <1>
|
||||||
|
github: <2>
|
||||||
|
client-id: github-client-id
|
||||||
|
client-secret: github-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 `ClientRegistration`, such as github.
|
||||||
|
====
|
||||||
|
|
||||||
|
. Replace the values in the `client-id` and `client-secret` property with the OAuth 2.0 credentials you created earlier.
|
||||||
|
|
||||||
|
[[github-boot-application]]
|
||||||
|
=== Boot up the application
|
||||||
|
|
||||||
|
Launch the Spring Boot 2.0 sample and go to `http://localhost:8080`.
|
||||||
|
You are then redirected to the default _auto-generated_ login page, which displays a link for GitHub.
|
||||||
|
|
||||||
|
Click on the GitHub link, and you are then redirected to GitHub for authentication.
|
||||||
|
|
||||||
|
After authenticating with your GitHub credentials, the next page presented to you is "Authorize application".
|
||||||
|
This page will ask you to *Authorize* the application you created in the previous step.
|
||||||
|
Click _Authorize application_ to allow the OAuth application to access your personal user data information.
|
||||||
|
|
||||||
|
At this point, the OAuth Client retrieves your personal user information
|
||||||
|
from the UserInfo Endpoint and establishes an authenticated session.
|
||||||
|
|
||||||
|
[TIP]
|
||||||
|
For detailed information returned from the UserInfo Endpoint, see the API documentation
|
||||||
|
for https://developer.github.com/v3/users/#get-the-authenticated-user["Get the authenticated user"].
|
||||||
|
|
||||||
|
[[facebook-login]]
|
||||||
|
== Login with Facebook
|
||||||
|
|
||||||
|
This section shows how to configure the sample application using Facebook as the Authentication Provider and covers the following topics:
|
||||||
|
|
||||||
|
* <<facebook-register-application,Add a New App>>
|
||||||
|
* <<facebook-application-config,Configure application.yml>>
|
||||||
|
* <<facebook-boot-application,Boot up the application>>
|
||||||
|
|
||||||
|
[[facebook-register-application]]
|
||||||
|
=== Add a New App
|
||||||
|
|
||||||
|
To use Facebook's OAuth 2.0 authentication system for login, you must first https://developers.facebook.com/apps[Add a New App].
|
||||||
|
|
||||||
|
Select "Create a New App" and then the "Create a New App ID" page is presented. Enter the Display Name, Contact Email, Category and then click "Create App ID".
|
||||||
|
|
||||||
|
NOTE: The selection for the _Category_ field is not relevant but it's a required field - select "Local".
|
||||||
|
|
||||||
|
The next page presented is "Product Setup". Click the "Get Started" button for the *Facebook Login* product.
|
||||||
|
In the left sidebar, under _Products -> Facebook Login_, select _Settings_.
|
||||||
|
|
||||||
|
For the field *Valid OAuth redirect URIs*, enter `http://localhost:8080/login/oauth2/code/facebook` then click _Save Changes_.
|
||||||
|
|
||||||
|
The OAuth redirect URI is the path in the application that the end-user's user-agent is redirected back to after they have authenticated with Facebook
|
||||||
|
and have granted access to the application on the _Authorize application_ page.
|
||||||
|
|
||||||
|
TIP: The default redirect URI template is `{baseUrl}/login/oauth2/code/{registrationId}`.
|
||||||
|
The *_registrationId_* is a unique identifier for the `ClientRegistration`.
|
||||||
|
|
||||||
|
IMPORTANT: If the application is running behind a proxy server, it is recommended to check https://docs.spring.io/spring-security/site/docs/current/reference/htmlsingle/#appendix-proxy-server[Proxy Server Configuration] to ensure the application is correctly configured.
|
||||||
|
Also, see the supported https://docs.spring.io/spring-security/site/docs/current/reference/htmlsingle/#oauth2Client-auth-code-redirect-uri[`URI` template variables] for `redirect-uri`.
|
||||||
|
|
||||||
|
[[facebook-application-config]]
|
||||||
|
=== Configure application.yml
|
||||||
|
|
||||||
|
Now that you have created a new application with Facebook, you need to configure the sample application to use the application for the _authentication flow_. To do so:
|
||||||
|
|
||||||
|
. Go to `application.yml` and set the following configuration:
|
||||||
|
+
|
||||||
|
[source,yaml]
|
||||||
|
----
|
||||||
|
spring:
|
||||||
|
security:
|
||||||
|
oauth2:
|
||||||
|
client:
|
||||||
|
registration: <1>
|
||||||
|
facebook: <2>
|
||||||
|
client-id: facebook-client-id
|
||||||
|
client-secret: facebook-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 `ClientRegistration`, such as facebook.
|
||||||
|
====
|
||||||
|
|
||||||
|
. Replace the values in the `client-id` and `client-secret` property with the OAuth 2.0 credentials you created earlier.
|
||||||
|
|
||||||
|
[[facebook-boot-application]]
|
||||||
|
=== Boot up the application
|
||||||
|
|
||||||
|
Launch the Spring Boot 2.0 sample and go to `http://localhost:8080`.
|
||||||
|
You are then redirected to the default _auto-generated_ login page, which displays a link for Facebook.
|
||||||
|
|
||||||
|
Click on the Facebook link, and you are then redirected to Facebook for authentication.
|
||||||
|
|
||||||
|
After authenticating with your Facebook credentials, the next page presented to you is "Authorize application".
|
||||||
|
This page will ask you to *Authorize* the application you created in the previous step.
|
||||||
|
Click _Authorize application_ to allow the OAuth application to access your _public profile_ and _email address_ information.
|
||||||
|
|
||||||
|
At this point, the OAuth Client retrieves your personal user information
|
||||||
|
from the UserInfo Endpoint and establishes an authenticated session.
|
||||||
|
|
||||||
|
[[okta-login]]
|
||||||
|
== Login with Okta
|
||||||
|
|
||||||
|
This section shows how to configure the sample application using Okta as the Authentication Provider and covers the following topics:
|
||||||
|
|
||||||
|
* <<okta-register-application,Add Application>>
|
||||||
|
* <<okta-assign-application-people,Assign Application to People>>
|
||||||
|
* <<okta-application-config,Configure application.yml>>
|
||||||
|
* <<okta-boot-application,Boot up the application>>
|
||||||
|
|
||||||
|
[[okta-register-application]]
|
||||||
|
=== Add Application
|
||||||
|
|
||||||
|
To use Okta's OAuth 2.0 authentication system for login, you must first https://www.okta.com/developer/signup[create a developer account].
|
||||||
|
|
||||||
|
Sign in to your account sub-domain and navigate to _Applications -> Applications_ and then select the "Add Application" button.
|
||||||
|
From the "Add Application" page, select the "Create New App" button and enter the following:
|
||||||
|
|
||||||
|
* *Platform:* Web
|
||||||
|
* *Sign on method:* OpenID Connect
|
||||||
|
|
||||||
|
Select the _Create_ button.
|
||||||
|
On the "General Settings" page, enter the Application Name (for example, "Spring Security Okta Login") and then select the _Next_ button.
|
||||||
|
On the "Configure OpenID Connect" page, enter `http://localhost:8080/login/oauth2/code/okta` for the field *Redirect URIs* and then select _Finish_.
|
||||||
|
|
||||||
|
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 Okta
|
||||||
|
and have granted access to the application on the _Authorize application_ page.
|
||||||
|
|
||||||
|
TIP: The default redirect URI template is `{baseUrl}/login/oauth2/code/{registrationId}`.
|
||||||
|
The *_registrationId_* is a unique identifier for the `ClientRegistration`.
|
||||||
|
|
||||||
|
IMPORTANT: If the application is running behind a proxy server, it is recommended to check https://docs.spring.io/spring-security/site/docs/current/reference/htmlsingle/#appendix-proxy-server[Proxy Server Configuration] to ensure the application is correctly configured.
|
||||||
|
Also, see the supported https://docs.spring.io/spring-security/site/docs/current/reference/htmlsingle/#oauth2Client-auth-code-redirect-uri[`URI` template variables] for `redirect-uri`.
|
||||||
|
|
||||||
|
[[okta-assign-application-people]]
|
||||||
|
=== Assign Application to People
|
||||||
|
|
||||||
|
From the "General" tab of the application, select the "Assignments" tab and then select the _Assign_ button.
|
||||||
|
Select _Assign to People_ and assign your account to the application. Then select the _Save and Go Back_ button.
|
||||||
|
|
||||||
|
[[okta-application-config]]
|
||||||
|
=== Configure application.yml
|
||||||
|
|
||||||
|
Now that you have created a new application with Okta, you need to configure the sample application to use the application for the _authentication flow_. To do so:
|
||||||
|
|
||||||
|
. Go to `application.yml` and set the following configuration:
|
||||||
|
+
|
||||||
|
[source,yaml]
|
||||||
|
----
|
||||||
|
spring:
|
||||||
|
security:
|
||||||
|
oauth2:
|
||||||
|
client:
|
||||||
|
registration: <1>
|
||||||
|
okta: <2>
|
||||||
|
client-id: okta-client-id
|
||||||
|
client-secret: okta-client-secret
|
||||||
|
provider: <3>
|
||||||
|
okta:
|
||||||
|
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
|
||||||
|
----
|
||||||
|
+
|
||||||
|
.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 `ClientRegistration`, such as okta.
|
||||||
|
<3> `spring.security.oauth2.client.provider` is the base property prefix for OAuth Provider properties.
|
||||||
|
====
|
||||||
|
|
||||||
|
. Replace the values in the `client-id` and `client-secret` property with the OAuth 2.0 credentials you created earlier.
|
||||||
|
As well, replace `https://your-subdomain.oktapreview.com` in `authorization-uri`, `token-uri`, `user-info-uri` and `jwk-set-uri` with the sub-domain assigned to your account during the registration process.
|
||||||
|
|
||||||
|
[[okta-boot-application]]
|
||||||
|
=== Boot up the application
|
||||||
|
|
||||||
|
Launch the Spring Boot 2.0 sample and go to `http://localhost:8080`.
|
||||||
|
You are then redirected to the default _auto-generated_ login page, which displays a link for Okta.
|
||||||
|
|
||||||
|
Click on the Okta link, and you are then redirected to Okta for authentication.
|
||||||
|
|
||||||
|
After authenticating with your Okta account credentials, 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.
|
||||||
|
|
@ -0,0 +1,27 @@
|
||||||
|
plugins {
|
||||||
|
id 'org.springframework.boot' version '2.2.6.RELEASE'
|
||||||
|
id 'io.spring.dependency-management' version '1.0.9.RELEASE'
|
||||||
|
id "nebula.integtest" version "7.0.9"
|
||||||
|
id 'java'
|
||||||
|
}
|
||||||
|
|
||||||
|
repositories {
|
||||||
|
mavenCentral()
|
||||||
|
maven { url "https://repo.spring.io/snapshot" }
|
||||||
|
}
|
||||||
|
|
||||||
|
dependencies {
|
||||||
|
implementation 'org.springframework.boot:spring-boot-starter-oauth2-client'
|
||||||
|
implementation 'org.springframework.boot:spring-boot-starter-thymeleaf'
|
||||||
|
implementation 'org.springframework.boot:spring-boot-starter-webflux'
|
||||||
|
implementation 'org.thymeleaf.extras:thymeleaf-extras-springsecurity5'
|
||||||
|
|
||||||
|
testImplementation 'org.springframework.boot:spring-boot-starter-test'
|
||||||
|
testImplementation 'org.springframework.security:spring-security-test'
|
||||||
|
|
||||||
|
integTestImplementation 'net.sourceforge.htmlunit:htmlunit'
|
||||||
|
}
|
||||||
|
|
||||||
|
tasks.withType(Test).configureEach {
|
||||||
|
useJUnitPlatform()
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
spring-security.version=5.4.0.BUILD-SNAPSHOT
|
||||||
Binary file not shown.
|
|
@ -0,0 +1,5 @@
|
||||||
|
distributionBase=GRADLE_USER_HOME
|
||||||
|
distributionPath=wrapper/dists
|
||||||
|
distributionUrl=https\://services.gradle.org/distributions/gradle-6.2.2-bin.zip
|
||||||
|
zipStoreBase=GRADLE_USER_HOME
|
||||||
|
zipStorePath=wrapper/dists
|
||||||
|
|
@ -0,0 +1,183 @@
|
||||||
|
#!/usr/bin/env sh
|
||||||
|
|
||||||
|
#
|
||||||
|
# Copyright 2015 the original author or authors.
|
||||||
|
#
|
||||||
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
# you may not use this file except in compliance with the License.
|
||||||
|
# You may obtain a copy of the License at
|
||||||
|
#
|
||||||
|
# https://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
#
|
||||||
|
# Unless required by applicable law or agreed to in writing, software
|
||||||
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
# See the License for the specific language governing permissions and
|
||||||
|
# limitations under the License.
|
||||||
|
#
|
||||||
|
|
||||||
|
##############################################################################
|
||||||
|
##
|
||||||
|
## Gradle start up script for UN*X
|
||||||
|
##
|
||||||
|
##############################################################################
|
||||||
|
|
||||||
|
# Attempt to set APP_HOME
|
||||||
|
# Resolve links: $0 may be a link
|
||||||
|
PRG="$0"
|
||||||
|
# Need this for relative symlinks.
|
||||||
|
while [ -h "$PRG" ] ; do
|
||||||
|
ls=`ls -ld "$PRG"`
|
||||||
|
link=`expr "$ls" : '.*-> \(.*\)$'`
|
||||||
|
if expr "$link" : '/.*' > /dev/null; then
|
||||||
|
PRG="$link"
|
||||||
|
else
|
||||||
|
PRG=`dirname "$PRG"`"/$link"
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
SAVED="`pwd`"
|
||||||
|
cd "`dirname \"$PRG\"`/" >/dev/null
|
||||||
|
APP_HOME="`pwd -P`"
|
||||||
|
cd "$SAVED" >/dev/null
|
||||||
|
|
||||||
|
APP_NAME="Gradle"
|
||||||
|
APP_BASE_NAME=`basename "$0"`
|
||||||
|
|
||||||
|
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
|
||||||
|
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
|
||||||
|
|
||||||
|
# Use the maximum available, or set MAX_FD != -1 to use that value.
|
||||||
|
MAX_FD="maximum"
|
||||||
|
|
||||||
|
warn () {
|
||||||
|
echo "$*"
|
||||||
|
}
|
||||||
|
|
||||||
|
die () {
|
||||||
|
echo
|
||||||
|
echo "$*"
|
||||||
|
echo
|
||||||
|
exit 1
|
||||||
|
}
|
||||||
|
|
||||||
|
# OS specific support (must be 'true' or 'false').
|
||||||
|
cygwin=false
|
||||||
|
msys=false
|
||||||
|
darwin=false
|
||||||
|
nonstop=false
|
||||||
|
case "`uname`" in
|
||||||
|
CYGWIN* )
|
||||||
|
cygwin=true
|
||||||
|
;;
|
||||||
|
Darwin* )
|
||||||
|
darwin=true
|
||||||
|
;;
|
||||||
|
MINGW* )
|
||||||
|
msys=true
|
||||||
|
;;
|
||||||
|
NONSTOP* )
|
||||||
|
nonstop=true
|
||||||
|
;;
|
||||||
|
esac
|
||||||
|
|
||||||
|
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
|
||||||
|
|
||||||
|
# Determine the Java command to use to start the JVM.
|
||||||
|
if [ -n "$JAVA_HOME" ] ; then
|
||||||
|
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
|
||||||
|
# IBM's JDK on AIX uses strange locations for the executables
|
||||||
|
JAVACMD="$JAVA_HOME/jre/sh/java"
|
||||||
|
else
|
||||||
|
JAVACMD="$JAVA_HOME/bin/java"
|
||||||
|
fi
|
||||||
|
if [ ! -x "$JAVACMD" ] ; then
|
||||||
|
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
|
||||||
|
|
||||||
|
Please set the JAVA_HOME variable in your environment to match the
|
||||||
|
location of your Java installation."
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
JAVACMD="java"
|
||||||
|
which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
|
||||||
|
|
||||||
|
Please set the JAVA_HOME variable in your environment to match the
|
||||||
|
location of your Java installation."
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Increase the maximum file descriptors if we can.
|
||||||
|
if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
|
||||||
|
MAX_FD_LIMIT=`ulimit -H -n`
|
||||||
|
if [ $? -eq 0 ] ; then
|
||||||
|
if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
|
||||||
|
MAX_FD="$MAX_FD_LIMIT"
|
||||||
|
fi
|
||||||
|
ulimit -n $MAX_FD
|
||||||
|
if [ $? -ne 0 ] ; then
|
||||||
|
warn "Could not set maximum file descriptor limit: $MAX_FD"
|
||||||
|
fi
|
||||||
|
else
|
||||||
|
warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
|
||||||
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
|
# For Darwin, add options to specify how the application appears in the dock
|
||||||
|
if $darwin; then
|
||||||
|
GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
|
||||||
|
fi
|
||||||
|
|
||||||
|
# For Cygwin or MSYS, switch paths to Windows format before running java
|
||||||
|
if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then
|
||||||
|
APP_HOME=`cygpath --path --mixed "$APP_HOME"`
|
||||||
|
CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
|
||||||
|
JAVACMD=`cygpath --unix "$JAVACMD"`
|
||||||
|
|
||||||
|
# We build the pattern for arguments to be converted via cygpath
|
||||||
|
ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
|
||||||
|
SEP=""
|
||||||
|
for dir in $ROOTDIRSRAW ; do
|
||||||
|
ROOTDIRS="$ROOTDIRS$SEP$dir"
|
||||||
|
SEP="|"
|
||||||
|
done
|
||||||
|
OURCYGPATTERN="(^($ROOTDIRS))"
|
||||||
|
# Add a user-defined pattern to the cygpath arguments
|
||||||
|
if [ "$GRADLE_CYGPATTERN" != "" ] ; then
|
||||||
|
OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
|
||||||
|
fi
|
||||||
|
# Now convert the arguments - kludge to limit ourselves to /bin/sh
|
||||||
|
i=0
|
||||||
|
for arg in "$@" ; do
|
||||||
|
CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
|
||||||
|
CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
|
||||||
|
|
||||||
|
if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
|
||||||
|
eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
|
||||||
|
else
|
||||||
|
eval `echo args$i`="\"$arg\""
|
||||||
|
fi
|
||||||
|
i=`expr $i + 1`
|
||||||
|
done
|
||||||
|
case $i in
|
||||||
|
0) set -- ;;
|
||||||
|
1) set -- "$args0" ;;
|
||||||
|
2) set -- "$args0" "$args1" ;;
|
||||||
|
3) set -- "$args0" "$args1" "$args2" ;;
|
||||||
|
4) set -- "$args0" "$args1" "$args2" "$args3" ;;
|
||||||
|
5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
|
||||||
|
6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
|
||||||
|
7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
|
||||||
|
8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
|
||||||
|
9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
|
||||||
|
esac
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Escape application args
|
||||||
|
save () {
|
||||||
|
for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
|
||||||
|
echo " "
|
||||||
|
}
|
||||||
|
APP_ARGS=`save "$@"`
|
||||||
|
|
||||||
|
# Collect all arguments for the java command, following the shell quoting and substitution rules
|
||||||
|
eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
|
||||||
|
|
||||||
|
exec "$JAVACMD" "$@"
|
||||||
|
|
@ -0,0 +1,103 @@
|
||||||
|
@rem
|
||||||
|
@rem Copyright 2015 the original author or authors.
|
||||||
|
@rem
|
||||||
|
@rem Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
@rem you may not use this file except in compliance with the License.
|
||||||
|
@rem You may obtain a copy of the License at
|
||||||
|
@rem
|
||||||
|
@rem https://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
@rem
|
||||||
|
@rem Unless required by applicable law or agreed to in writing, software
|
||||||
|
@rem distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
@rem See the License for the specific language governing permissions and
|
||||||
|
@rem limitations under the License.
|
||||||
|
@rem
|
||||||
|
|
||||||
|
@if "%DEBUG%" == "" @echo off
|
||||||
|
@rem ##########################################################################
|
||||||
|
@rem
|
||||||
|
@rem Gradle startup script for Windows
|
||||||
|
@rem
|
||||||
|
@rem ##########################################################################
|
||||||
|
|
||||||
|
@rem Set local scope for the variables with windows NT shell
|
||||||
|
if "%OS%"=="Windows_NT" setlocal
|
||||||
|
|
||||||
|
set DIRNAME=%~dp0
|
||||||
|
if "%DIRNAME%" == "" set DIRNAME=.
|
||||||
|
set APP_BASE_NAME=%~n0
|
||||||
|
set APP_HOME=%DIRNAME%
|
||||||
|
|
||||||
|
@rem Resolve any "." and ".." in APP_HOME to make it shorter.
|
||||||
|
for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
|
||||||
|
|
||||||
|
@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
|
||||||
|
set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
|
||||||
|
|
||||||
|
@rem Find java.exe
|
||||||
|
if defined JAVA_HOME goto findJavaFromJavaHome
|
||||||
|
|
||||||
|
set JAVA_EXE=java.exe
|
||||||
|
%JAVA_EXE% -version >NUL 2>&1
|
||||||
|
if "%ERRORLEVEL%" == "0" goto init
|
||||||
|
|
||||||
|
echo.
|
||||||
|
echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
|
||||||
|
echo.
|
||||||
|
echo Please set the JAVA_HOME variable in your environment to match the
|
||||||
|
echo location of your Java installation.
|
||||||
|
|
||||||
|
goto fail
|
||||||
|
|
||||||
|
:findJavaFromJavaHome
|
||||||
|
set JAVA_HOME=%JAVA_HOME:"=%
|
||||||
|
set JAVA_EXE=%JAVA_HOME%/bin/java.exe
|
||||||
|
|
||||||
|
if exist "%JAVA_EXE%" goto init
|
||||||
|
|
||||||
|
echo.
|
||||||
|
echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
|
||||||
|
echo.
|
||||||
|
echo Please set the JAVA_HOME variable in your environment to match the
|
||||||
|
echo location of your Java installation.
|
||||||
|
|
||||||
|
goto fail
|
||||||
|
|
||||||
|
:init
|
||||||
|
@rem Get command-line arguments, handling Windows variants
|
||||||
|
|
||||||
|
if not "%OS%" == "Windows_NT" goto win9xME_args
|
||||||
|
|
||||||
|
:win9xME_args
|
||||||
|
@rem Slurp the command line arguments.
|
||||||
|
set CMD_LINE_ARGS=
|
||||||
|
set _SKIP=2
|
||||||
|
|
||||||
|
:win9xME_args_slurp
|
||||||
|
if "x%~1" == "x" goto execute
|
||||||
|
|
||||||
|
set CMD_LINE_ARGS=%*
|
||||||
|
|
||||||
|
:execute
|
||||||
|
@rem Setup the command line
|
||||||
|
|
||||||
|
set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
|
||||||
|
|
||||||
|
@rem Execute Gradle
|
||||||
|
"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS%
|
||||||
|
|
||||||
|
:end
|
||||||
|
@rem End local scope for the variables with windows NT shell
|
||||||
|
if "%ERRORLEVEL%"=="0" goto mainEnd
|
||||||
|
|
||||||
|
:fail
|
||||||
|
rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
|
||||||
|
rem the _cmd.exe /c_ return code!
|
||||||
|
if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
|
||||||
|
exit /b 1
|
||||||
|
|
||||||
|
:mainEnd
|
||||||
|
if "%OS%"=="Windows_NT" endlocal
|
||||||
|
|
||||||
|
:omega
|
||||||
|
|
@ -0,0 +1 @@
|
||||||
|
|
||||||
|
|
@ -0,0 +1,73 @@
|
||||||
|
/*
|
||||||
|
* Copyright 2020 the original author or authors.
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* https://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*/
|
||||||
|
package example;
|
||||||
|
|
||||||
|
import org.junit.jupiter.api.Test;
|
||||||
|
|
||||||
|
import org.springframework.beans.factory.annotation.Autowired;
|
||||||
|
import org.springframework.boot.test.autoconfigure.web.reactive.AutoConfigureWebTestClient;
|
||||||
|
import org.springframework.boot.test.context.SpringBootTest;
|
||||||
|
import org.springframework.boot.test.context.TestConfiguration;
|
||||||
|
import org.springframework.context.annotation.Bean;
|
||||||
|
import org.springframework.security.oauth2.client.registration.ReactiveClientRegistrationRepository;
|
||||||
|
import org.springframework.security.oauth2.client.web.server.ServerOAuth2AuthorizedClientRepository;
|
||||||
|
import org.springframework.security.oauth2.client.web.server.WebSessionServerOAuth2AuthorizedClientRepository;
|
||||||
|
import org.springframework.test.web.reactive.server.WebTestClient;
|
||||||
|
|
||||||
|
import static org.hamcrest.CoreMatchers.containsString;
|
||||||
|
import static org.springframework.security.test.web.reactive.server.SecurityMockServerConfigurers.mockOAuth2Login;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Tests for {@link ReactiveOAuth2LoginApplication}.
|
||||||
|
*
|
||||||
|
* @author Rob Winch
|
||||||
|
*/
|
||||||
|
@SpringBootTest
|
||||||
|
@AutoConfigureWebTestClient
|
||||||
|
public class OAuth2LoginApplicationTests {
|
||||||
|
|
||||||
|
@Autowired
|
||||||
|
WebTestClient test;
|
||||||
|
|
||||||
|
@Autowired
|
||||||
|
ReactiveClientRegistrationRepository clientRegistrationRepository;
|
||||||
|
|
||||||
|
@Test
|
||||||
|
void requestWhenMockOidcLoginThenIndex() {
|
||||||
|
// @formatter:off
|
||||||
|
this.clientRegistrationRepository.findByRegistrationId("github")
|
||||||
|
.map((clientRegistration) ->
|
||||||
|
this.test.mutateWith(mockOAuth2Login().clientRegistration(clientRegistration))
|
||||||
|
.get()
|
||||||
|
.uri("/")
|
||||||
|
.exchange()
|
||||||
|
.expectBody(String.class).value(containsString("GitHub"))
|
||||||
|
)
|
||||||
|
.block();
|
||||||
|
// @formatter:on
|
||||||
|
}
|
||||||
|
|
||||||
|
@TestConfiguration
|
||||||
|
static class AuthorizedClient {
|
||||||
|
|
||||||
|
@Bean
|
||||||
|
ServerOAuth2AuthorizedClientRepository authorizedClientRepository() {
|
||||||
|
return new WebSessionServerOAuth2AuthorizedClientRepository();
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,44 @@
|
||||||
|
/*
|
||||||
|
* Copyright 2020 the original author or authors.
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* https://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package example;
|
||||||
|
|
||||||
|
import org.springframework.security.core.annotation.AuthenticationPrincipal;
|
||||||
|
import org.springframework.security.oauth2.client.OAuth2AuthorizedClient;
|
||||||
|
import org.springframework.security.oauth2.client.annotation.RegisteredOAuth2AuthorizedClient;
|
||||||
|
import org.springframework.security.oauth2.core.user.OAuth2User;
|
||||||
|
import org.springframework.stereotype.Controller;
|
||||||
|
import org.springframework.ui.Model;
|
||||||
|
import org.springframework.web.bind.annotation.GetMapping;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Index controller.
|
||||||
|
*
|
||||||
|
* @author Rob Winch
|
||||||
|
*/
|
||||||
|
@Controller
|
||||||
|
public class OAuth2LoginController {
|
||||||
|
|
||||||
|
@GetMapping("/")
|
||||||
|
public String index(Model model, @RegisteredOAuth2AuthorizedClient OAuth2AuthorizedClient authorizedClient,
|
||||||
|
@AuthenticationPrincipal OAuth2User oauth2User) {
|
||||||
|
model.addAttribute("userName", oauth2User.getName());
|
||||||
|
model.addAttribute("clientName", authorizedClient.getClientRegistration().getClientName());
|
||||||
|
model.addAttribute("userAttributes", oauth2User.getAttributes());
|
||||||
|
return "index";
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,33 @@
|
||||||
|
/*
|
||||||
|
* Copyright 2020 the original author or authors.
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* https://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*/
|
||||||
|
package example;
|
||||||
|
|
||||||
|
import org.springframework.boot.SpringApplication;
|
||||||
|
import org.springframework.boot.autoconfigure.SpringBootApplication;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A reactive OAuth2 Log in application.
|
||||||
|
*
|
||||||
|
* @author Rob Winch
|
||||||
|
*/
|
||||||
|
@SpringBootApplication
|
||||||
|
public class ReactiveOAuth2LoginApplication {
|
||||||
|
|
||||||
|
public static void main(String[] args) {
|
||||||
|
SpringApplication.run(ReactiveOAuth2LoginApplication.class, args);
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,35 @@
|
||||||
|
server:
|
||||||
|
port: 8080
|
||||||
|
|
||||||
|
logging:
|
||||||
|
level:
|
||||||
|
root: INFO
|
||||||
|
org.springframework.web: INFO
|
||||||
|
org.springframework.security: INFO
|
||||||
|
# org.springframework.boot.autoconfigure: DEBUG
|
||||||
|
|
||||||
|
spring:
|
||||||
|
thymeleaf:
|
||||||
|
cache: false
|
||||||
|
security:
|
||||||
|
oauth2:
|
||||||
|
client:
|
||||||
|
registration:
|
||||||
|
google:
|
||||||
|
client-id: your-app-client-id
|
||||||
|
client-secret: your-app-client-secret
|
||||||
|
github:
|
||||||
|
client-id: your-app-client-id
|
||||||
|
client-secret: your-app-client-secret
|
||||||
|
facebook:
|
||||||
|
client-id: your-app-client-id
|
||||||
|
client-secret: your-app-client-secret
|
||||||
|
okta:
|
||||||
|
client-id: your-app-client-id
|
||||||
|
client-secret: your-app-client-secret
|
||||||
|
provider:
|
||||||
|
okta:
|
||||||
|
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
|
||||||
|
jwk-set-uri: https://your-subdomain.oktapreview.com/oauth2/v1/keys
|
||||||
|
|
@ -0,0 +1,51 @@
|
||||||
|
<!DOCTYPE html>
|
||||||
|
<!--
|
||||||
|
~ /*
|
||||||
|
~ * Copyright 2002-2018 the original author or authors.
|
||||||
|
~ *
|
||||||
|
~ * Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
~ * you may not use this file except in compliance with the License.
|
||||||
|
~ * You may obtain a copy of the License at
|
||||||
|
~ *
|
||||||
|
~ * https://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
~ *
|
||||||
|
~ * Unless required by applicable law or agreed to in writing, software
|
||||||
|
~ * distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
~ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
~ * See the License for the specific language governing permissions and
|
||||||
|
~ * limitations under the License.
|
||||||
|
~ */
|
||||||
|
~
|
||||||
|
-->
|
||||||
|
|
||||||
|
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:th="https://www.thymeleaf.org">
|
||||||
|
<head>
|
||||||
|
<title>Spring Security - OAuth 2.0 Login</title>
|
||||||
|
<meta charset="utf-8" />
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<div style="float: right" th:fragment="logout">
|
||||||
|
<div style="float:left">
|
||||||
|
<span style="font-weight:bold">User: </span><span th:text="${userName}"></span>
|
||||||
|
</div>
|
||||||
|
<div style="float:none"> </div>
|
||||||
|
<div style="float:right">
|
||||||
|
<a th:href="@{/logout}">Log Out</a>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<h1>OAuth 2.0 Login with Spring Security</h1>
|
||||||
|
<div>
|
||||||
|
You are successfully logged in <span style="font-weight:bold" th:text="${userName}"></span>
|
||||||
|
via the OAuth 2.0 Client <span style="font-weight:bold" th:text="${clientName}"></span>
|
||||||
|
</div>
|
||||||
|
<div> </div>
|
||||||
|
<div>
|
||||||
|
<span style="font-weight:bold">User Attributes:</span>
|
||||||
|
<ul>
|
||||||
|
<li th:each="userAttribute : ${userAttributes}">
|
||||||
|
<span style="font-weight:bold" th:text="${userAttribute.key}"></span>: <span th:text="${userAttribute.value}"></span>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
|
@ -0,0 +1,85 @@
|
||||||
|
/*
|
||||||
|
* Copyright 2020 the original author or authors.
|
||||||
|
*
|
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
* you may not use this file except in compliance with the License.
|
||||||
|
* You may obtain a copy of the License at
|
||||||
|
*
|
||||||
|
* https://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
*
|
||||||
|
* Unless required by applicable law or agreed to in writing, software
|
||||||
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
* See the License for the specific language governing permissions and
|
||||||
|
* limitations under the License.
|
||||||
|
*/
|
||||||
|
|
||||||
|
package example;
|
||||||
|
|
||||||
|
import org.junit.jupiter.api.BeforeEach;
|
||||||
|
import org.junit.jupiter.api.Test;
|
||||||
|
import org.mockito.Mock;
|
||||||
|
|
||||||
|
import org.springframework.beans.factory.annotation.Autowired;
|
||||||
|
import org.springframework.boot.test.autoconfigure.web.reactive.WebFluxTest;
|
||||||
|
import org.springframework.core.ReactiveAdapterRegistry;
|
||||||
|
import org.springframework.security.oauth2.client.registration.ReactiveClientRegistrationRepository;
|
||||||
|
import org.springframework.security.oauth2.client.web.reactive.result.method.annotation.OAuth2AuthorizedClientArgumentResolver;
|
||||||
|
import org.springframework.security.oauth2.client.web.server.ServerOAuth2AuthorizedClientRepository;
|
||||||
|
import org.springframework.security.oauth2.client.web.server.WebSessionServerOAuth2AuthorizedClientRepository;
|
||||||
|
import org.springframework.security.web.reactive.result.method.annotation.AuthenticationPrincipalArgumentResolver;
|
||||||
|
import org.springframework.security.web.server.context.SecurityContextServerWebExchangeWebFilter;
|
||||||
|
import org.springframework.test.web.reactive.server.WebTestClient;
|
||||||
|
import org.springframework.web.reactive.result.view.ViewResolver;
|
||||||
|
|
||||||
|
import static org.hamcrest.Matchers.containsString;
|
||||||
|
import static org.springframework.security.test.web.reactive.server.SecurityMockServerConfigurers.mockOAuth2Login;
|
||||||
|
import static org.springframework.security.test.web.reactive.server.SecurityMockServerConfigurers.springSecurity;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @author Josh Cummings
|
||||||
|
*/
|
||||||
|
@WebFluxTest(OAuth2LoginController.class)
|
||||||
|
public class OAuth2LoginControllerTests {
|
||||||
|
|
||||||
|
@Autowired
|
||||||
|
OAuth2LoginController controller;
|
||||||
|
|
||||||
|
@Autowired
|
||||||
|
ViewResolver viewResolver;
|
||||||
|
|
||||||
|
@Mock
|
||||||
|
ReactiveClientRegistrationRepository clientRegistrationRepository;
|
||||||
|
|
||||||
|
WebTestClient rest;
|
||||||
|
|
||||||
|
@BeforeEach
|
||||||
|
void setup() {
|
||||||
|
ServerOAuth2AuthorizedClientRepository authorizedClientRepository = new WebSessionServerOAuth2AuthorizedClientRepository();
|
||||||
|
|
||||||
|
// @formatter:off
|
||||||
|
this.rest = WebTestClient
|
||||||
|
.bindToController(this.controller)
|
||||||
|
.apply(springSecurity())
|
||||||
|
.webFilter(new SecurityContextServerWebExchangeWebFilter())
|
||||||
|
.argumentResolvers((c) -> {
|
||||||
|
c.addCustomResolver(new AuthenticationPrincipalArgumentResolver(new ReactiveAdapterRegistry()));
|
||||||
|
c.addCustomResolver(new OAuth2AuthorizedClientArgumentResolver(this.clientRegistrationRepository, authorizedClientRepository));
|
||||||
|
})
|
||||||
|
.viewResolvers((c) -> c.viewResolver(this.viewResolver))
|
||||||
|
.build();
|
||||||
|
// @formatter:on
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
void indexGreetsAuthenticatedUser() {
|
||||||
|
// @formatter:off
|
||||||
|
this.rest.mutateWith(mockOAuth2Login())
|
||||||
|
.get()
|
||||||
|
.uri("/")
|
||||||
|
.exchange()
|
||||||
|
.expectBody(String.class).value(containsString("user"));
|
||||||
|
// @formatter:on
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
|
@ -18,6 +18,7 @@ include ":reactive:webflux-fn:hello-security"
|
||||||
include ":reactive:rsocket:hello-security"
|
include ":reactive:rsocket:hello-security"
|
||||||
include ":reactive:webflux:hello"
|
include ":reactive:webflux:hello"
|
||||||
include ":reactive:webflux:hello-security-explicit"
|
include ":reactive:webflux:hello-security-explicit"
|
||||||
|
include ":reactive:webflux:oauth2:login"
|
||||||
include ":reactive:webflux:method"
|
include ":reactive:webflux:method"
|
||||||
include ":reactive:webflux:hello-security"
|
include ":reactive:webflux:hello-security"
|
||||||
include ":reactive:webflux:authentication:username-password:form"
|
include ":reactive:webflux:authentication:username-password:form"
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue