docs: update documentation about webauthn passkey

This commit is contained in:
Jacky 2024-09-17 08:42:49 +08:00
parent 2f51b5612b
commit 45048315cd
No known key found for this signature in database
GPG key ID: 215C21B10DF38B4D
11 changed files with 736 additions and 301 deletions

View file

@ -0,0 +1,53 @@
# Webauthn
Webauthn 是一種用於安全身份驗證的網路標準。它允許使用者使用生物識別、行動裝置和 FIDO 安全金鑰登入網站。
Webauthn 是一種無密碼的身份驗證方法,提供了比傳統密碼更安全、易用的替代方案。
`v2.0.0-beta.34` 版本開始Nginx UI 支援將 Webauthn Passkey 作為登入和雙因素認證2FA方法。
## Passkey
Passkey 是使用觸控、面部識別、裝置密碼或 PIN 驗證您身份的 Webauthn 憑證。它們可用作密碼替代品或作為 2FA 方法。
## 配置
為確保安全性,不能透過 UI 添加 Webauthn 配置。
請在 app.ini 配置檔中手動添加以下內容,並重新啟動 Nginx UI。
### RPDDisplayName
- 類型:`string`
用於在註冊新憑證時設定依賴方RP的顯示名稱。
### RPDID
- 類型:`string`
用於在註冊新憑證時設定依賴方RP的 ID。
### RPOrigins
- 類型:`[]string`
用於在註冊新憑證時設定依賴方RP的來源origins
完成後,刷新此頁面並再次點擊添加 Passkey。
由於某些瀏覽器的安全策略,除非在 `localhost` 上運行,否則無法在非 HTTPS 網站上使用 Passkey。
## 詳細說明
1. **使用 Passkey 的自動 2FA**
當您使用 Passkey 登入時,所有後續需要 2FA 的操作將自動使用 Passkey。這意味著您無需在 2FA 對話框中手動點擊「通過 Passkey 進行認證」。
2. **刪除 Passkey**
如果您使用 Passkey 登入後,前往「設定 > 認證」並刪除當前的 Passkey那麼在當前會話中Passkey 將不再用於後續的 2FA 驗證。如果已配置基於時間的一次性密碼TOTP則將改為使用它如果未配置則將關閉 2FA。
3. **添加新 Passkey**
如果您在未使用 Passkey 的情況下登入,然後透過「設定 > 認證」添加新的 Passkey那麼在當前會話中新增的 Passkey 將優先用於後續所有的 2FA 驗證。

View file

@ -70,6 +70,15 @@
|-----------------------|-----------------------------|
| IPWhiteList | NGINX_UI_AUTH_IPWhiteList |
## Webauthn
| Configuration Setting | Environment Variable |
|-----------------------|-----------------------------------|
| RPDisplayName | NGINX_UI_WEBAUTHN_RP_DISPLAY_NAME |
| RPID | NGINX_UI_WEBAUTHN_RPID |
| RPOrigins | NGINX_UI_WEBAUTHN_RP_ORIGINS |
## 預定義使用者
在跳過安裝模式下,您可以設置以下環境變量以創建預定義使用者: