bitwarden / passwordless-docs

Bitwarden Passwordless.dev Documentation

Bitwarden Passwordless.dev is a software toolkit that helps developers build FIDO2 WebAuthn passkeys features for seamless authentication flows. This repository contains Passwordless.dev documentation, hosted at docs.passwordless.dev. The site uses Markdown and VuePress.

Using Passwordless.dev means there's no need to read extensive W3C specification documentation, determine what cryptography to implement, or worry about managing stored public keys. The team behind Bitwarden will take care of that for you.

Build and run

After you've cloned the repository, run the following commands:

• yarn install to install VuePress & dependencies
• yarn run dev to build and run the site on http://localhost:8080

If you're making changes, make sure to run yarn run lint before committing to ensure your code is formatted correctly.

Contribute

We encourage all contributions to docs.passwordless.dev, whether that's opening issues to request edits or additions, or adding them yourself in PRs. We recommend checking out the VuePress documentation for help writing correctly formatted Markdown.

When contributing PRs, please do your best to follow these guidelines:

• Use present tense and active voice.
• Use sentence case in headers and other titles (e.g. "Create an application").
• If you're adding a new article, add it to the sidebar object in /src/.vuepress/config.ts.
• If you're adding code examples, please include comments to explain what each function, section of code, etc. is achieving.
• Keep punctuation to the minimum necessary.
• Always capitalize "Passwordless.dev" and "Bitwarden".
• Feel free to use bold text to emphasize words or phrases, but please avoid italics or underlines.
• Use numerals (e.g. 1, 2, 3) to represent numbers.

passwordless-docs's Issues

Support for devicePubKey extension of WebAuthn

Does passwordless.dev support the devicePubKey extension of webauthn? I don't see any information about it in the documentation, and I don't see any implementation of it in source code (after cursory search).

Misspelled "Proprety" in Credential section of concepts.md

Misspelled "Proprety" in Credential section of concepts.md

Confusing recursive definition

https://docs.passwordless.dev/guide/concepts.html#discoverable-credential

"Discoverable Credential is a passkey" but also "Passkeys are an example of Discoverable Credentials"?

Standardize on API endpoints in examples

Currently, the docs are a bit misaligned on API routes when it comes to user-implemented backend endpoints.

For example, docs for the JS client (frontend) use /create-token and /signin: https://docs.passwordless.dev/guide/frontend/javascript.html#register

While the docs for the .NET client (backend) use /create-token and /verify-signin: https://docs.passwordless.dev/guide/backend/dotnet.html

Additionally, docs for the JS client assume that /create-token returns the raw token (string) directly: https://docs.passwordless.dev/guide/frontend/javascript.html#register

While the docs for the .NET client return the token as part of a JSON object: https://docs.passwordless.dev/guide/backend/dotnet.html

This inconsistency can lead to silly bugs and it would be nice to standardize on some convention.

Wrong Status Code on /credentials/delete

If you do a successful POST request on /credentials/delete the documentation says that it will return a 201 or a 201.
But you will instead receive a 204.

Corresponding Backend Code:
https://github.com/bitwarden/passwordless-server/blob/3897af8da556e80bb6676f3f233287d49c3a03b0/src/Api/Endpoints/Credentials.cs#L17C1-L18C1

Navigating to a specific header by ID seems broken

For example, open the following link: https://docs.passwordless.dev/guide/concepts.html#discoverable-credential

You'll see that the browser scrubs the #... part upon page load and stays at the beginning of the page, instead of navigating to the correct header.

Can not export backup files due to password error when using passwordless login with Yubikey.

Logged into vault.bitwarden.com using the passwordless option using my Yubikey 5C. Went to export a .json backup of my vault. It prompted me to enter my master password but told me it was wrong multiple times. Password was copied and pasted directly out of my Bitwarden vault. Logged out and used the same password on my clipboard to successfully logged back in.

MacOS 14.5 on an M2 Pro if it helps.

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• [deps]: Update actions/checkout action to v4.1.6

Detected dependencies

github-actions

.github/workflows/main.yml

• actions/checkout v4.1.4@0ad4b8fadaa221de15dcec353f45205ec38ea70b
• actions/setup-node v4.0.2@60edb5dd545a775178f52524783378180af0d1f8

.github/workflows/workflow-linter.yml

---

• Check this box to trigger a request for Renovate to run again on this repository