From 5c739ebed247bb55e0201a46d6d26301fc80f8eb Mon Sep 17 00:00:00 2001 From: Jens Langhammer Date: Tue, 2 Mar 2021 22:20:05 +0100 Subject: [PATCH] docs: add authenticator_webauthn stage docs --- .../docs/flow/stages/authenticator_static/index.md | 2 +- website/docs/flow/stages/authenticator_totp/index.md | 4 ++-- .../docs/flow/stages/authenticator_validate/index.md | 11 ++++++++++- .../docs/flow/stages/authenticator_webauthn/index.md | 7 +++++++ website/sidebars.js | 1 + 5 files changed, 21 insertions(+), 4 deletions(-) create mode 100644 website/docs/flow/stages/authenticator_webauthn/index.md diff --git a/website/docs/flow/stages/authenticator_static/index.md b/website/docs/flow/stages/authenticator_static/index.md index ee43781d6..03d8fd8ef 100644 --- a/website/docs/flow/stages/authenticator_static/index.md +++ b/website/docs/flow/stages/authenticator_static/index.md @@ -1,5 +1,5 @@ --- -title: Static Authenticator stage +title: Static Authentication Setup stage --- This stage configures static OTP Tokens, which can be used as a backup method to time-based OTP tokens. diff --git a/website/docs/flow/stages/authenticator_totp/index.md b/website/docs/flow/stages/authenticator_totp/index.md index 6d4961144..03410e013 100644 --- a/website/docs/flow/stages/authenticator_totp/index.md +++ b/website/docs/flow/stages/authenticator_totp/index.md @@ -1,7 +1,7 @@ --- -title: TOTP stage +title: TOTP Authentication Setup stage --- This stage configures a time-based OTP Device, such as Google Authenticator or Authy. -You can configure how many digest should be used for the OTP Token. +You can configure how many digits should be used for the OTP Token. diff --git a/website/docs/flow/stages/authenticator_validate/index.md b/website/docs/flow/stages/authenticator_validate/index.md index 9dffa3dc1..05b714b9c 100644 --- a/website/docs/flow/stages/authenticator_validate/index.md +++ b/website/docs/flow/stages/authenticator_validate/index.md @@ -2,7 +2,16 @@ title: Authenticator Validation Stage --- -This stage validates an already configured OTP Device. This device has to be configured using any of the other authenticator stages: +This stage validates an already configured Authenticator Device. This device has to be configured using any of the other authenticator stages: - [TOTP authenticator stage](../authenticator_totp/index.md) - [Static authenticator stage](../authenticator_static/index.md). +- [WebAuth authenticator stage](../authenticator_webauthn/index.md). + +You can select which type of device classes are allowed. + +Using the `Not configured action`, you can choose what happens when a user does not have any matching devices. + +- Skip: Validation is skipped and the flow continues +- Deny: Access is denied, the flow execution ends +- Configure: This option requires a *Configuration stage* to be set. The validation stage will be marked as successful, and the configuration stage will be injected into the flow. diff --git a/website/docs/flow/stages/authenticator_webauthn/index.md b/website/docs/flow/stages/authenticator_webauthn/index.md new file mode 100644 index 000000000..15369cfbe --- /dev/null +++ b/website/docs/flow/stages/authenticator_webauthn/index.md @@ -0,0 +1,7 @@ +--- +title: WebAuthn Authentication Setup stage +--- + +This stage configures a WebAuthn-based Authenticator. This can either be a browser, biometrics or a Security stick like a YubiKey. + +There are no stage-specific settings. diff --git a/website/sidebars.js b/website/sidebars.js index 0c963a4aa..ce45e2a00 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -49,6 +49,7 @@ module.exports = { "flow/stages/authenticator_static/index", "flow/stages/authenticator_totp/index", "flow/stages/authenticator_validate/index", + "flow/stages/authenticator_webauthn/index", "flow/stages/captcha/index", "flow/stages/email/index", "flow/stages/identification/index",