springboot-keycloak-openldap

The goal of this project is to create a simple Spring Boot REST API, called simple-service, and secure it with Keycloak. Furthermore, the API users will be loaded into Keycloak from OpenLDAP server.

Note 1: In springboot-react-keycloak repository, we have implemented a movies-app using Keycloak (with PKCE). This application consists of two services: the backend that was implemented using Spring Boot and the frontend implemented with ReactJS.

Note 2: In docker-swarm-environment repository, it's shown how to deploy this project into a cluster of Docker Engines in swarm mode. Besides, we will be running a Keycloak cluster with more than one instance.

Project diagram

Application

simple-service

Spring Boot Web Java application that exposes the following endpoints:
- GET /api/public: it's a not secured endpoint, everybody can access it;
- GET /api/private: it's a secured endpoint, only accessible by users that provide a JWT access token issued by Keycloak and the token must contain the role USER;
- GET /actuator/*: they are not secured endpoint, used to expose operational information about the application.

Prerequisites

Start Environment

Open a terminal and inside springboot-keycloak-openldap root folder run
```
docker-compose up -d
```
Wait for Docker containers to be up and running. To check it, run
```
docker-compose ps
```

Import OpenLDAP Users

The LDIF file that we will use, springboot-keycloak-openldap/ldap/ldap-mycompany-com.ldif, contains a pre-defined structure for mycompany.com. Basically, it has 2 groups (developers and admin) and 4 users (Bill Gates, Steve Jobs, Mark Cuban and Ivan Franchin). Besides, it's defined that Bill Gates, Steve Jobs and Mark Cuban belong to developers group and Ivan Franchin belongs to admin group.

Bill Gates > username: bgates, password: 123
Steve Jobs > username: sjobs, password: 123
Mark Cuban > username: mcuban, password: 123
Ivan Franchin > username: ifranchin, password: 123

There are two ways to import those users: running a script or using phpldapadmin website

Running a script

In a terminal and inside springboot-keycloak-openldap root folder run
```
./import-openldap-users.sh
```

The command below can be used to check the users imported

ldapsearch -x -D "cn=admin,dc=mycompany,dc=com" \
  -w admin -H ldap://localhost:389 \
  -b "ou=users,dc=mycompany,dc=com" \
  -s sub "(uid=*)"

Using phpldapadmin website

Access https://localhost:6443

Login DN: cn=admin,dc=mycompany,dc=com
Password: admin

Import the file springboot-keycloak-openldap/ldap/ldap-mycompany-com.ldif
You should see a tree like the one shown in the picture below

Configure Keycloak

There are two ways: running a script or using Keycloak website

Running a script

In a terminal, make sure you are inside springboot-keycloak-openldap root folder
Run the script below to configure Keycloak for simple-service application
```
./init-keycloak.sh
```
It creates company-services realm, simple-service client, USER client role, ldap federation and the users bgates and sjobs with the role USER assigned.
Copy SIMPLE_SERVICE_CLIENT_SECRET value that is shown at the end of the script. It will be needed whenever we call Keycloak to get a JWT access token to access simple-service

Using Keycloak website

Login

Access http://localhost:8080/admin/
Login with the credentials
```
Username: admin
Password: admin
```

Create a new Realm

On the left menu, click the dropdown button that contains Master and then, click Create Realm button
Set company-services to the Realm name field and click Create button

Create a new Client

On the left menu, click Clients
Click Create client button
In General Settings
- Set simple-service to Client ID
- Click Next button
In Capability config
- Enable Client authentication toggle switch
- Click Save button
In Settings tab
- Set http://localhost:9080/* to Valid Redirect URIs
- Click Save button
In Credentials tab, you can find the secret generated for simple-service
In Roles tab
- Click Create Role button
- Set USER to Role Name
- Click Save button

LDAP Integration

On the left menu, click User federation
Click Add Ldap providers
Select Other for Vendor
Set ldap://openldap to Connection URL
Set cn=admin,dc=mycompany,dc=com to Bind DN
Set admin to Bind Credential
Select READ_ONLY to Edit Mode
Set ou=users,dc=mycompany,dc=com to Users DN
Set (gidnumber=500) to User LDAP Filter (filter just developers)
Click Test connection button, to check if the connection is OK
Click Test authentication button, to check if the authentication is OK
Click Save button

Configure users imported

On the left menu, click Users
In Search user field, type * and press Enter to view all users. 3 users should be shown
Edit user bgates by clicking its username link
In Role Mappings tab
- Click Assign role button
- Click Filter by Origin dropdown button and select simple-service
- Select USER role and click Assign button
- Now, bgates has the role USER of simple-service
Do the same for the user sjobs
Leave mcuban without it

Run simple-service using Maven

Open a new terminal and make sure you are in springboot-keycloak-openldap root folder

Start the application by running the following command

./mvnw clean spring-boot:run --projects simple-service -Dspring-boot.run.jvmArguments="-Dserver.port=9080"

Test using curl

Open a new terminal

Call the endpoint GET /api/public

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

It should return

HTTP/1.1 200
It is public.

Try to call the endpoint GET /api/private without authentication
```
curl -i http://localhost:9080/api/private
```
It should return
```
HTTP/1.1 401
```
Create an environment variable that contains the Client Secret generated by Keycloak to simple-service at Configure Keycloak step
```
SIMPLE_SERVICE_CLIENT_SECRET=...
```

Run the command below to get an access token for bgates user

BGATES_ACCESS_TOKEN=$(curl -s -X POST \
  "http://localhost:8080/realms/company-services/protocol/openid-connect/token" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "username=bgates" \
  -d "password=123" \
  -d "grant_type=password" \
  -d "client_secret=$SIMPLE_SERVICE_CLIENT_SECRET" \
  -d "client_id=simple-service" | jq -r .access_token)

Note: In jwt.io, you can decode and verify the JWT access token

Call the endpoint GET /api/private

curl -i http://localhost:9080/api/private -H "Authorization: Bearer $BGATES_ACCESS_TOKEN"

It should return

HTTP/1.1 200
bgates, it is private.

Run the command below to get an access token for mcuban user

MCUBAN_ACCESS_TOKEN=$(curl -s -X POST \
  "http://localhost:8080/realms/company-services/protocol/openid-connect/token" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "username=mcuban" \
  -d "password=123" \
  -d "grant_type=password" \
  -d "client_secret=$SIMPLE_SERVICE_CLIENT_SECRET" \
  -d "client_id=simple-service" | jq -r .access_token)

Try to call the endpoint GET /api/private

curl -i http://localhost:9080/api/private -H "Authorization: Bearer $MCUBAN_ACCESS_TOKEN"

As mcuban does not have the USER role, he cannot access this endpoint.

The endpoint return should be

HTTP/1.1 403
{"timestamp":"...","status":403,"error":"Forbidden","path":"/api/private"}

Go to Keycloak and add the role USER to the mcuban
Run the command mentioned in step 7) again to get a new access token for mcuban user
Call again the endpoint GET /api/private using the curl command presented in step 8

It should return
```
HTTP/1.1 200
mcuban, it is private.
```
The access token default expiration period is 5 minutes. So, wait for this time and, using the same access token, try to call the private endpoint.

It should return
```
HTTP/1.1 401
WWW-Authenticate: Bearer realm="company-services", error="invalid_token", error_description="Token is not active"
```

Test using Swagger

Access http://localhost:9080/swagger-ui.html
Click GET /api/public to open it. Then, click Try it out button and, finally, click Execute button

It should return
```
Code: 200
Response Body: It is public.
```
Now click GET /api/private secured endpoint. Let's try it without authentication. Then, click Try it out button and, finally, click Execute button

It should return
```
Code: 401
Details: Error: response status is 401
```
In order to access the private endpoint, you need an access token. So, open a terminal
Create an environment variable that contains the Client Secret generated by Keycloak to simple-service at Configure Keycloak step
```
SIMPLE_SERVICE_CLIENT_SECRET=...
```

Run the following commands

BGATES_ACCESS_TOKEN=$(curl -s -X POST \
  "http://localhost:8080/realms/company-services/protocol/openid-connect/token" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "username=bgates" \
  -d "password=123" \
  -d "grant_type=password" \
  -d "client_secret=$SIMPLE_SERVICE_CLIENT_SECRET" \
  -d "client_id=simple-service" | jq -r .access_token)
  
echo $BGATES_ACCESS_TOKEN

Copy the token generated and go back to Swagger
Click Authorize button and paste the access token in the Value field. Then, click Authorize button and, to finalize, click Close
Go to GET /api/private and call this endpoint again, now with authentication

It should return
```
Code: 200
Response Body: bgates, it is private.
```

Using client_id and client_secret to get access token

You can get an access token to simple-service using client_id and client_secret

Configuration

Access http://localhost:8080/admin/
Select company-services realm (if it's not already selected)
On the left menu, click Clients
Select simple-service client
In Settings tab
- Go to Capability config and check Service accounts roles checkbox
- Click Save button
In Service account roles tab
- Click service-account-simple-service link present in the info message
  
  "To manage detail and group mappings, click on the username service-account-simple-service"
- In Role mapping tab
  - Click Assign role button
  - Click Filter by Origin dropdown button and select simple-service
  - Select USER role and click Assign button
  - Now, service-account-simple-service has the role USER of simple-service

Test

Open a terminal
Create an environment variable that contains the Client Secret generated by Keycloak to simple-service at Configure Keycloak step
```
SIMPLE_SERVICE_CLIENT_SECRET=...
```

Run the following command

CLIENT_ACCESS_TOKEN=$(curl -s -X POST \
  "http://localhost:8080/realms/company-services/protocol/openid-connect/token" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials" \
  -d "client_secret=$SIMPLE_SERVICE_CLIENT_SECRET" \
  -d "client_id=simple-service" | jq -r .access_token)

Try to call the endpoint GET /api/private

curl -i http://localhost:9080/api/private -H "Authorization: Bearer $CLIENT_ACCESS_TOKEN"

It should return

HTTP/1.1 200
service-account-simple-service, it is private.

Running simple-service as a Docker container

In a terminal, make sure you are in springboot-keycloak-openldap root folder
Build Docker Image
- JVM
```
./docker-build.sh
```
- Native
```
./docker-build.sh native
```
Environment Variable Description

KEYCLOAK_HOST Specify host of the Keycloak to use (default localhost)

KEYCLOAK_PORT Specify port of the Keycloak to use (default 8080)

Environment Variable	Description
`KEYCLOAK_HOST`	Specify host of the `Keycloak` to use (default `localhost`)
`KEYCLOAK_PORT`	Specify port of the `Keycloak` to use (default `8080`)

Run Docker Container

docker run --rm --name simple-service \
  -p 9080:8080 \
  -e KEYCLOAK_HOST=keycloak \
  --network=springboot-keycloak-openldap_default \
  ivanfranchin/simple-service:1.0.0

Open a new terminal
Create an environment variable that contains the Client Secret generated by Keycloak to simple-service at Configure Keycloak step
```
SIMPLE_SERVICE_CLIENT_SECRET=...
```

Run the commands below to get an access token for bgates user

BGATES_TOKEN=$(
  docker run -t --rm --network springboot-keycloak-openldap_default alpine/curl:latest sh -c '
    curl -s -X POST http://keycloak:8080/realms/company-services/protocol/openid-connect/token \
      -H "Content-Type: application/x-www-form-urlencoded" \
      -d "username=bgates" \
      -d "password=123" \
      -d "grant_type=password" \
      -d "client_secret='$SIMPLE_SERVICE_CLIENT_SECRET'" \
      -d "client_id=simple-service"')

BGATES_ACCESS_TOKEN=$(echo $BGATES_TOKEN | jq -r .access_token)

Call the endpoint GET /api/private

curl -i http://localhost:9080/api/private -H "Authorization: Bearer $BGATES_ACCESS_TOKEN"

Shutdown

To stop simple-service application, go to the terminal where it is running and press Ctrl+C
To stop and remove docker-compose containers, network and volumes, go to a terminal and inside springboot-keycloak-openldap root folder, run the following command
```
docker-compose down -v
```

Cleanup

To remove the Docker image create by this project, go to a terminal and, inside springboot-keycloak-openldap root folder, run the following script

./remove-docker-images.sh

References

https://www.keycloak.org/docs/latest/server_admin/

nakunxuanviet/springboot-keycloak-openldap

springboot-keycloak-openldap

Project diagram

Application

simple-service

Prerequisites

Start Environment

Import OpenLDAP Users

Running a script

Using phpldapadmin website

Configure Keycloak

Running a script

Using Keycloak website

Login

Create a new Realm

Create a new Client

LDAP Integration

Configure users imported

Run simple-service using Maven

Test using curl

Test using Swagger

Using client_id and client_secret to get access token

Configuration

Test

Running simple-service as a Docker container

Shutdown

Cleanup

References