Skip to content
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.

Sign up for GitHub

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

Jump to bottom

docs: add webauthn / passkey troubleshoot #1946

Merged
merged 2 commits into from
Dec 3, 2024
Merged

docs: add webauthn / passkey troubleshoot #1946

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0d1ea00
docs: add webauthn / passkey troubleshoot
aeneasr Nov 12, 2024
e88c5e2
chore: synchronize workspaces
aeneasr Nov 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions docs/troubleshooting/45_passkeys-webauthn-security-error.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
id: passkeys-webauthn-security-error
title: SecurityError when using WebAuthn or Passkeys
sidebar_label: WebAuthn / PassKeys SecurityError
---

## Relying party ID mismatch

> The relying party ID is not a registrable domain suffix of, nor equal to the current domain. Subsequently, an attempt to fetch
> the .well-known/webauthn resource of the claimed RP ID failed.

### Solve relying party ID mismatch

When configuring WebAuthn or PassKeys, you define an ID and a number of origins that are allowed to use the WebAuthn or Passkeys
credential. If you use the Ory Tunnel, Ory Proxy, the Ory Next.js integration, or other tooling which proxies requests to a
different domain, you may encounter this issue.

Per default, Ory sets the RP ID and the origins for your project automatically. You can however override them to get
Passkeys/Webauthn working locally, in your development or staging environment, by updating the RP ID and origins in the Ory
Network configuration:

```
# For Passkeys
ory patch identity-config --project <project-id> --workspace <workspace-id> \
--replace "/selfservice/methods/passkey/config/rp/id=\"localhost\"" \
--replace "/selfservice/methods/passkey/config/rp/origins=[\"http://localhost:3000\"]" \
--format yaml

# For Webauthn
ory patch identity-config --project <project-id> --workspace <workspace-id> \
--replace "/selfservice/methods/webauthn/config/rp/id=\"localhost\"" \
--replace "/selfservice/methods/webauthn/config/rp/origins=[\"http://localhost:3000\"]" \
--format yaml
```

Please be aware that this may break Passkeys and WebAuthn for users if they have already signed up using a different RP ID. **Do
not change the RP ID in production environments.**
Loading