Una guida rapida all'uso di Keycloak con Spring Boot

1. Panoramica

In questo articolo, tratteremo le basi della configurazione di un server Keycloak, come collegarvi un'applicazione Spring Boot e come usarlo con Spring Security .

2. Cos'è Keycloak?

Keycloak è una soluzione open source per la gestione delle identità e degli accessi destinata alle applicazioni e ai servizi moderni.

Keycloak offre funzionalità come Single-Sign-On (SSO), Identity Brokering e Social Login, User Federation, Client Adapters, una Admin Console e una Account Management Console. Per saperne di più su Keycloak, visita la pagina ufficiale.

Nel nostro tutorial, utilizzeremo l'Admin Console di Keycloak per la configurazione e la connessione a Spring Boot utilizzando Keycloak Client Adapter.

3. Configurazione di un server Keycloak

3.1. Download e installazione di Keycloak

Ci sono diverse distribuzioni tra cui scegliere.

Tuttavia, in questo tutorial, utilizzeremo la versione standalone.

Scarichiamo la distribuzione del server autonomo Keycloak-11.0.2 dalla fonte ufficiale.

Dopo aver scaricato la distribuzione del server Standalone, possiamo decomprimere e avviare Keycloak dal terminale:

unzip keycloak-11.0.2.zip cd keycloak-11.0.2/bin ./standalone.sh -Djboss.socket.binding.port-offset=100

Dopo aver eseguito ./standalone.sh , Keycloak avvierà i suoi servizi. Quando vediamo una riga contenente Keycloak 11.0.2 (WildFly Core 12.0.3.Final) avviata , sapremo che il suo avvio è completo.

Ora apriamo un browser e visitiamo // localhost: 8180. Verremo reindirizzati a // localhost: 8180 / auth per creare un accesso amministrativo:

Creiamo un utente amministratore iniziale denominato initial1 con la password zaq1! QAZ . Facendo clic su Crea , vedremo un messaggio Creato dall'utente .

Ora possiamo procedere alla Console amministrativa. Nella pagina di accesso, inseriremo le credenziali dell'utente amministratore iniziale:

3.2. Creazione di un regno

Un accesso riuscito ci porterà alla console e ci aprirà il regno principale predefinito .

Qui ci concentreremo sulla creazione di un regno personalizzato.

Andiamo nell'angolo in alto a sinistra in alto per scoprire il pulsante Aggiungi realm :

Nella schermata successiva, aggiungiamo un nuovo regno chiamato SpringBootKeycloak :

Dopo aver fatto clic sul pulsante Crea , verrà creato un nuovo regno e verremo reindirizzati ad esso. Tutte le operazioni nelle prossime sezioni verranno eseguite in questo nuovo regno di SpringBootKeycloak .

3.3. Creazione di un cliente

Adesso andremo alla pagina Clienti. Come possiamo vedere nell'immagine qui sotto, Keycloak viene fornito con client già integrati :

Ma dobbiamo aggiungere un nuovo client alla nostra applicazione, quindi faremo clic su Crea . Chiameremo la nuova app di accesso client :

Nella schermata successiva, per questo tutorial, lasceremo tutti i valori predefiniti tranne il campo URI di reindirizzamento validi . Questo campo deve contenere gli URL dell'applicazione che utilizzeranno questo client per l'autenticazione :

Successivamente, creeremo un'applicazione Spring Boot in esecuzione sulla porta 8081 che utilizzerà questo client. Quindi abbiamo utilizzato un URL di reindirizzamento di // localhost: 8081 / * sopra.

3.4. Creazione di un ruolo e di un utente

Keycloak utilizza l'accesso basato sui ruoli. Pertanto, ogni utente deve avere un ruolo.

Per farlo, dobbiamo accedere alla pagina Ruoli :

Quindi, aggiungeremo il ruolo utente :

Now we've got a role that can be assigned to users, but there are no users yet. So let's go the Users page and add one:

We'll add a user named user1:

Once the user is created, a page with its details will be displayed:

We can now go to the Credentials tab. We'll be setting the initial password to [email protected]:

Finally, we'll navigate to the Role Mappings tab. We'll be assigning the user role to our user1:

4. Generating Access Tokens with Keycloak's API

Keycloak provides a REST API for generating and refreshing access tokens. We can easily use this API to create our own login page.

First, we need to acquire an access token from Keycloak by sending a POST request to this URL:

//localhost:8180/auth/realms/master/protocol/openid-connect/token

The request should have this JSON body:

{     'client_id': 'your_client_id', 'username': 'your_username', 'password': 'your_password', 'grant_type': 'password' }

In response, we'll get an access_token and a refresh_token.

The access token should be used in every request to a Keycloak-protected resource by simply placing it in the Authorization header:

headers: {     'Authorization': 'Bearer' + access_token }

Once the access token has expired, we can refresh it by sending a POST request to the same URL as above, but containing the refresh token instead of username and password:

{     'client_id': 'your_client_id', 'refresh_token': refresh_token_from_previous_request, 'grant_type': 'refresh_token' }

Keycloak will respond to this with a new access_token and refresh_token.

5. Creating a Spring Boot Application

5.1. Dependencies

The latest Spring Boot Keycloak Starter dependencies can be found on Maven Central.

The Keycloak Spring Boot adaptercapitalizes on Spring Boot’s auto-configuration, so all we need to do is add the Keycloak Spring Boot starter to our project.

Within the dependencies XML element, we need the following to run Keycloak with Spring Boot:

 org.keycloak keycloak-spring-boot-starter  

After the dependencies XML element, we need to specify dependencyManagement for Keycloak:

   org.keycloak.bom keycloak-adapter-bom 11.0.2 pom import   

