Compare commits

...

7 commits

6 changed files with 33 additions and 24 deletions

View file

@ -10,7 +10,9 @@ The different plugins are documented in the submodules README or in docs folder.
# License
The code of this project is Apache 2.0 licensed. Parts of the original code are MIT licensed.
# Building
# Development
## Building
1. Clone this repository
1. Install Apache Maven
@ -22,7 +24,7 @@ The code of this project is Apache 2.0 licensed. Parts of the original code are
If building fails and the problem is caused or related to the dev module or tests, try to run `mvn clean install -DskipTests`.
## Deployment
## Releases
Deployment is done by github actions: `.github/workflows/release.yml`
To trigger the release workflow be sure to have proper access rights and follow the steps below.
https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/configuring-tag-protection-rules#about-tag-protection-rules

BIN
docs/Enforce-MFA.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 66 KiB

View file

@ -27,15 +27,20 @@ See: https://github.com/keycloak/keycloak/discussions/19548
This authenticator **must always** be used with an authentication flow like the following:
```
- MFA-Authenticate-subflow CONDITIONAL
-- Condition - user configured REQUIRED
-- OTP ALTERNATIVE
-- WebAuthn ALTERNATIVE
- MFA Wrapper Flow
-- MFA-Authenticate-subflow CONDITIONAL
--- Condition - user configured REQUIRED
--- OTP ALTERNATIVE
--- WebAuthn ALTERNATIVE
- Register-MFA-subflow CONDITIONAL
-- Condition - user configured REQUIRED
-- Enforce-MFA REQUIRED
-- Register-MFA-subflow CONDITIONAL
--- Condition - user configured REQUIRED
--- Enforce-MFA REQUIRED
```
The expected flow must contain at least two subflows. The subflow, which contains the alternatives for MFA
**must be the first subflow in its wrapper flow**.
Example:
![Example Configuration](../docs/Enforce-MFA.png)

View file

@ -1,9 +1,10 @@
loginChooseMfa=Wähle eine Multifaktor Authentifizierungsmethode aus
requiredAction.webauthn-register=Security key
requiredAction.webauthn-register-help-text=Nutze einen security key zum Anmelden.
requiredAction.CONFIGURE_TOTP-help-text=Gib einen Verifizierungscode aus der Authentifizierung-App ein.
requiredAction.app-register=App Authentifizierung
requiredAction.app-register-help-text=Bestätige die Anmeldung durch die Authentifizierung-App.
loginChooseMfa=Bitte wähle eine Authentisieriungs-Methode als zweiten Faktor.
requiredAction.webauthn-register=Passkey/FIDO2
requiredAction.webauthn-register-help-text=Nutze einen Passkey oder FIDO2 USB Token. Diese Methode bringt die größte Sicherheit.
requiredAction.CONFIGURE_TOTP-help-text=Gib einen 6-stelligen Code ein, der in einer Smartphone-App generiert wird.
requiredAction.CONFIGURE_TOTP=TOTP App
requiredAction.app-register=Authentisierungs-App
requiredAction.app-register-help-text=Bestätige die Anmeldung auf einer zusätzlichen Authentisierungs-App.
requiredAction.mobile_number_config=SMS Code
requiredAction.mobile_number_config-help-text=Richte eine Telefonnummer ein, um SMS Codes zu empfangen.
requiredAction.mobile_number_config-help-text=Empfange eine Bestätigungscode via SMS.
enforceMfaIllegalState=Ein Fehler ist aufgetreten. Bitte kontaktiere einen oder eine Administratorin.

View file

@ -1,9 +1,10 @@
loginChooseMfa=Choose multi factor authentication method
requiredAction.webauthn-register=Security key
requiredAction.webauthn-register-help-text=Use your security key to sign in.
requiredAction.CONFIGURE_TOTP-help-text=Enter a verification code from authenticator application.
requiredAction.app-register=App authentication
requiredAction.app-register-help-text=Confirm login by authenticator app.
loginChooseMfa=Please choose an authentication method as a second factor.
requiredAction.webauthn-register=Passkey/FIDO2
requiredAction.webauthn-register-help-text=Use a Passkey or USB FIDO2 token. This provides the highest security.
requiredAction.CONFIGURE_TOTP-help-text=Enter a 6-digit verification code that is generated on a smartphone app.
requiredAction.CONFIGURE_TOTP=TOTP App
requiredAction.app-register=Authentiation App
requiredAction.app-register-help-text=Use an app to confirm your login.
requiredAction.mobile_number_config=SMS Code
requiredAction.mobile_number_config-help-text=Setup phone number to receive SMS codes.
requiredAction.mobile_number_config-help-text=Receive a confirmation code via SMS.
enforceMfaIllegalState=An error occurred. Please contact an administrator.

View file

@ -7,7 +7,7 @@
<groupId>netzbegruenung</groupId>
<artifactId>keycloak-mfa-tools</artifactId>
<packaging>pom</packaging>
<version>24.0.3</version>
<version>24.0.5</version>
<modules>
<module>dev</module>