security-jdbc-quickstart

Quarkus Elytron Security with JDBC Realm

This guide demonstrates how your Quarkus application can use a database to store your user identities.

Start the database

You need a database to store the user identities/roles. Here, we are using PostgreSQL. To ease the setup, we have provided a docker-compose.yml file which start a PostgreSQL container, bind the network ports and finally creates the users and their credentials by importing the import.sql file.

The database can be started using:

docker-compose up

Once the database is up you can start your Quarkus application.

Start the application

The application can be started using:

mvn quarkus:dev

Test the application

From the CLI

The application exposes 3 endpoints:

• /api/public
• /api/admin
• /api/users/me

You can try these endpoints with an http client (curl, HTTPie, etc). Here you have some examples to check the security configuration:

curl -i -X GET http://localhost:8080/api/public  # 'public'
curl -i -X GET http://localhost:8080/api/admin  # unauthorized
curl -i -X GET -u admin:password http://localhost:8080/api/admin # 'admin'
curl -i -X GET http://localhost:8080/api/users/me # 'unauthorized'
curl -i -X GET -u user:password http://localhost:8080/api/users/me # 'user'

NOTE: Stop the database using: docker-compose down; docker-compose rm

Integration testing

We have provided integration tests based on TestContainers to verify the security configuration in a JVM and native mode.

The test can be executed using:

# JVM mode
mvn test

# Native mode
mvn verify -Pnative

Running in native

You can compile the application into a native binary using:

mvn clean install -Pnative

Note: You need to have a proper GraalVM configuration to build a native binary.

and run with:

./target/security-jdbc-quickstart-1.0.0-SNAPSHOT-runner

NOTE: Don't forget to start the database.