-
Notifications
You must be signed in to change notification settings - Fork 547
Add WebAuthn documentation #870
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from 2 commits
bb9e4b5
c559500
52a0f76
b00ec9c
97f8023
24d021d
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -10,25 +10,24 @@ and must be served at exactly the address ``https://localhost:8384``, | |||||
unless configured otherwise as described in :ref:`webauthn-custom-gui-address`. | ||||||
|
||||||
WebAuthn authentication will be enabled if you have at least one `credential`, also called a `passkey`, registered. | ||||||
A credential is a public-private key pair stored either on an external security key, | ||||||
or a `platform credential` stored on your computer or phone. | ||||||
A credential is a public-private key pair that is stored on an `authenticator`, | ||||||
which could be an external security key, a smartphone, or built into your computer. | ||||||
Some platforms might sync platform credentials between devices signed into the same cloud account. | ||||||
|
||||||
Use the settings GUI to register a new credential. | ||||||
|
||||||
.. note:: | ||||||
We use the term "passkey" more inclusively here than usual. | ||||||
For technical reasons, the term "passkey" usually means | ||||||
a credential that consumes storage space on the authenticator device. | ||||||
Some external security keys have limited storage capacity | ||||||
and therefore also have a limited capacity for storing passkeys. | ||||||
|
||||||
However, because Syncthing has only a single user account per installation, | ||||||
we can enable the same use cases as passkeys | ||||||
but with credentials that do not need to consume storage space. | ||||||
A "passkey" is a credential that enables "username-less login", | ||||||
which identifies the user automatically without needing them to enter a username first. | ||||||
For technical reasons, this is incompatible with a cryptographic trick commonly used by external security keys | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
to support an unlimited number of credentials without consuming storage space. | ||||||
Therefore, a "passkey" generally must consume storage space on the authenticator. | ||||||
|
||||||
However, because a Syncthing instance has only a single user account, | ||||||
we can enable "username-less login" without preventing the unlimited storage trick. | ||||||
We therefore sometimes refer to WebAuthn credentials in Syncthing as "passkeys", | ||||||
because they enable most of the same UI flows as passkeys, | ||||||
even though they do not consume storage space on external security keys like passkeys usually do. | ||||||
even though they do not consume storage space on external security keys like passkeys generally do. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
|
||||||
.. _webauthn-require2fa: | ||||||
|
@@ -45,7 +44,8 @@ For example: | |||||
|
||||||
- If the credential is stored on a smartphone, | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Should these paragraphs refer to "smart devices, or your PC"? Since it's just an example, probably not. |
||||||
the phone may prompt for screen unlock to authenticate you to the phone before unlocking the passkey. | ||||||
This could be a PIN, swipe pattern, fingerprint or face recognition, according to the phone's settings. | ||||||
This could be a PIN, swipe pattern, fingerprint, face recognition | ||||||
or something else, according to the phone's settings. | ||||||
|
||||||
Smartphones typically always require 2FA, | ||||||
so this setting may not make a noticeable difference for smartphone-based credentials. | ||||||
|
@@ -85,3 +85,8 @@ and ``webauthnOrigin`` to the full address including scheme and port (except the | |||||
For example, if you serve the GUI at the address ``https://syncthing.mydomain.org:8443/syncthing/gui``, | ||||||
set ``webauthnRpId`` to one of ``mydomain.org`` or ``syncthing.mydomain.org`` | ||||||
and set ``webauthnOrigin`` to ``https://syncthing.mydomain.org:8443``. | ||||||
|
||||||
For hostnames other than ``localhost`` you will also need an HTTPS certificate your browser considers valid. | ||||||
For guidance on how to create or obtain one, see for example | ||||||
`OpenSSL Cookbook <https://www.feistyduck.com/library/openssl-cookbook/online/>`_ | ||||||
or `Let's Encrypt <https://letsencrypt.org/getting-started/>`_. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. How about adding: To create locally trusted HTTPS certificates on the command-line see |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"security key" might be too vague to the uninitiated, and aren't they all external?