Skip to content

Commit

Permalink
passkeys
Browse files Browse the repository at this point in the history
  • Loading branch information
eric-ships committed Dec 18, 2024
1 parent f36ffd4 commit 20db1f5
Show file tree
Hide file tree
Showing 2 changed files with 53 additions and 0 deletions.
44 changes: 44 additions & 0 deletions docs/pages/features/passkeys.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
import { Callout } from "vocs/components";

## Passkeys

<Callout type="info">
It's crucial to understand how passkeys work and how they are managed by the passkey provider (eg: Apple, Google, Microsoft) before using them. If a user loses access to their passkey, they will not be able to access their smart wallet.
</Callout>

### Overview
Smart Wallet uses passkeys as the primary authentication method for both wallet access and transaction signing, replacing traditional private keys with a more secure and user-friendly solution.

There is no way for developers to configure passkey options. This page is focused on how passkeys work for users.

What is it used for?
- Required for wallet sign-in and transaction approval
- Used for adding additional passkeys and recovery
- Managed by your passkey provider (eg: Apple, Google, Microsoft)
- Supports cross-device access through provider sync

### Adding Passkeys
- New passkeys can be added using recovery keys
- Multiple passkeys can be added to a Smart Wallet
- Adding a passkey requires a transaction on each chain
- Previous passkeys are not automatically removed

### Removing Passkeys

<Callout type="warning">
Removing keys is currently not supported in keys.coinbase.com.
</Callout>

### Considerations
When using passkeys, consider checking with your provider about:
- Backup and sync capabilities across devices
- Recovery procedures and options
- Device and operating system compatibility
- Security and privacy practices

### Platform Support and Resources
Passkeys work with any platform that supports the WebAuthn standard, allowing for wide compatibility across different devices and browsers. While many providers offer passkey support, here are documentation links for some common ones:
- iOS/macOS: [Apple Support - Use passkeys](https://support.apple.com/guide/iphone/use-passkeys-to-sign-in-to-websites-and-apps-iphf538ea8d0/ios)
- Android: [Google Help - About passkeys](https://support.google.com/android/answer/13462838https://support.google.com/android/answer/14124480?hl=en-GB&sjid=5621630875911120810-NC)
- Windows: [Microsoft Account - Passkey sign in](https://support.microsoft.com/windows/passkey-sign-in-windows-301c8944-5ea2-452b-9886-97e4d2ef4422)
- Chrome: [Google Chrome Help - Use passkeys](https://support.google.com/chrome/answer/13168025)
9 changes: 9 additions & 0 deletions vocs.config.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,15 @@ export default defineConfig({
text: "Networks",
link: "/features/networks",
},
{
text: "Key Management",
items: [
{
text: "Passkeys",
link: "/features/passkeys",
},
],
},
],
},
{
Expand Down

0 comments on commit 20db1f5

Please sign in to comment.