sdk: fix personal message to use bcs (MystenLabs#12997)

## Description fix a bug that the signMessage in rust vs typescript has a discrepancy. this is make typescript use bcs serialization for a vector instead of just a plain vector. ``` PersonalMessage { message: Vec<u8> } ``` ## Test Plan existing tests in ts still passes (bc verify and sign are both changed to the new format). tested against rust that a ts produced sig now verifies in rust. --- If your changes are not user-facing and not a breaking change, you can skip the following section. Otherwise, please indicate what changed, and then add to the Release Notes section as highlighted during the release process. ### Type of Change (Check all that apply) - [ ] protocol change - [ ] user-visible impact - [ ] breaking change for a client SDKs - [ ] breaking change for FNs (FN binary must upgrade) - [ ] breaking change for validators or node operators (must upgrade binaries) - [ ] breaking change for on-chain data layout - [ ] necessitate either a data wipe or data migration ### Release notes --------- Co-authored-by: Michael Hayes <michael.hayes@mystenlabs.com>
kakudo · Jul 19, 2023 · 09f4ed3 · 09f4ed3
1 parent 007a42c
commit 09f4ed3
Show file tree

Hide file tree

Showing 18 changed files with 397 additions and 29 deletions.
diff --git a/.changeset/short-pugs-obey.md b/.changeset/short-pugs-obey.md
@@ -0,0 +1,5 @@
+---
+'@mysten/sui.js': minor
+---
+
+signMesssage uses BCS serialization for vector
diff --git a/dapps/kiosk-cli/README.md b/dapps/kiosk-cli/README.md
@@ -11,21 +11,25 @@ A simple CLI application written in NodeJS to showcase Kiosk usage and basic app
 ## Install and use
 
 Export a mnemonic phrase
+
 ```
 export MNEMONIC="..."
 ```
 
 Create a Kiosk
+
 ```
 pnpm cli new
 ```
 
 Mint a TestItem
+
 ```
 pnpm cli mint-to-kiosk
 ```
 
 View Kiosk contents
+
 ```
 pnpm cli contents
 
@@ -37,6 +41,7 @@ pnpm cli contents
 ```
 
 List an item in the Kiosk
+
 ```
 # list an item in the Kiosk
 pnpm list <item_id> <price>

diff --git a/pnpm-workspace.yaml b/pnpm-workspace.yaml
@@ -9,3 +9,4 @@ packages:
     - '!sdk/typescript/faucet'
     - '!sdk/typescript/transactions'
     - '!sdk/typescript/client'
+    - '!sdk/typescript/verify'
diff --git a/sdk/typescript/package.json b/sdk/typescript/package.json
@@ -13,7 +13,8 @@
 		"faucet",
 		"keypairs",
 		"src",
-		"transactions"
+		"transactions",
+		"verify"
 	],
 	"engines": {
 		"node": ">=16"
@@ -67,6 +68,11 @@
 			"source": "./src/builder/export.ts",
 			"import": "./dist/esm/builder/export.js",
 			"require": "./dist/cjs/builder/export.js"
+		},
+		"./verify": {
+			"source": "./src/verify/index.ts",
+			"import": "./dist/esm/verify/index.js",
+			"require": "./dist/cjs/verify/index.js"
 		}
 	},
 	"scripts": {

diff --git a/sdk/typescript/src/cryptography/keypair.ts b/sdk/typescript/src/cryptography/keypair.ts
@@ -7,6 +7,7 @@ import { toSerializedSignature } from './signature.js';
 import type { SignatureScheme } from './signature.js';
 import { IntentScope, messageWithIntent } from './intent.js';
 import { blake2b } from '@noble/hashes/blake2b';
+import { bcs } from '../types/sui-bcs.js';
 
 export const PRIVATE_KEY_SIZE = 32;
 export const LEGACY_PRIVATE_KEY_SIZE = 64;
@@ -47,8 +48,18 @@ export abstract class BaseSigner {
 		return this.signWithIntent(bytes, IntentScope.TransactionData);
 	}
 
+	async signPersonalMessage(bytes: Uint8Array) {
+		return this.signWithIntent(
+			bcs.ser(['vector', 'u8'], bytes).toBytes(),
+			IntentScope.PersonalMessage,
+		);
+	}
+
+	/**
+	 * @deprecated use `signPersonalMessage` instead
+	 */
 	async signMessage(bytes: Uint8Array) {
-		return this.signWithIntent(bytes, IntentScope.PersonalMessage);
+		return this.signPersonalMessage(bytes);
 	}
 
 	toSuiAddress(): string {
@@ -57,7 +68,7 @@ export abstract class BaseSigner {
 
 	/**
 	 * Return the signature for the data.
-	 * Prefer the async verion {@link sign}, as this method will be deprecated in a future release.
+	 * Prefer the async version {@link sign}, as this method will be deprecated in a future release.
 	 */
 	abstract signData(data: Uint8Array): Uint8Array;
 

diff --git a/sdk/typescript/src/cryptography/publickey.ts b/sdk/typescript/src/cryptography/publickey.ts
@@ -2,6 +2,9 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { toB64 } from '@mysten/bcs';
+import { IntentScope, messageWithIntent } from './intent.js';
+import { blake2b } from '@noble/hashes/blake2b';
+import { bcs } from '../types/sui-bcs.js';
 
 /**
  * Value to be converted into public key.
@@ -63,6 +66,35 @@ export abstract class PublicKey {
 		return toB64(suiPublicKey);
 	}
 
+	verifyWithIntent(
+		bytes: Uint8Array,
+		signature: Uint8Array,
+		intent: IntentScope,
+	): Promise<boolean> {
+		const intentMessage = messageWithIntent(intent, bytes);
+		const digest = blake2b(intentMessage, { dkLen: 32 });
+
+		return this.verify(digest, signature);
+	}
+
+	/**
+	 * Verifies that the signature is valid for for the provided PersonalMessage
+	 */
+	verifyPersonalMessage(message: Uint8Array, signature: Uint8Array): Promise<boolean> {
+		return this.verifyWithIntent(
+			bcs.ser(['vector', 'u8'], message).toBytes(),
+			signature,
+			IntentScope.PersonalMessage,
+		);
+	}
+
+	/**
+	 * Verifies that the signature is valid for for the provided TransactionBlock
+	 */
+	verifyTransactionBlock(transactionBlock: Uint8Array, signature: Uint8Array): Promise<boolean> {
+		return this.verifyWithIntent(transactionBlock, signature, IntentScope.TransactionData);
+	}
+
 	/**
 	 * Return the byte array representation of the public key
 	 */
@@ -77,4 +109,9 @@ export abstract class PublicKey {
 	 * Return signature scheme flag of the public key
 	 */
 	abstract flag(): number;
+
+	/**
+	 * Verifies that the signature is valid for for the provided message
+	 */
+	abstract verify(data: Uint8Array, signature: Uint8Array): Promise<boolean>;
 }
diff --git a/sdk/typescript/src/cryptography/signature.ts b/sdk/typescript/src/cryptography/signature.ts
@@ -1,7 +1,7 @@
 // Copyright (c) Mysten Labs, Inc.
 // SPDX-License-Identifier: Apache-2.0
 
-import { toB64 } from '@mysten/bcs';
+import { fromB64, toB64 } from '@mysten/bcs';
 import type { PublicKey } from './publickey.js';
 
 export type SignatureScheme = 'ED25519' | 'Secp256k1' | 'Secp256r1' | 'MultiSig';
@@ -30,6 +30,12 @@ export const SIGNATURE_SCHEME_TO_FLAG = {
 	MultiSig: 0x03,
 };
 
+export const SIGNATURE_SCHEME_TO_SIZE = {
+	ED25519: 32,
+	Secp256k1: 33,
+	Secp256r1: 33,
+};
+
 export const SIGNATURE_FLAG_TO_SCHEME = {
 	0x00: 'ED25519',
 	0x01: 'Secp256k1',
@@ -51,3 +57,25 @@ export function toSerializedSignature({
 	serializedSignature.set(pubKeyBytes, 1 + signature.length);
 	return toB64(serializedSignature);
 }
+
+export function parseSerializedSignature(serializedSignature: SerializedSignature) {
+	const bytes = fromB64(serializedSignature);
+
+	const signatureScheme =
+		SIGNATURE_FLAG_TO_SCHEME[bytes[0] as keyof typeof SIGNATURE_FLAG_TO_SCHEME];
+
+	if (!(signatureScheme in SIGNATURE_SCHEME_TO_SIZE)) {
+		throw new Error('Unsupported signature scheme');
+	}
+
+	const size = SIGNATURE_SCHEME_TO_SIZE[signatureScheme as keyof typeof SIGNATURE_SCHEME_TO_SIZE];
+
+	const signature = bytes.slice(1, bytes.length - size);
+	const publicKey = bytes.slice(1 + signature.length);
+
+	return {
+		signatureScheme,
+		signature,
+		publicKey,
+	};
+}
diff --git a/sdk/typescript/src/keypairs/ed25519/publickey.ts b/sdk/typescript/src/keypairs/ed25519/publickey.ts
@@ -8,6 +8,7 @@ import { PublicKey } from '../../cryptography/publickey.js';
 import { SIGNATURE_SCHEME_TO_FLAG } from '../../cryptography/signature.js';
 import { bytesToHex } from '@noble/hashes/utils';
 import { SUI_ADDRESS_LENGTH, normalizeSuiAddress } from '../../utils/sui-types.js';
+import nacl from 'tweetnacl';
 
 const PUBLIC_KEY_SIZE = 32;
 
@@ -73,4 +74,11 @@ export class Ed25519PublicKey extends PublicKey {
 	flag(): number {
 		return SIGNATURE_SCHEME_TO_FLAG['ED25519'];
 	}
+
+	/**
+	 * Verifies that the signature is valid for for the provided message
+	 */
+	async verify(message: Uint8Array, signature: Uint8Array): Promise<boolean> {
+		return nacl.sign.detached.verify(message, signature, this.toBytes());
+	}
 }
diff --git a/sdk/typescript/src/keypairs/secp256k1/publickey.ts b/sdk/typescript/src/keypairs/secp256k1/publickey.ts
@@ -8,6 +8,8 @@ import { PublicKey } from '../../cryptography/publickey.js';
 import type { PublicKeyInitData } from '../../cryptography/publickey.js';
 import { SIGNATURE_SCHEME_TO_FLAG } from '../../cryptography/signature.js';
 import { SUI_ADDRESS_LENGTH, normalizeSuiAddress } from '../../utils/sui-types.js';
+import { secp256k1 } from '@noble/curves/secp256k1';
+import { sha256 } from '@noble/hashes/sha256';
 
 const SECP256K1_PUBLIC_KEY_SIZE = 33;
 
@@ -73,4 +75,15 @@ export class Secp256k1PublicKey extends PublicKey {
 	flag(): number {
 		return SIGNATURE_SCHEME_TO_FLAG['Secp256k1'];
 	}
+
+	/**
+	 * Verifies that the signature is valid for for the provided message
+	 */
+	async verify(message: Uint8Array, signature: Uint8Array): Promise<boolean> {
+		return secp256k1.verify(
+			secp256k1.Signature.fromCompact(signature),
+			sha256(message),
+			this.toBytes(),
+		);
+	}
 }
diff --git a/sdk/typescript/src/keypairs/secp256r1/publickey.ts b/sdk/typescript/src/keypairs/secp256r1/publickey.ts
@@ -8,6 +8,8 @@ import { PublicKey } from '../../cryptography/publickey.js';
 import type { PublicKeyInitData } from '../../cryptography/publickey.js';
 import { SIGNATURE_SCHEME_TO_FLAG } from '../../cryptography/signature.js';
 import { SUI_ADDRESS_LENGTH, normalizeSuiAddress } from '../../utils/sui-types.js';
+import { sha256 } from '@noble/hashes/sha256';
+import { secp256r1 } from '@noble/curves/p256';
 
 const SECP256R1_PUBLIC_KEY_SIZE = 33;
 
@@ -73,4 +75,15 @@ export class Secp256r1PublicKey extends PublicKey {
 	flag(): number {
 		return SIGNATURE_SCHEME_TO_FLAG['Secp256r1'];
 	}
+
+	/**
+	 * Verifies that the signature is valid for for the provided message
+	 */
+	async verify(message: Uint8Array, signature: Uint8Array): Promise<boolean> {
+		return secp256r1.verify(
+			secp256r1.Signature.fromCompact(signature),
+			sha256(message),
+			this.toBytes(),
+		);
+	}
 }
diff --git a/sdk/typescript/src/signers/signer-with-provider.ts b/sdk/typescript/src/signers/signer-with-provider.ts
@@ -20,6 +20,7 @@ import { IntentScope, messageWithIntent } from '../cryptography/intent.js';
 import type { Signer } from './signer.js';
 import type { SignedTransaction, SignedMessage } from './types.js';
 import type { SuiClient } from '../client/index.js';
+import { bcs } from '../types/sui-bcs.js';
 
 ///////////////////////////////
 // Exported Abstracts
@@ -74,7 +75,10 @@ export abstract class SignerWithProvider implements Signer {
 	 */
 	async signMessage(input: { message: Uint8Array }): Promise<SignedMessage> {
 		const signature = await this.signData(
-			messageWithIntent(IntentScope.PersonalMessage, input.message),
+			messageWithIntent(
+				IntentScope.PersonalMessage,
+				bcs.ser(['vector', 'u8'], input.message).toBytes(),
+			),
 		);
 
 		return {

diff --git a/sdk/typescript/src/utils/verify.ts b/sdk/typescript/src/utils/verify.ts
@@ -2,14 +2,12 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { fromB64 } from '@mysten/bcs';
-import nacl from 'tweetnacl';
-import type { IntentScope } from '../cryptography/intent.js';
+import { IntentScope } from '../cryptography/intent.js';
 import { messageWithIntent } from '../cryptography/intent.js';
-import { secp256k1 } from '@noble/curves/secp256k1';
-import { sha256 } from '@noble/hashes/sha256';
 import type { SerializedSignature } from '../cryptography/signature.js';
 import { blake2b } from '@noble/hashes/blake2b';
 import { toSingleSignaturePubkeyPair } from '../cryptography/utils.js';
+import { bcs } from '../types/sui-bcs.js';
 
 // TODO: This might actually make sense to eventually move to the `Keypair` instances themselves, as
 // it could allow the Sui.js to be tree-shaken a little better, possibly allowing keypairs that are
@@ -22,21 +20,34 @@ export async function verifyMessage(
 	scope: IntentScope,
 ) {
 	const signature = toSingleSignaturePubkeyPair(serializedSignature);
+
+	if (scope === IntentScope.PersonalMessage) {
+		const messageBytes = messageWithIntent(
+			scope,
+			bcs.ser(['vector', 'u8'], typeof message === 'string' ? fromB64(message) : message).toBytes(),
+		);
+
+		if (await signature.pubKey.verify(blake2b(messageBytes, { dkLen: 32 }), signature.signature)) {
+			return true;
+		}
+
+		// Fallback for backwards compatibility, old versions of the SDK
+		// did not properly wrap PersonalMessages in a PersonalMessage bcs Struct
+		const unwrappedMessageBytes = messageWithIntent(
+			scope,
+			typeof message === 'string' ? fromB64(message) : message,
+		);
+
+		return signature.pubKey.verify(
+			blake2b(unwrappedMessageBytes, { dkLen: 32 }),
+			signature.signature,
+		);
+	}
+
 	const messageBytes = messageWithIntent(
 		scope,
 		typeof message === 'string' ? fromB64(message) : message,
 	);
-	const digest = blake2b(messageBytes, { dkLen: 32 });
-	switch (signature.signatureScheme) {
-		case 'ED25519':
-			return nacl.sign.detached.verify(digest, signature.signature, signature.pubKey.toBytes());
-		case 'Secp256k1':
-			return secp256k1.verify(
-				secp256k1.Signature.fromCompact(signature.signature),
-				sha256(digest),
-				signature.pubKey.toBytes(),
-			);
-		default:
-			throw new Error(`Unknown signature scheme: "${signature.signatureScheme}"`);
-	}
+
+	return signature.pubKey.verify(blake2b(messageBytes, { dkLen: 32 }), signature.signature);
 }