Skip to content

Commit 42a5af1

Browse files
defguard-communitygitbook-bot
authored andcommitted
GITBOOK-379: change request with no subject merged in GitBook
1 parent cd21859 commit 42a5af1

2 files changed

Lines changed: 25 additions & 0 deletions

File tree

SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
* [Sending support information](admin-and-features/troubleshooting/sending-support-info.md)
2424
* [Client Windows installer exit codes](admin-and-features/troubleshooting-guide/windows-installer-exit-codes.md)
2525
* [Client "All traffic" connection issues](admin-and-features/troubleshooting/client-all-traffic-connection-issues.md)
26+
* [WebAuthn security keys](admin-and-features/troubleshooting/webauthn-security-keys.md)
2627
* [Deploying your instance](features/setting-up-your-instance/README.md)
2728
* [Upgrading](features/setting-up-your-instance/upgrading.md)
2829
* [One-line install script](features/setting-up-your-instance/one-line-install.md)
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# WebAuthn security keys
2+
3+
Currently, only security keys that can be configured as **passkeys** are supported.
4+
5+
**Passkeys** are a modern replacement for traditional passwords, based on WebAuthn and FIDO2 standards. They enable passwordless authentication by verifying both possession of a device and an additional user verification step (such as biometrics, PIN entry, or a user gesture).
6+
7+
For a security key to be supported, it must be able to correctly set the **User Verification (UV)** flag during the WebAuthn authentication flow. The UV flag indicates that the key has confirmed that the user is physically present and actively authenticating.
8+
9+
Some older or limited-functionality security keys do not support the necessary mechanisms (such as built-in biometrics or PIN prompts) to perform user verification. As a result, they **cannot set the UV flag** and are **not supported** for passkey use.
10+
11+
{% hint style="danger" %}
12+
Attempting to register an **unsupported** security key will result in an **error** during **registration** process.
13+
{% endhint %}
14+
15+
#### Examples of Unsupported Security Keys
16+
17+
* **YubiKey 4 Series** (e.g., YubiKey 4 Nano, YubiKey 4C)
18+
* **YubiKey NEO**
19+
* **Older FIDO U2F-only keys** without FIDO2/WebAuthn support
20+
21+
#### Requirements for Supported Keys
22+
23+
* Must support **passkey** registration and authentication (WebAuthn + FIDO2).
24+
* Must be capable of **user verification** (e.g., PIN entry, biometrics, or touch gestures).

0 commit comments

Comments
 (0)