Keycloak-identiteetinhallintapalvelun käyttöönotto Spring Boot -sovelluksessa

Abstract

Opinnäytetyön tarkoituksena oli mahdollistaa asiakkaiden käyttämien autentikointipalveluiden integraatio toimeksiantaja Dicode Oy:n toimittamiin räätälöityihin verkkosovelluksiin. Tavoitteena oli, että asiakkaat voisivat käyttää nykyisiä käyttäjätunnuksiaan kirjautuessaan tilaamiinsa verkkosovelluksiin samalla, kun ylläpidon kontrolli pysyisi Dicodella. Tavoite oli mahdollista saavuttaa identiteetin- ja pääsynhallintapalvelu Keycloakin avulla, joka oli jo toimeksiantajan sisäisessä käytössä.

Keycloak pyrittiin kytkemään projektipohjaan niin, että tulevissa projekteissa Keycloakin käyttöönotto olisi helppoa, mutta toteutus pysyisi kuitenkin erillään jo olemassa olevasta autentikointitavasta. Tämä mahdollistaisi molempien tapojen rinnakkaiskäytön säilyttäen kuitenkin koodin selkeyden. Työ sisälsi myös muiden autentikointipalveluiden integrointiprosessin tutkimisen.

Opinnäytetyön lopputuloksena syntyi Spring Boot -perustaiseen projektipohjaan liitetty toiminnallisuus, joka mahdollistaa Keycloakin käytön niin paikallisessa kehitystyössä kuin tuotantoympäristössäkin. Paikallisesti toteutetun autentikointipalvelun integroinnin pohjalta valmistui myös ohjeistus, joka auttaa kehittäjiä integrointiprosessissa. Sen avulla Dicode pystyy vastaamaan tehokkaammin vaihtuviin tulevaisuuden asiakastarpeisiin.

Keycloakissa on laajasti konfigurointi- ja kustomointimahdollisuuksia, joista käsitellään opinnäytetyöhön tehdyissä tutkimuksissa vain pieni osa. Jatkokehitykseen ehdotetaan muun muassa Keycloak-kirjautumisnäkymän ulkoasun yhtenäistämistä asiakassovelluksen teeman mukaiseksi, jolloin kirjautumisnäkymä sulautuisi saumattomasti osaksi toteutettua sovellusta.

The objective of this thesis was to enable integration of Dicode’s customers’ existing identity management systems to software tailor-made by Dicode. The purpose was to allow customers to use their existing accounts when logging in to any application ordered from Dicode, while keeping user management under Dicode’s control.

The chosen approach, identity and access management system Keycloak, was already used internally by Dicode. The goal was to connect Keycloak to a Spring Boot-based project template in a way that allows developers to easily enable it in upcoming projects on demand without making it mandatory.

As the primary outcome of this thesis process, Keycloak was connected to a Spring Boot-based project template allowing Keycloak to be used in upcoming projects in local development and in production. In addition to this, instructions were created to help developers with the process of integrating identity management systems.

Keycloak offers a wide range of configuration and customization possibilities. One recommendation would be to utilise the ability to customise Keycloak’s login screen to match the layout and colour scheme of the connected application for a seamless connection.