sdk: add passkey signer (#20443)

## Description corresponding sui change: https://github.com/MystenLabs/sui/blob/main/crates/sui-types/src/passkey_authenticator.rs spec follows: https://github.com/sui-foundation/sips/blob/main/sips/sip-9.md#signature-encoding https://github.com/sui-foundation/sips/blob/main/sips/sip-9.md#signature-verification ## Test plan unit tests --- ## 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. - [ ] Protocol: - [ ] Nodes (Validators and Full nodes): - [ ] Indexer: - [ ] JSON-RPC: - [ ] GraphQL: - [ ] CLI: - [ ] Rust SDK: - [ ] REST API: --------- Co-authored-by: hayes-mysten <135670682+hayes-mysten@users.noreply.github.com>
MystenLabs · Dec 10, 2024 · 20af12d · 20af12d
1 parent 3262677
commit 20af12d
Show file tree

Hide file tree

Showing 14 changed files with 789 additions and 33 deletions.
diff --git a/.changeset/eight-kings-grab.md b/.changeset/eight-kings-grab.md
@@ -0,0 +1,5 @@
+---
+'@mysten/sui': minor
+---
+
+add passkey sdk
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/pnpm-workspace.yaml b/pnpm-workspace.yaml
@@ -29,3 +29,4 @@ packages:
   - '!sdk/signers/aws'
   - '!sdk/signers/gcp'
   - '!sdk/typescript/zklogin'
+  - '!sdk/typescript/keypairs/passkey'
diff --git a/sdk/typescript/keypairs/passkey/package.json b/sdk/typescript/keypairs/passkey/package.json
@@ -0,0 +1,6 @@
+{
+	"private": true,
+	"import": "../../dist/esm/keypairs/passkey/index.js",
+	"main": "../../dist/cjs/keypairs/passkey/index.js",
+	"sideEffects": false
+}
diff --git a/sdk/typescript/package.json b/sdk/typescript/package.json
@@ -62,6 +62,10 @@
 			"import": "./dist/esm/keypairs/secp256r1/index.js",
 			"require": "./dist/cjs/keypairs/secp256r1/index.js"
 		},
+		"./keypairs/passkey": {
+			"import": "./dist/esm/keypairs/passkey/index.js",
+			"require": "./dist/cjs/keypairs/passkey/index.js"
+		},
 		"./multisig": {
 			"import": "./dist/esm/multisig/index.js",
 			"require": "./dist/cjs/multisig/index.js"
@@ -151,6 +155,7 @@
 		"@noble/hashes": "^1.4.0",
 		"@scure/bip32": "^1.4.0",
 		"@scure/bip39": "^1.3.0",
+		"@simplewebauthn/typescript-types": "^7.4.0",
 		"@suchipi/femver": "^1.0.0",
 		"bech32": "^2.0.0",
 		"gql.tada": "^1.8.2",

diff --git a/sdk/typescript/src/bcs/bcs.ts b/sdk/typescript/src/bcs/bcs.ts
@@ -298,3 +298,9 @@ export const SenderSignedTransaction = bcs.struct('SenderSignedTransaction', {
 export const SenderSignedData = bcs.vector(SenderSignedTransaction, {
 	name: 'SenderSignedData',
 });
+
+export const PasskeyAuthenticator = bcs.struct('PasskeyAuthenticator', {
+	authenticatorData: bcs.vector(bcs.u8()),
+	clientDataJson: bcs.string(),
+	userSignature: bcs.vector(bcs.u8()),
+});
diff --git a/sdk/typescript/src/bcs/index.ts b/sdk/typescript/src/bcs/index.ts
@@ -20,6 +20,7 @@ import {
 	MultiSigPublicKey,
 	ObjectArg,
 	ObjectDigest,
+	PasskeyAuthenticator,
 	ProgrammableMoveCall,
 	ProgrammableTransaction,
 	PublicKey,
@@ -82,6 +83,7 @@ const suiBcs = {
 	TransactionKind,
 	TypeTag,
 	TransactionEffects,
+	PasskeyAuthenticator,
 };
 
 export { suiBcs as bcs };
diff --git a/sdk/typescript/src/cryptography/signature-scheme.ts b/sdk/typescript/src/cryptography/signature-scheme.ts
@@ -7,6 +7,7 @@ export const SIGNATURE_SCHEME_TO_FLAG = {
 	Secp256r1: 0x02,
 	MultiSig: 0x03,
 	ZkLogin: 0x05,
+	Passkey: 0x06,
 } as const;
 
 export const SIGNATURE_SCHEME_TO_SIZE = {
@@ -21,8 +22,15 @@ export const SIGNATURE_FLAG_TO_SCHEME = {
 	0x02: 'Secp256r1',
 	0x03: 'MultiSig',
 	0x05: 'ZkLogin',
+	0x06: 'Passkey',
 } as const;
 
-export type SignatureScheme = 'ED25519' | 'Secp256k1' | 'Secp256r1' | 'MultiSig' | 'ZkLogin';
+export type SignatureScheme =
+	| 'ED25519'
+	| 'Secp256k1'
+	| 'Secp256r1'
+	| 'MultiSig'
+	| 'ZkLogin'
+	| 'Passkey';
 
 export type SignatureFlag = keyof typeof SIGNATURE_FLAG_TO_SCHEME;
diff --git a/sdk/typescript/src/cryptography/signature.ts b/sdk/typescript/src/cryptography/signature.ts
@@ -4,6 +4,7 @@
 import { fromBase64, toBase64 } from '@mysten/bcs';
 
 import { bcs } from '../bcs/index.js';
+import { parseSerializedPasskeySignature } from '../keypairs/passkey/publickey.js';
 import type { MultiSigStruct } from '../multisig/publickey.js';
 import { parseSerializedZkLoginSignature } from '../zklogin/publickey.js';
 import type { PublicKey } from './publickey.js';
@@ -55,6 +56,8 @@ export function parseSerializedSignature(serializedSignature: string) {
 		SIGNATURE_FLAG_TO_SCHEME[bytes[0] as keyof typeof SIGNATURE_FLAG_TO_SCHEME];
 
 	switch (signatureScheme) {
+		case 'Passkey':
+			return parseSerializedPasskeySignature(serializedSignature);
 		case 'MultiSig':
 			const multisig: MultiSigStruct = bcs.MultiSig.parse(bytes.slice(1));
 			return {

diff --git a/sdk/typescript/src/keypairs/passkey/index.ts b/sdk/typescript/src/keypairs/passkey/index.ts
@@ -0,0 +1,5 @@
+// Copyright (c) Mysten Labs, Inc.
+// SPDX-License-Identifier: Apache-2.0
+export { PasskeyKeypair, BrowserPasskeyProvider } from './keypair.js';
+export type { PasskeyProvider, BrowserPasswordProviderOptions } from './keypair.js';
+export { PasskeyPublicKey } from './publickey.js';