The following embedded containers are supported now and don't require any extra dependencies if using Spring Boot Keycloak Starter:

  • Tomcat
  • Undertow
  • Jetty

5.2. Thymeleaf Web Pages

We're using Thymeleaf for our web pages.

We've got three pages:

  • external.html – an externally facing web page for the public
  • customers.html – an internally facing page that will have its access restricted to only authenticated users with the role user.
  • layout.html – a simple layout, consisting of two fragments, that is used for both the externally facing page and the internally facing page

The code for the Thymeleaf templates is available on Github.

5.3. Controller

The web controller maps the internal and external URLs to the appropriate Thymeleaf templates:

@GetMapping(path = "/") public String index() { return "external"; } @GetMapping(path = "/customers") public String customers(Principal principal, Model model) { addCustomers(); model.addAttribute("customers", customerDAO.findAll()); model.addAttribute("username", principal.getName()); return "customers"; }

For the path /customers, we're retrieving all customers from a repository and adding the result as an attribute to the Model. Later on, we iterate through the results in Thymeleaf.

To be able to display a username, we're injecting the Principal as well.

Note that we're using customer here just as raw data to display, and nothing more.

5.4. Keycloak Configuration

Here's the basic, mandatory configuration:

keycloak.auth-server-url=//localhost:8180/auth keycloak.realm=SpringBootKeycloak keycloak.resource=login-app keycloak.public-client=true 

As we recall, we started Keycloak on port 8180, hence the path specified in keycloak.auth-server-url. We enter the realm name we created in the Keycloak admin console.

The value we specify in keycloak.resource matches the client we named in the admin console.

Here are the security constraints we'll be using:

keycloak.security-constraints[0].authRoles[0]=user keycloak.security-constraints[0].securityCollections[0].patterns[0]=/customers/*

These constraints ensure that every request to /customers/* will only be authorized if the one requesting it is an authenticated user with the role user.

Additionally, we can define keycloak.principal-attribute as preferred_username so as to populate our controller's Principal with a proper user:

keycloak.principal-attribute=preferred_username

5.5. Demonstration

Now, we're ready to test our application. To run a Spring Boot application, we can start it easily through an IDE like Spring Tool Suite (STS) or run this command in the terminal:

mvn clean spring-boot:run

On visiting //localhost:8081 we see:

Now we click customers to enter the intranet, which is the location of sensitive information.

We can see that we've been redirected to authenticate through Keycloak to see if we're authorized to view this content:

Once we log in as user1, Keycloak will verify our authorization – that we have the user role – and we'll be redirected to the restricted customers page:

Now we've finished the set up of connecting Spring Boot with Keycloak and demonstrating how it works.

As we can see, the entire process of calling the Keycloak Authorization Server was handled seamlessly by Spring Boot for us. We did not have to call the Keycloak API to generate the Access Token ourselves, or even send the Authorization header explicitly in our request for protected resources.

Next, we'll be reviewing how to use Spring Security in conjunction with our existing application.

6. Spring Security

There is a Keycloak Spring Security Adapter, and it’s already included in our Spring Boot Keycloak Starter dependency. We'll now see how to integrate Spring Security with Keycloak.

6.1. Dependency

To use Spring Security with Spring Boot, we must add this dependency:

 org.springframework.boot spring-boot-starter-security 2.2.6.RELEASE 

The latest Spring Boot Starter Security release can be found on Maven Central.

6.2. Configuration Class

Keycloak provides a KeycloakWebSecurityConfigurerAdapter as a convenient base class for creating a WebSecurityConfigurer instance.

This is helpful because any application secured by Spring Security requires a configuration class that extends WebSecurityConfigurerAdapter:

@Configuration @EnableWebSecurity @ComponentScan(basePackageClasses = KeycloakSecurityComponents.class) class SecurityConfig extends KeycloakWebSecurityConfigurerAdapter { @Autowired public void configureGlobal( AuthenticationManagerBuilder auth) throws Exception { KeycloakAuthenticationProvider keycloakAuthenticationProvider = keycloakAuthenticationProvider(); keycloakAuthenticationProvider.setGrantedAuthoritiesMapper( new SimpleAuthorityMapper()); auth.authenticationProvider(keycloakAuthenticationProvider); } @Bean public KeycloakSpringBootConfigResolver KeycloakConfigResolver() { return new KeycloakSpringBootConfigResolver(); } @Bean @Override protected SessionAuthenticationStrategy sessionAuthenticationStrategy() { return new RegisterSessionAuthenticationStrategy( new SessionRegistryImpl()); } @Override protected void configure(HttpSecurity http) throws Exception { super.configure(http); http.authorizeRequests() .antMatchers("/customers*") .hasRole("user") .anyRequest() .permitAll(); } }

In the code above, the method configureGlobal() tasks the SimpleAuthorityMapper to make sure roles are not prefixed with ROLE_.

Another method, keycloakConfigResolver defines that we want to use the Spring Boot properties file support instead of the default keycloak.json.

Because we've set up the security constraints with Spring Security, we can remove or comment these security constraints we'd placed earlier in the properties file:

#keycloak.security-constraints[0].authRoles[0]=user #keycloak.security-constraints[0].securityCollections[0].patterns[0]=/customers/*

Now, after we authenticate, we'll be able to access the internal customers' page, same as we saw before.

7. Conclusion

In this tutorial, we’ve configured a Keycloak server and used it with a Spring Boot Application.

Abbiamo anche visto come configurare Spring Security e usarlo insieme a Keycloak. Una versione funzionante del codice mostrato in questo articolo è disponibile su Github.