Skip to content

Latest commit

 

History

History
119 lines (82 loc) · 5.49 KB

README.adoc

File metadata and controls

119 lines (82 loc) · 5.49 KB
Raw

Integration of Keycloak and Dropwizard

About

Summary

This project shows how Keycloak and Dropwizard can be used together. At the time I wrote this there was no open source integration of the two, so I set up this project.

To read this tutorial fully rendered, please visit: https://ahus1.github.io/keycloak-dropwizard-integration/tutorial.html.

Keycloak provides a standalone OAuth 2.0 and Open ID Connect server. It handles user credentials for your application, so you can focus on business requirements.

Dropwizard is a Java framework for developing ops-friendly, high-performance, REST-ful web services.

The versions 1.0.x and 2.0.x of this project showed alternative ways to integrate Keycloak’s client libraries with Dropwizard versions 1.x to 3.x. With Dropwizard version 4.x, Dropwizard upgraded from Java EE to Jakarta EE. As this would have required additional migration efforts which an unclear added value to users, those have been removed. They might be added in the future if there is co

How to use

The module keycloak-dropwizard is a ready-to-use Dropwizard module. The releases are available from Maven central.

The releases depend on a version of Dropwizard and Keycloak that was current at release time. To use a more recent release, please add them as an explicit dependency to your project, as this project will not release new versions on every minor or patch release of its dependencies.

As Keycloak removed some of its client adapters, the latest version of the Keycloak client libraries to use is 24.0.5.

Maven Central Build Status

  • Version 0.7.x is tested with Keycloak 1.9.x and Dropwizard 0.9.x

  • Version 0.8.x is tested with Keycloak 2.x.x and Dropwizard 0.9.x

  • Version 0.9.x is tested with Keycloak 2.x.x/3.x.x and Dropwizard 1.0.x

  • Version 1.0.x is tested with Keycloak 3.x.x and Dropwizard 1.1.x/1.2.x/1.3.x

  • Version 1.1.x/1.2.x is tested with Keycloak 4.x-21.x and Dropwizard 1.3.x/2.0.x/2.1.x

  • Version 2.x is tested with Keycloak 4.x-23.x and Dropwizard 3.0.x

  • Version 3.x is tested with Keycloak 23.x-25.x and Dropwizard 4.0.x

Warning

Starting with Dropwizard 2.0 and the included version of Jersey, a login performed during a POST for a form will not recover the contents of the POST. This is wired into Keycloak’s JettyAdapterSessionStore (that restores the content type and the parameters to the request), but Jersey’s InboundMessageContext that wants to read the information in the request’s header and the body. See the shouldLoginFromPost() test case for an example.
pom.xml
<dependencies>
  <dependency>
    <groupId>de.ahus1.keycloak.dropwizard</groupId>
    <artifactId>keycloak-dropwizard</artifactId>
    <version>x.x.x</version>
  </dependency>
</dependencies>

The most recent development version (based on the master branch on GitHub) is available from the Sonatype OSS Snapshot Repository. To use it, include the following repository in your pom.xml.

pom.xml
<repositories>
    <repository>
        <id>snapshots-repo</id>
        <url>https://oss.sonatype.org/content/repositories/snapshots</url>
        <releases><enabled>false</enabled></releases>
        <snapshots><enabled>true</enabled></snapshots>
    </repository>
</repositories>

Prerequisites

These examples need a local Keycloak instance with Realm test and user demo with password demo.

Download the Keycloak distribution matching your keycloak-dropwizard-integration version from http://keycloak.org and extract it to a subfolder keycloak-server of this directory. Then call keycloak-server.bat to import an already configured realm. Using this startup file the configuration will be reset every time you start Keycloak.

Parts

These examples will guide you through setting up Dropwizard and Keycloak in several configurations:

License

Copyright 2015-2023 Alexander Schwartz and the individual contributors.

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.