From 568f886eefde93981d99c16af83bd6854be47775 Mon Sep 17 00:00:00 2001 From: jesse-gallagher-hcl Date: Fri, 2 Aug 2024 10:36:51 -0400 Subject: [PATCH] Clarify and update language around WebAuthn --- docs/howto/install/passkey.md | 18 +++++++++++------- docs/howto/install/webauthn.md | 11 +++++------ 2 files changed, 16 insertions(+), 13 deletions(-) diff --git a/docs/howto/install/passkey.md b/docs/howto/install/passkey.md index 4639ceb5..1bebd89d 100644 --- a/docs/howto/install/passkey.md +++ b/docs/howto/install/passkey.md @@ -1,4 +1,4 @@ -# Use passkey to log in to Admin UI +# Use WebAuthn (Passkey) to log in to Admin UI !!!caution "Important" This feature is only applicable if your host is using HTTPS. @@ -10,23 +10,27 @@ The procedures guide you in using a passkey to log in to **Admin UI**. The proce - logging in to Admin UI using a passkey - clearing the passkey -Passkeys are better options to passwords as they use public key cryptography to create secure experiences. Passkeys allow sign-in to websites without remembering and managing passwords by using a biometric sensor, PIN, or pattern. For more information, see [passkey.org](https://passkey.org/){: target="_blank" rel=”noopener noreferrer”}. +Passkeys are better options to passwords as they use public key cryptography to create secure experiences. Passkeys allow sign-in to websites without remembering and managing passwords by using a biometric sensor, PIN, or pattern. For more information, see [passkey.org](https://passkey.org/){: target="_blank" rel="noopener noreferrer"}. ## Prerequisites -### For Mac +### For Mac Using Keychain -- You have [set up iCloud Keychain](https://support.apple.com/en-ph/guide/mac-help/mh43699/13.0/mac/13.0){: target="_blank" rel=”noopener noreferrer”} to create a passkey. +- You have [set up iCloud Keychain](https://support.apple.com/en-ph/guide/mac-help/mh43699/13.0/mac/13.0){: target="_blank" rel="noopener noreferrer"} to create a passkey. - You have an Apple ID to set up iCloud Keychain. -- Your Mac has a Touch ID sensor. +- Your Mac has a Touch ID sensor, you have a connected iPhone or iPad, or you have an external security key. !!!note Chrome supports passkeys on iCloud Keychain starting in Chrome 118, on macOS 13.5 or later. For more information, see [Chrome for Developers blog post](https://developer.chrome.com/blog/passkeys-on-icloud-keychain){: target="_blank" rel="noopener noreferrer"}. ### For Windows -- You have set up [Windows Hello](https://support.microsoft.com/en-us/windows/learn-about-windows-hello-and-set-it-up-dae28983-8242-bb2a-d3d1-87c9d265a5f0){: target="_blank" rel=”noopener noreferrer”} as Chrome on Windows stores passkeys in Windows Hello. -- Your Windows machine supports the Windows Hello options. +- You have set up [Windows Hello](https://support.microsoft.com/en-us/windows/learn-about-windows-hello-and-set-it-up-dae28983-8242-bb2a-d3d1-87c9d265a5f0){: target="_blank" rel="noopener noreferrer"} as Chrome on Windows stores passkeys in Windows Hello. +- Your Windows machine supports the Windows Hello options. + +### Other Passkey Managers + +Some third-party password managers, such as [1Password](https://1password.com/product/passkeys) support Passkeys as well. Refer to their documentation for details on configuration and requirements. ## Procedures diff --git a/docs/howto/install/webauthn.md b/docs/howto/install/webauthn.md index 6e9a4c91..21f71d93 100644 --- a/docs/howto/install/webauthn.md +++ b/docs/howto/install/webauthn.md @@ -1,6 +1,6 @@ # Configure WebAuthn with Domino REST API and Domino 14 or greater -The WebAuthn by default is configured in `config.json` located in the `keeponfig.d`. +WebAuthn (Passkey) authentication is enabled by default and can be configured to integrate with the Passkey support in Domino 14 via JSON files in `keepconfig.d`. ## About this task @@ -16,12 +16,11 @@ The procedure guides you to log in to both Domino REST API and Domino 14 using t ## Procedure -1. Create a JSON file using text/code app such as VSCode, notepad, notepad++, etc. -2. Copy the JSON object named `webAuthnActive` to the JSON file. +1. Create a JSON file using text/code app such as VS Code, Notepad, Notepad++, etc. +2. Copy the JSON object named `webauthn` to the JSON file. ```json { - "webAuthnActive": true, "webauthn": { "attestation": "direct", "rpName": "Keep RP", @@ -29,7 +28,7 @@ The procedure guides you to log in to both Domino REST API and Domino 14 using t } } ``` -3. Change the value of the `rpId` parameter with the same URL configured in the Domino directory. +3. Change the value of the `rpId` parameter with the same URL configured in the Domino Directory. ```json { @@ -56,5 +55,5 @@ The procedure guides you to log in to both Domino REST API and Domino 14 using t 5. Restart Domino REST API on all servers with this new configuration. !!!note - - If you disable the `webAuthnActive` in the settings you won't be able to use the passkey. + - If you disable the `webAuthnActive` in the settings you won't be able to use passkey authentication. - The actual WebAuthn keys are stored in each user's device. Domino and Domino REST API store only the public-key part to verify it. \ No newline at end of file