README.adoc

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:

Login with Google

This section shows how to configure the sample application using Google as the Authentication Provider and covers the following topics:

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
Google’s OAuth 2.0 implementation for authentication conforms to the OpenID Connect 1.0 specification and is OpenID Certified.

Follow the instructions on the 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.

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.

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:

  1. Go to application.yml and set the following configuration:

    spring:
      security:
        oauth2:
          client:
            registration:	(1)
              google:		(2)
                client-id: google-client-id
                client-secret: google-client-secret
    Example 1. 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.

  2. Replace the values in the client-id and client-secret property with the OAuth 2.0 credentials you created earlier.

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 UserInfo Endpoint and establishes an authenticated session.

Login with GitHub

This section shows how to configure the sample application using GitHub as the Authentication Provider and covers the following topics:

Register OAuth application

To use GitHub’s OAuth 2.0 authentication system for login, you must 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.

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:

  1. Go to application.yml and set the following configuration:

    spring:
      security:
        oauth2:
          client:
            registration:	(1)
              github:		(2)
                client-id: github-client-id
                client-secret: github-client-secret
    Example 2. 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.

  2. Replace the values in the client-id and client-secret property with the OAuth 2.0 credentials you created earlier.

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 "Get the authenticated user".

Login with Facebook

This section shows how to configure the sample application using Facebook as the Authentication Provider and covers the following topics:

Add a New App

To use Facebook’s OAuth 2.0 authentication system for login, you must first 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.

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:

  1. Go to application.yml and set the following configuration:

    spring:
      security:
        oauth2:
          client:
            registration:	(1)
              facebook:		(2)
                client-id: facebook-client-id
                client-secret: facebook-client-secret
    Example 3. 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.

  2. Replace the values in the client-id and client-secret property with the OAuth 2.0 credentials you created earlier.

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.

Login with Okta

This section shows how to configure the sample application using Okta as the Authentication Provider and covers the following topics:

Add Application

To use Okta’s OAuth 2.0 authentication system for login, you must first 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.

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.

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:

  1. Go to application.yml and set the following configuration:

    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
    Example 4. 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.

  2. 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.

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 UserInfo Endpoint and establishes an authenticated session.