Skip to content

Commit

Permalink
Merge pull request #6 from mwllgr/master
Browse files Browse the repository at this point in the history
Upgrade to Keycloak 22.0.5
  • Loading branch information
p08dev authored Nov 9, 2023
2 parents 4ce3f58 + 47acd5b commit 7be998a
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 7 deletions.
24 changes: 22 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ To safeguard registration against bots, Keycloak has integration with Google reC

## Installation

Download the newest release JAR (or comile it yourself) and drop it into `your_keycloak_installation/providers`
Download the newest release JAR (or compile it yourself - see below) and drop it into `your_keycloak_installation/providers`

There are a few steps you need to perform in the Keycloak Admin Console. Click the Authentication left menu item and go to the Flows tab. Select the Registration flow from the drop down list on this page.

Expand All @@ -28,7 +28,7 @@ Authorizing Iframes

To show the hCaptcha you need to modify the registration template. You can find the files in your Keycloak installation under `themes/base/login/`. If you use the user profile preview (you start your Keycloak with the `-Dkeycloak.profile=preview` flag), you need to edit the `register-user-profile.ftl`, else the `register.ftl`. Add the following code beneith the reCaptcha code:

```
```html
<#if hcaptchaRequired??>
<div class="form-group">
<div class="${properties.kcInputWrapperClass!}">
Expand All @@ -46,5 +46,25 @@ In the last step you have to change the registration flow to the newly created o
Authentication Bindings
![Step 6](img/step-06.png)

## Compiling it yourself

Clone the repository:

```bash
git clone https://github.com/p08dev/keycloak-hcaptcha.git
```

Inside the repository, compile it using Maven with Java 17:

```bash
mvn clean compile package
```

You can instruct Maven to use a specific Java version by prepending the JAVA_HOME environment variable:

```bash
JAVA_HOME=/usr/lib/jvm/java-17-oracle/ mvn clean compile package
```

## © License
[MIT](LICENSE)
8 changes: 4 additions & 4 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@
<modelVersion>4.0.0</modelVersion>
<groupId>de.itrupp.p8</groupId>
<artifactId>keycloak-hcaptcha</artifactId>
<version>1.0.0</version>
<version>1.0.1</version>
<name>Registration Authenitcation Execution Provider for hCaptcha</name>
<description>hCaptcha protects your users' privacy, rewards websites and helps businesses annotate their data. It's a 'drop in' replacement for reCAPTCHA that you set up in minutes.</description>
<packaging>jar</packaging>

<properties>
<version.keycloak>21.0.1</version.keycloak>
<maven.compiler.source>11</maven.compiler.source>
<maven.compiler.target>11</maven.compiler.target>
<version.keycloak>22.0.5</version.keycloak>
<maven.compiler.source>17</maven.compiler.source>
<maven.compiler.target>17</maven.compiler.target>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
import org.keycloak.services.validation.Validation;
import org.keycloak.util.JsonSerialization;

import javax.ws.rs.core.MultivaluedMap;
import jakarta.ws.rs.core.MultivaluedMap;

import java.io.InputStream;
import java.util.ArrayList;
Expand Down

0 comments on commit 7be998a

Please sign in to comment.