ivangfr/okta-springboot

The goal of this project is to develop a straightforward Spring Boot REST API application, named simple-service, which utilizes Okta for authentication handling.

okta-springboot

The objective of this project is to develop a secure simple-service application using Spring Boot and integrate it with Okta for authentication and authorization.

Note: In the repository okta-springboot-react you can find a more complex example that involves:

• Implementation of a ReactJS front-end application and a Spring Boot back-end application, both secured by Okta;
• Enabling and creating Okta groups (a.k.a. ROLES of the applications).

Proof-of-Concepts & Articles

On ivangfr.github.io, I have compiled my Proof-of-Concepts (PoCs) and articles. You can easily search for the technology you are interested in by using the filter. Who knows, perhaps I have already implemented a PoC or written an article about what you are looking for.

Additional Readings

• [Medium] Implementing and Securing a Simple Spring Boot REST API with Okta
• [Medium] Implementing and Securing a Simple Spring Boot UI (Thymeleaf + RBAC) with Okta
• [Medium] Implementing and Securing a Spring Boot GraphQL API with Okta
• [Medium] Building a Single Spring Boot App with Keycloak or Okta as IdP: Introduction

Project Diagram

Application

• simple-service

  Spring Boot Web Java application offers a user interface (UI) that requires users to log in using their Okta accounts. After successful login, users can access and view both their public and private messages.

  Login	Index

  It also exposes the following endpoints:

  Endpoint	Description	Secured
  GET /api/private	Retrieve the private message. Only accessible by users that provide a Access Token issued by Okta	YES
  GET /api/public	Retrieve the public message	NO
  POST /api/callback/token	Used by Okta to return user's Access Token	NO
  GET /actuator/*	Used to expose operational information about the application	NO

Prerequisites

• Java 17+
• Okta account

Configure Okta

Access Developer Edition Account

• If you do not have a Developer Edition Account, you can create one at https://developer.okta.com/signup/
• If you already have, access https://developer.okta.com/login/

Access Okta Admin Dashboard

If you are in Okta Developer Dashboard home page, click Admin button on the top-right

The picture below is how Okta Admin Dashboard looks like

Add Application

• In the Okta Admin Dashboard main menu on the left, click Applications menu and then Applications sub-menu
• In the next page, click Create App Integration button
• Select OIDC - OpenID Connect as Sign on method and Web Application as Application type. Click Next button
• Enter the following values in the form
  • General Settings
    • App integration name: Simple Service
    • Grant type: besides Authorization Code that is already checked, check also Implicit (hybrid)
    • Sign-in redirect URIs: http://localhost:8080/login/oauth2/code/okta and http://localhost:8080/api/callback/token
    • Sign-out redirect URIs: http://localhost:8080
  • Assignments
    • Controlled access: Skip group assignment for now
• Click Save button
• The Client ID and Client Secret are generated.
• The Okta Domain can be obtained by clicking the button-menu present on the up-right corner of the screen.

Add Person

• In the Okta Admin Dashboard main menu on the left, click Directory menu and then People sub-menu
• In the next page, click Add person button
• Enter the following information
  • First name: Mario
  • Last name: Bros
  • Username: mario.bros@test.com
  • Primary email: mario.bros@test.com
  • Password: Set by admin
  • Set a strong password in the text-field that will appear
  • Uncheck the check-box that says "User must change password on first login"
• Click Save button

Assign Person to Application

• In the Okta Admin Dashboard main menu on the left, click Applications menu and then Applications sub-menu
• In the next page, click Assign Users to App button
• Select the Simple Service check-box in the Applications column and Mario Bros check-box in the People column. Click Next button to continue assignment process
• Click Confirm Assignments button

Fix Person username

Warning: if we don't do the fix, we will see the following error

{"state":"state","error":"server_error","error_description":"The 'sub' system claim could not be evaluated."}

• In the Okta Admin Dashboard main menu on the left, click Applications menu and then Applications sub-menu
• In Applications list whose status are ACTIVE, select Simple Service application
• Click Assignments tab
• Edit Mario Bros by clicking the pen icon
• Set mario.bros@test.com in the User Name text-field
• Click Save button

Start application

• Open a terminal and make sure you are in okta-springboot root folder

• Export the following environment variables. Those values were obtained while adding application in Okta.

  export OKTA_DOMAIN=...
  export OKTA_CLIENT_ID=...
  export OKTA_CLIENT_SECRET=...
  

• Running application using Maven

  ./mvnw clean spring-boot:run --projects simple-service
  

• Running application as a Docker container

  • Build Docker Image

    • JVM

      ./docker-build.sh
      

    • Native

      ./docker-build.sh native
      

  Environment Variables

  Environment Variable	Description
  OKTA_DOMAIN	Specify the Domain defined by Okta
  OKTA_CLIENT_ID	Specify the Client ID defined by Okta
  OKTA_CLIENT_SECRET	Specify the Client Secret defined by Okta

  • Start Docker Container

    docker run --rm --name simple-service -p 8080:8080 \
    -e OKTA_DOMAIN=${OKTA_DOMAIN} \
    -e OKTA_CLIENT_ID=${OKTA_CLIENT_ID} \
    -e OKTA_CLIENT_SECRET=${OKTA_CLIENT_SECRET} \
    ivanfranchin/simple-service:1.0.0
    

Application URLs

Application	Type	URL
simple-service	UI	http://localhost:8080
simple-service	Swagger	http://localhost:8080/swagger-ui.html

Getting Access Token

In order to access the simple-service secured endpoints, you must have a Access Token. Below are the steps to get it.

• In a terminal, create the following environment variables. Those values were obtained while adding application in Okta.

  OKTA_DOMAIN=...
  OKTA_CLIENT_ID=...
  

• Get Okta Access Token Url

  OKTA_ACCESS_TOKEN_URL="https://${OKTA_DOMAIN}/oauth2/default/v1/authorize?\
  client_id=${OKTA_CLIENT_ID}\
  &redirect_uri=http://localhost:8080/api/callback/token\
  &scope=openid\
  &response_type=token\
  &response_mode=form_post\
  &state=state\
  &nonce=myNonceValue"
  
  echo $OKTA_ACCESS_TOKEN_URL
  

• Copy the Okta Access Token Url from the previous step and paste it in a browser

• The Okta login page will appear. Enter the username & password of the person added at the step Configuring Okta > Add person and click Sign In button

• It will redirect to api/callback/token endpoint of simple-service and the Access token will be displayed, together with other information

  {
    "state": "state",
    "access_token": "eyJraWQiOiJyNFdY...",
    "token_type": "Bearer",
    "expires_in": "3600",
    "scope": "openid"
  }
  

  Note: In jwt.io, you can decode and verify the Access Token

Calling simple-service endpoints using curl

• GET api/public

  The api/public endpoint is not secured, so we can call it without any problem.

  curl -i http://localhost:8080/api/public
  

  It should return

  HTTP/1.1 200
  It's a public message.
  

• GET api/private without Access Token

  Try to call api/private endpoint without informing the Access Token.

  curl -i http://localhost:8080/api/private
  

  It should return

  HTTP/1.1 401
  

• GET api/private with Access Token

  First, get the access token as explained in Getting Access Token section. Then, create an environment variable for the access token

  ACCESS_TOKEN=...
  

  Call api/private endpoint informing the access token.

  curl -i http://localhost:8080/api/private -H "Authorization: Bearer $ACCESS_TOKEN"
  

  Response

  HTTP/1.1 200
  mario.bros@test.com, it's a private message.
  

Using simple-service Swagger

• Access http://localhost:8080/swagger-ui.html

• Get the access token as explained in Getting Access Token section.

• Click Authorize button. Paste the Access Token in the Value field. Then, click Authorize and Close to finalize.

• Done! You can now access the sensitive endpoints.

Shutdown

Go to the terminal where the application is running and press Ctrl+C

Running Test Cases

In a terminal and inside okta-springboot root folder, run the command below

./mvnw clean test --projects simple-service

Cleanup

Docker image

To remove the Docker images created by this project, go to terminal and, inside okta-springboot root folder, run the following script

./remove-docker-images.sh

Okta Configuration

Delete Person

• In the Okta Admin Dashboard main menu on the left, click Directory menu and then People sub-menu
• Click Mario Bros in the People list
• In Mario Bros profile, click More Actions multi-button and then Deactivate
• Confirm deactivation by clicking Deactivate button
• Still in Mario Bros profile, click Delete button
• Confirm deletion by clicking Delete button

Delete Application

• In the Okta Admin Dashboard main menu on the left, click Applications menu and then Applications sub-menu
• In Application list whose status is ACTIVE, click Simple Service's gear icon and then click Deactivate
• Confirm deactivation by clicking Deactivate Application button
• In Application list whose status is INACTIVE, click Simple Service's gear icon and then click Delete
• Confirm deletion by clicking Delete Application button