Skip to content

Commit

Permalink
Merge pull request #6 from jesse-gallagher/feature/webauthn-clarifica…
Browse files Browse the repository at this point in the history
…tion

Clarify and update language around WebAuthn
  • Loading branch information
Stwissel authored Aug 20, 2024
2 parents 23eebe1 + 270f22b commit 76bfeee
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 10 deletions.
11 changes: 7 additions & 4 deletions docs/howto/install/passkey.md
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -14,21 +14,24 @@ Passkeys are better options to passwords as they use public key cryptography to

## 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) 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).

### 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) as Chrome on Windows stores passkeys in Windows Hello.
- Your Windows machine supports the Windows Hello options.

- 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

Expand Down
11 changes: 5 additions & 6 deletions docs/howto/install/webauthn.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -16,20 +16,19 @@ 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",
"rpId": "domino.URL.com"
}
}
```
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
{
Expand All @@ -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.

0 comments on commit 76bfeee

Please sign in to comment.