3.7 KiB
| title | description | lead | date | draft | images | menu | weight | toc | aliases | |||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| WebAuthn | Configuring the WebAuthn Second Factor Method. | WebAuthn is the modern browser security key specification that Authelia supports. This section describes configuring it. | 2022-03-03T22:20:43+11:00 | false |
|
103400 | true |
|
Configuration
{{< config-alert-example >}}
webauthn:
disable: false
display_name: 'Authelia'
attestation_conveyance_preference: 'indirect'
user_verification: 'preferred'
timeout: '60s'
Options
This section describes the individual configuration options.
disable
{{< confkey type="boolean" default="false" required="no" >}}
This disables WebAuthn if set to true.
display_name
{{< confkey type="string" default="Authelia" required="no" >}}
Sets the display name which is sent to the client to be displayed. It's up to individual browsers and potentially individual operating systems if and how they display this information.
See the W3C WebAuthn Documentation for more information.
attestation_conveyance_preference
{{< confkey type="string" default="indirect" required="no" >}}
Sets the conveyance preference. Conveyancing allows collection of attestation statements about the authenticator such as the AAGUID. The AAGUID indicates the model of the device.
See the W3C WebAuthn Documentation for more information.
Available Options:
| Value | Description |
|---|---|
| none | The client will be instructed not to perform conveyancing |
| indirect | The client will be instructed to perform conveyancing but the client can choose how to do this including using a third party anonymization CA |
| direct | The client will be instructed to perform conveyancing with an attestation statement directly signed by the device |
user_verification
{{< confkey type="string" default="preferred" required="no" >}}
Sets the user verification preference.
See the W3C WebAuthn Documentation for more information.
Available Options:
| Value | Description |
|---|---|
| discouraged | The client will be discouraged from asking for user verification |
| preferred | The client if compliant will ask the user for verification if the device supports it |
| required | The client will ask the user for verification or will fail if the device does not support verification |
timeout
{{< confkey type="duration" default="60s" required="no" >}}
Reference Note: This configuration option uses the duration common syntax. Please see the documentation on this format for more information.
This adjusts the requested timeout for a WebAuthn interaction.
Frequently Asked Questions
See the Security Key FAQ for the FAQ.