Herdo / keycloak-remember-me-authenticator

Custom authenticator for remembering the user logging in, even if no "Remember me" flag is set. Useful in combination with identity providers, which don't allow to set the "Remember me" flag.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

keycloak-remember-me-authenticator

Custom authenticator for remembering the user logging in, even if no "Remember me" flag is set. Useful in combination with identity providers, which don't allow to set the "Remember me" flag.

Compatibility

Since this package implements internal Keycloak SPIs, there's a chance this extension breaks with a new major version of Keycloak.
See compatibility list below to find the version that suits your Keycloak version.

Keycloak Version Extension Version
= 17.0.0 Verified, requires modified pom and compilation.
< 20.0.0 ⚠️ Not verified, use at your own risk.
>= 20.* and <= 24.* 1.0.0
> 24 ⚠️ Not verified, use at your own risk.

Usage

Keycloak as Docker container

  1. With Keycloak running as Docker container, you'll want to build your own image.
  2. When you have your basic Dockerfile prepared, make the following adjustments:
# Install "Remember Me" authenticator
ADD --chown=keycloak:keycloak https://github.com/Herdo/keycloak-remember-me-authenticator/releases/download/v1.0.0/keycloak-remember-me-authenticator-1.0.0.jar /opt/keycloak/providers/keycloak-remember-me-authenticator-1.0.0.jar

# Build image
RUN /opt/keycloak/bin/kc.sh build
  1. Start your custom Keycloak image as a new container.

Configuration for IdPs

  1. Open your Keycloaks admin interface and login.
  2. Navigate to Authentication.
  3. Create a new Basic flow called post idp login remember me.
  4. Add Remember Me Authenticator as Required step.
  5. Navigate to Identity providers and select your provider you want to enable the "Remember Me" function for.
  6. For the Post login flow select post idp login remember me and save.

About

Custom authenticator for remembering the user logging in, even if no "Remember me" flag is set. Useful in combination with identity providers, which don't allow to set the "Remember me" flag.

License:MIT License


Languages

Language:Java 100.0%