Merge pull request #200 from Concordium/web3Proofs

Web3Id proofs
Concordium · Aug 24, 2023 · 5eb8f77 · 5eb8f77
2 parents 395a633 + f810805
commit 5eb8f77
Show file tree

Hide file tree

Showing 26 changed files with 1,738 additions and 254 deletions.
diff --git a/deps/concordium-base b/deps/concordium-base
diff --git a/packages/common/CHANGELOG.md b/packages/common/CHANGELOG.md
@@ -1,6 +1,6 @@
 # Changelog
 
-## Unreleased
+## 9.1.0
 
 ### Added
 
@@ -14,6 +14,11 @@ Added a functions that handle conversions between CCD and micro CCD. The CCD amo
 
 All function parameters now also accepts strings, these strings can use comma as a decimal seperator.
 
+
+- `Web3StatementBuilder` function.
+- `getVerifiablePresentation` function.
+- Various helper methods for web3Id statements and verifiable presentations.
+
 ## 9.0.0
 
 ### Breaking changes

diff --git a/packages/common/package.json b/packages/common/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@concordium/common-sdk",
-    "version": "9.0.0",
+    "version": "9.1.0-alpha.1",
     "license": "Apache-2.0",
     "engines": {
         "node": ">=14.16.0"
@@ -52,7 +52,7 @@
         "build-dev": "tsc"
     },
     "dependencies": {
-        "@concordium/rust-bindings": "1.1.0",
+        "@concordium/rust-bindings": "1.2.0-alpha.1",
         "@grpc/grpc-js": "^1.3.4",
         "@noble/ed25519": "^1.7.1",
         "@protobuf-ts/runtime-rpc": "^2.8.2",

diff --git a/packages/common/src/HdWallet.ts b/packages/common/src/HdWallet.ts
@@ -2,7 +2,12 @@ import * as wasm from '@concordium/rust-bindings';
 import { mnemonicToSeedSync, validateMnemonic } from '@scure/bip39';
 import { wordlist } from '@scure/bip39/wordlists/english';
 import { Buffer } from 'buffer/';
-import { AttributesKeys, Network, CryptographicParameters } from './types';
+import {
+    AttributesKeys,
+    Network,
+    CryptographicParameters,
+    ContractAddress,
+} from './types';
 import { isHex } from './util';
 
 /**
@@ -153,38 +158,31 @@ export class ConcordiumHdWallet {
     }
 
     getVerifiableCredentialSigningKey(
+        issuer: ContractAddress,
         verifiableCredentialIndex: number
     ): Buffer {
         return Buffer.from(
             wasm.getVerifiableCredentialSigningKey(
                 this.seedAsHex,
                 this.network,
+                issuer.index,
+                issuer.subindex,
                 verifiableCredentialIndex
             ),
             'hex'
         );
     }
 
     getVerifiableCredentialPublicKey(
+        issuer: ContractAddress,
         verifiableCredentialIndex: number
     ): Buffer {
         return Buffer.from(
             wasm.getVerifiableCredentialPublicKey(
                 this.seedAsHex,
                 this.network,
-                verifiableCredentialIndex
-            ),
-            'hex'
-        );
-    }
-
-    getVerifiableCredentialEncryptionKey(
-        verifiableCredentialIndex: number
-    ): Buffer {
-        return Buffer.from(
-            wasm.getVerifiableCredentialEncryptionKey(
-                this.seedAsHex,
-                this.network,
+                issuer.index,
+                issuer.subindex,
                 verifiableCredentialIndex
             ),
             'hex'

diff --git a/packages/common/src/commonProofTypes.ts b/packages/common/src/commonProofTypes.ts
@@ -0,0 +1,100 @@
+export interface StatementBuilder<ValueType, AttributeType> {
+    addRange(
+        attribute: AttributeType,
+        lower: ValueType,
+        upper: ValueType
+    ): this;
+
+    addMembership(attribute: AttributeType, set: ValueType[]): this;
+
+    addNonMembership(attribute: AttributeType, set: ValueType[]): this;
+    revealAttribute(attribute: AttributeType): this;
+    getStatement(): GenericAtomicStatement<AttributeType, ValueType>[];
+}
+
+export const MIN_DATE = '18000101';
+export const MAX_DATE = '99990101';
+export const EU_MEMBERS = [
+    'AT',
+    'BE',
+    'BG',
+    'CY',
+    'CZ',
+    'DK',
+    'EE',
+    'FI',
+    'FR',
+    'DE',
+    'GR',
+    'HU',
+    'IE',
+    'IT',
+    'LV',
+    'LT',
+    'LU',
+    'MT',
+    'NL',
+    'PL',
+    'PT',
+    'RO',
+    'SK',
+    'SI',
+    'ES',
+    'SE',
+    'HR',
+];
+
+export enum StatementTypes {
+    RevealAttribute = 'RevealAttribute',
+    AttributeInSet = 'AttributeInSet',
+    AttributeNotInSet = 'AttributeNotInSet',
+    AttributeInRange = 'AttributeInRange',
+}
+
+type LaxStringEnum<E extends string> = `${E}`;
+
+export type GenericRevealStatement<TagType> = {
+    type: LaxStringEnum<StatementTypes.RevealAttribute>;
+    attributeTag: TagType;
+};
+
+export type GenericMembershipStatement<TagType, ValueType> = {
+    type: LaxStringEnum<StatementTypes.AttributeInSet>;
+    attributeTag: TagType;
+    set: ValueType[];
+};
+
+export type GenericNonMembershipStatement<TagType, ValueType> = {
+    type: LaxStringEnum<StatementTypes.AttributeNotInSet>;
+    attributeTag: TagType;
+    set: ValueType[];
+};
+
+export type GenericRangeStatement<TagType, ValueType> = {
+    type: LaxStringEnum<StatementTypes.AttributeInRange>;
+    attributeTag: TagType;
+    lower: ValueType;
+    upper: ValueType;
+};
+
+export type GenericAtomicStatement<TagType, ValueType> =
+    | GenericRevealStatement<TagType>
+    | GenericMembershipStatement<TagType, ValueType>
+    | GenericNonMembershipStatement<TagType, ValueType>
+    | GenericRangeStatement<TagType, ValueType>;
+
+export type RevealProof<ValueType> = {
+    type: StatementTypes.RevealAttribute;
+    proof: string;
+    attribute: ValueType;
+};
+
+// Type for proofs that do not have additional fields
+export type GenericAtomicProof = {
+    type: Exclude<StatementTypes, StatementTypes.RevealAttribute>;
+    proof: string;
+};
+
+export type AtomicProof<ValueType> =
+    | RevealProof<ValueType>
+    | GenericAtomicProof;
diff --git a/packages/common/src/idProofTypes.ts b/packages/common/src/idProofTypes.ts
@@ -5,43 +5,27 @@ import {
     Network,
     Versioned,
 } from '.';
+import {
+    AtomicProof,
+    GenericAtomicStatement,
+    GenericMembershipStatement,
+    GenericNonMembershipStatement,
+    GenericRangeStatement,
+    GenericRevealStatement,
+} from './commonProofTypes';
 
-export enum StatementTypes {
-    RevealAttribute = 'RevealAttribute',
-    AttributeInSet = 'AttributeInSet',
-    AttributeNotInSet = 'AttributeNotInSet',
-    AttributeInRange = 'AttributeInRange',
-}
-
-export type RevealStatement = {
-    type: StatementTypes.RevealAttribute;
-    attributeTag: AttributeKey;
-};
-
-export type MembershipStatement = {
-    type: StatementTypes.AttributeInSet;
-    attributeTag: AttributeKey;
-    set: string[];
-};
-
-export type NonMembershipStatement = {
-    type: StatementTypes.AttributeNotInSet;
-    attributeTag: AttributeKey;
-    set: string[];
-};
-
-export type RangeStatement = {
-    type: StatementTypes.AttributeInRange;
-    attributeTag: AttributeKey;
-    lower: string;
-    upper: string;
-};
+export type RangeStatement = GenericRangeStatement<AttributeKey, string>;
+export type NonMembershipStatement = GenericNonMembershipStatement<
+    AttributeKey,
+    string
+>;
+export type MembershipStatement = GenericMembershipStatement<
+    AttributeKey,
+    string
+>;
+export type RevealStatement = GenericRevealStatement<AttributeKey>;
 
-export type AtomicStatement =
-    | RevealStatement
-    | MembershipStatement
-    | NonMembershipStatement
-    | RangeStatement;
+export type AtomicStatement = GenericAtomicStatement<AttributeKey, string>;
 export type IdStatement = AtomicStatement[];
 
 export type IdProofInput = {
@@ -56,21 +40,8 @@ export type IdProofInput = {
     challenge: string; // Hex
 };
 
-export type RevealProof = {
-    type: StatementTypes.RevealAttribute;
-    proof: string;
-    attribute: string;
-};
-
-// Type for proofs that do not have additional fields
-export type GenericAtomicProof = {
-    type: Exclude<StatementTypes, StatementTypes.RevealAttribute>;
-    proof: string;
-};
-
-export type AtomicProof = RevealProof | GenericAtomicProof;
 export type IdProof = {
-    proofs: AtomicProof[];
+    proofs: AtomicProof<string>[];
 };
 
 export type IdProofOutput = {

diff --git a/packages/common/src/idProofs.ts b/packages/common/src/idProofs.ts
@@ -13,42 +13,15 @@ import {
     MembershipStatement,
     NonMembershipStatement,
     RangeStatement,
-    StatementTypes,
 } from './idProofTypes';
+import {
+    EU_MEMBERS,
+    MAX_DATE,
+    MIN_DATE,
+    StatementTypes,
+} from './commonProofTypes';
 import { whereAlpha2 } from 'iso-3166-1';
 
-export const MIN_DATE = '18000101';
-export const MAX_DATE = '99990101';
-export const EU_MEMBERS = [
-    'AT',
-    'BE',
-    'BG',
-    'CY',
-    'CZ',
-    'DK',
-    'EE',
-    'FI',
-    'FR',
-    'DE',
-    'GR',
-    'HU',
-    'IE',
-    'IT',
-    'LV',
-    'LT',
-    'LU',
-    'MT',
-    'NL',
-    'PL',
-    'PT',
-    'RO',
-    'SK',
-    'SI',
-    'ES',
-    'SE',
-    'HR',
-];
-
 /**
  * Given a number x, return the date string for x years ago.
  * @param yearsAgo how many years to go back from today

diff --git a/packages/common/src/index.ts b/packages/common/src/index.ts
@@ -32,15 +32,27 @@ export {
     deserializeInitError,
     deserializeTypeValue,
 } from './deserialization';
-export * from './idProofs';
+
+export {
+    StatementTypes,
+    StatementBuilder,
+    MIN_DATE,
+    MAX_DATE,
+    EU_MEMBERS,
+} from './commonProofTypes';
 export * from './idProofTypes';
+export * from './idProofs';
+export * from './web3ProofTypes';
+export * from './web3Proofs';
+
 export * from './signHelpers';
 export * from './versionedTypeHelpers';
 export * from './accountHelpers';
 export * from './blockSummaryHelpers';
 export * from './rewardStatusHelpers';
 export * from './HdWallet';
 export * from './schemaHelpers';
+export * from './web3IdHelpers';
 
 export { getContractName } from './contractHelpers';
 export { isHex, streamToList, wasmToSchema, unwrap } from './util';

diff --git a/packages/common/src/web3IdHelpers.ts b/packages/common/src/web3IdHelpers.ts
@@ -0,0 +1,23 @@
+import * as wasm from '@concordium/rust-bindings';
+import { stringify } from 'json-bigint';
+import { ContractAddress, CryptographicParameters } from './types';
+
+export type VerifyWeb3IdCredentialSignatureInput = {
+    globalContext: CryptographicParameters;
+    signature: string;
+    values: Record<string, string | bigint>;
+    randomness: Record<string, string>;
+    holder: string;
+    issuerPublicKey: string;
+    issuerContract: ContractAddress;
+};
+
+/**
+ * Verifies that the given signature is correct for the given values/randomness/holder/issuerPublicKey/issuerContract
+ */
+export function verifyWeb3IdCredentialSignature(
+    input: VerifyWeb3IdCredentialSignatureInput
+): boolean {
+    // Use json-bigint stringify to ensure we can handle bigints
+    return wasm.verifyWeb3IdCredentialSignature(stringify(input));
+}