Add a public doc for passkeys for testnet launch #21374
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
2 Skipped Deployments
|
github-actions
bot
added
the
Type: Documentation
abhinavg6
temporarily deployed
to
sui-typescript-aws-kms-test-env
GitHub Actions
Inactive
abhinavg6
temporarily deployed
to
sui-typescript-aws-kms-test-env
GitHub Actions
Inactive
|
cc @joyqvq @ronny-mysten for review - thank you |
joyqvq
reviewed
Feb 27, 2025
|
|
||
| Go to [zkLogin](./cryptography/zklogin.mdx). | ||
|
|
||
| ## Passkeys | ||
|
|
||
| Passkeys is a Sui primitive that enables you to sign-in to apps and send transactions to Sui using a private key securely stored on a authenticator. It uses the WebAuthn standard. |
There was a problem hiding this comment.
Suggested change
| Passkeys is a Sui primitive that enables you to sign-in to apps and send transactions to Sui using a private key securely stored on a authenticator. It uses the WebAuthn standard. | |
| Sui supports passkey signature scheme that enables you to sign-in to apps and sign transactions to Sui using a private key securely stored on a passkey authenticator. It uses the WebAuthn standard. |
joyqvq
approved these changes
Feb 27, 2025
|
|
||
| Passkeys provide a secure and user-friendly alternative for submitting transactions to Sui. Built on the **WebAuthn standard**, passkeys let users authenticate and sign transactions using: | ||
|
|
||
| - Hardware security keys, such as YubiKeys) |
There was a problem hiding this comment.
Suggested change
| - Hardware security keys, such as YubiKeys) | |
| - Hardware security keys, such as YubiKeys |
|
|
||
| Passkeys simplify authentication by removing the need to manage seed phrases or private keys manually. Instead, they rely on device-based authentication and cloud synchronization, allowing seamless, phishing-resistant access across multiple devices. | ||
|
|
||
| By integrating passkeys, Sui improves security and accessibility, making it easier for users to manage their accounts without compromising decentralization or cryptographic security. |
There was a problem hiding this comment.
Suggested change
| By integrating passkeys, Sui improves security and accessibility, making it easier for users to manage their accounts without compromising decentralization or cryptographic security. | |
| By supporting passkey signature scheme, Sui improves security and accessibility, making it easier for users to manage their accounts with hardened security. Passkey wallets are also tied to the origin, meaning they can’t be phished or used on a different site, which makes it a safer user wallet option. |
|
|
||
| By integrating passkeys, Sui improves security and accessibility, making it easier for users to manage their accounts without compromising decentralization or cryptographic security. | ||
|
|
||
| Refer to [Typescript SDK support](https://sdk.mystenlabs.com/typescript/cryptography/passkey) on how to add passkey support to your application. Also feel free to refer to [SIP-9](https://github.com/sui-foundation/sips/blob/main/sips/sip-9.md) for product specification. |
There was a problem hiding this comment.
nit: standardize the passkey usage, referring to it as passkey instead of passkeys (to be consistent with code)
|
|
||
| Users can sign transactions directly on devices with built-in authenticators (such as Face ID on iPhones or Windows Hello on Windows PCs). This approach lets users sign transactions natively without needing an external security key. | ||
|
|
||
| **Recover access and secure accounts with multi-signature authentication** |
There was a problem hiding this comment.
the cloud synchronization has nothing to do with multisig, just mention the passkey is recoverable if synced in cloud is sufficient.
|
|
||
| Users cannot transfer passkeys between different authenticators. For example, a passkey created on a security key cannot move to another device unless it syncs through a cloud provider. To avoid losing access, users should set up authentication on multiple devices. | ||
|
|
||
| **Multisig support is not available yet** |
There was a problem hiding this comment.
we can mark this as available in testnet or remove mentioning this
|
lgtm with inlined comments addressed |
abhinavg6
temporarily deployed
to
sui-typescript-aws-kms-test-env
GitHub Actions
Inactive
|
Thanks @joyqvq - addressed all the feedback @ronny-mysten - Can I request you to please review and merge by Monday? This would be deployed to testnet with Tuesday release. Thanks. |
ronny-mysten
temporarily deployed
to
sui-typescript-aws-kms-test-env
GitHub Actions
Inactive
ronny-mysten
temporarily deployed
to
sui-typescript-aws-kms-test-env
GitHub Actions
Inactive
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Adding a public doc for passkeys for testnet launch. It's a high-level doc that links to the relevant to the TS SDK doc and the SIP.
Test plan
@joyqvq has done the relevant dev testing, and beyond that we've tested the feature in devnet using a sample app and a community-built app.
Release notes
Check each box that your changes affect. If none of the boxes relate to your changes, release notes aren't required.
For each box you select, include information after the relevant heading that describes the impact of your changes that a user might notice and any actions they must take to implement updates.