feat: ECDSAKeyIdentity

.github/workflows/e2e-tests.yml

@@ -31,7 +31,6 @@ jobs:
       - run: npm install -g npm
 
       - run: npm install
-      - run: npm run lint --workspaces --if-present
 
       # build monorepo incl. each subpackage
       - run: npm run build --workspaces --if-present
@@ -47,3 +46,13 @@ jobs:
         env:
           CI: true
           REPLICA_PORT: 8000
+
+  aggregate:
+    name: e2e:required
+    if: ${{ always() }}
+    needs: [ test ]
+    runs-on: ubuntu-latest
+    steps:
+      - name: check e2e test result
+        if: ${{ needs.test.result != 'success' }}
+        run: exit 1

.github/workflows/lint.yml

@@ -0,0 +1,30 @@
+name: Check Lint
+on:
+  pull_request:
+    types:
+      - opened
+      - reopened
+      - edited
+      - synchronize
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: true
+      matrix:
+        os: [ubuntu-18.04]
+        ghc: ['8.8.4']
+        spec:
+          - release-0.16 # https://github.com/dfinity-lab/ic-ref/tree/release-0.16
+        node:
+          - 14
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node.js ${{ matrix.node }}
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node }}
+      - run: npm install -g npm
+      - run: npm install
+      - run: npm run lint --workspaces --if-present

.github/workflows/mitm.yml

@@ -63,3 +63,13 @@ jobs:
           REPLICA_PORT: 8888
           MITM: true
         run: npm run mitm --workspaces --if-present
+
+  aggregate:
+    name: mitm:required
+    if: ${{ always() }}
+    needs: [ test ]
+    runs-on: ubuntu-latest
+    steps:
+      - name: check e2e test result
+        if: ${{ needs.test.result != 'success' }}
+        run: exit 1

.github/workflows/prettier.yml

@@ -28,3 +28,13 @@ jobs:
       - run: npm install -g npm
       - run: npm install prettier pretty-quick
       - run: npm run prettier:check
+
+  aggregate:
+    name: format:required
+    if: ${{ always() }}
+    needs: [ test ]
+    runs-on: ubuntu-latest
+    steps:
+      - name: check e2e test result
+        if: ${{ needs.test.result != 'success' }}
+        run: exit 1

.github/workflows/unit-tests.yml

@@ -33,7 +33,6 @@ jobs:
       - run: npm install -g npm
 
       - run: npm install
-      - run: npm run lint --workspaces --if-present
 
       # build monorepo incl. each subpackage
       - run: npm run build --workspaces --if-present
@@ -42,3 +41,13 @@ jobs:
       - run: npm run test
         env:
           CI: true
+
+  aggregate:
+    name: unit:required
+    if: ${{ always() }}
+    needs: [ test ]
+    runs-on: ubuntu-latest
+    steps:
+      - name: check e2e test result
+        if: ${{ needs.test.result != 'success' }}
+        run: exit 1

demos/ledgerhq/package.json

@@ -2,18 +2,19 @@
   "name": "ic-agent-ledgerhq-app",
   "private": true,
   "dependencies": {
-    "@dfinity/agent": "^0.12.0",
-    "@dfinity/authentication": "^0.12.0",
-    "@dfinity/identity": "^0.12.0",
-    "@dfinity/identity-ledgerhq": "^0.12.0",
-    "@dfinity/principal": "^0.12.0",
+    "@dfinity/agent": "^0.12.1",
+    "@dfinity/authentication": "^0.12.1",
+    "@dfinity/identity": "^0.12.1",
+    "@dfinity/identity-ledgerhq": "^0.12.1",
+    "@dfinity/principal": "^0.12.1",
     "assert": "^2.0.0",
     "buffer": "^6.0.3",
     "events": "^3.2.0",
     "html-webpack-plugin": "^5.1.0",
     "process": "^0.11.10",
     "protobufjs": "^6.10.2",
     "stream-browserify": "^3.0.0",
+    "ts-node": "^10.8.2",
     "util": "^0.12.3",
     "webpack": "^5.24.1",
     "webpack-cli": "^4.5.0",
@@ -27,5 +28,5 @@
     "test:coverage": "",
     "test": ""
   },
-  "version": "0.12.0"
+  "version": "0.12.1"
 }

demos/sample-javascript/package.json

@@ -2,15 +2,16 @@
   "name": "ic-agent-sample-javascript-app",
   "private": true,
   "dependencies": {
-    "@dfinity/agent": "^0.12.0",
-    "@dfinity/authentication": "^0.12.0",
-    "@dfinity/identity": "^0.12.0",
-    "@dfinity/principal": "^0.12.0",
+    "@dfinity/agent": "^0.12.1",
+    "@dfinity/authentication": "^0.12.1",
+    "@dfinity/identity": "^0.12.1",
+    "@dfinity/principal": "^0.12.1",
     "assert": "^2.0.0",
     "events": "^3.2.0",
     "html-webpack-plugin": "^5.1.0",
     "process": "^0.11.10",
     "stream-browserify": "^3.0.0",
+    "ts-node": "^10.8.2",
     "util": "^0.12.3",
     "webpack": "^5.24.1",
     "webpack-cli": "^4.5.0",
@@ -24,5 +25,5 @@
     "test:coverage": "",
     "test": ""
   },
-  "version": "0.12.0"
+  "version": "0.12.1"
 }

docs/generated/changelog.html

@@ -10,8 +10,19 @@
     <h1>Agent-JS Changelog</h1>
 
     <section>
+      <h2>Version 0.12.2</h2>
+      <ul>
+        <li>
+          Support for the SubtleCrypto interface in @dfinity/identity using the new ECDSAKeyIdentity
+        </li>
+      </ul>
       <h2>Version 0.12.1</h2>
       <ul>
+        <li>Adds inline sourcemaps to packages</li>
+        <li>
+          Pulls lint out to a separate job now that Node 12 is failing with latest eslint
+          dependencies
+        </li>
         <li>Adds UTF-8 as an encoding option for CanisterStatus custom paths</li>
         <li>
           Adds a public method "createReadStateRequest" that creates the request for "readState".

e2e/node/basic/identity.test.ts

@@ -10,6 +10,7 @@ import {
   DelegationIdentity,
   Ed25519KeyIdentity,
   Secp256k1KeyIdentity,
+  ECDSAKeyIdentity,
 } from '@dfinity/identity';
 import agent from '../utils/agent';
 import identityCanister from '../canisters/identity';
@@ -26,6 +27,54 @@ function createSecpIdentity(seed: number): SignIdentity {
   return Secp256k1KeyIdentity.generate(new Uint8Array(seed1));
 }
 
+async function createEcdsaIdentity(): Promise<ECDSAKeyIdentity> {
+  const goldenSeed = {
+    key_ops: [],
+    ext: true,
+    kty: 'EC',
+    x: 'EaSQG1HdU7pMzMXaIjZmDGZCa2wit-JX95cuLjZXsZI',
+    y: '-z31VJQ1dNFRkg-eFdet9SPatYph0OPz5vbju0eeT6o',
+    crv: 'P-256',
+  };
+
+  const goldenPrivateKey = {
+    key_ops: [],
+    ext: true,
+    kty: 'EC',
+    x: 'wUmIVyFHanPKCknjOWlMFFr9OKSahY7p5yT1vn4D-kw',
+    y: 'KhYIS2VFq98PU08q1KGYidRfEJ2qV-EUrfaRQ4XbV_4',
+    crv: 'P-256',
+  };
+
+  const getTestKeyPair = async (): Promise<CryptoKeyPair> => {
+    const privateKey = await crypto.subtle.importKey(
+      'jwk',
+      goldenPrivateKey,
+      {
+        name: 'ECDSA',
+        namedCurve: 'P-256',
+      },
+      true,
+      [],
+    );
+    const publicKey = await crypto.subtle.importKey(
+      'jwk',
+      goldenSeed,
+      {
+        name: 'ECDSA',
+        namedCurve: 'P-256',
+      },
+      true,
+      [],
+    );
+    return {
+      privateKey,
+      publicKey,
+    };
+  };
+  return await ECDSAKeyIdentity.fromKeyPair(await getTestKeyPair());
+}
+
 async function createIdentityActor(
   seed: number,
   canisterId: Principal,
@@ -58,6 +107,24 @@ async function createSecp256k1IdentityActor(
   }) as any;
 }
 
+async function createEcdsaIdentityActor(
+  canisterId: Principal,
+  idl: IDL.InterfaceFactory,
+  identity?: SignIdentity,
+): Promise<any> {
+  let effectiveIdentity: SignIdentity;
+  if (identity) {
+    effectiveIdentity = identity;
+  } else {
+    effectiveIdentity = await Ed25519KeyIdentity.generate();
+  }
+  const agent1 = new HttpAgent({ source: await agent, identity: effectiveIdentity });
+  return Actor.createActor(idl, {
+    canisterId,
+    agent: agent1,
+  }) as any;
+}
+
 async function installIdentityCanister(): Promise<{
   canisterId: Principal;
   idl: IDL.InterfaceFactory;
@@ -105,6 +172,17 @@ test('identity: two different Secp256k1 keys should have a different principal',
   expect(principal1).not.toEqual(principal2);
 });
 
+jest.setTimeout(30000);
+test('identity: two different Ecdsa keys should have a different principal', async () => {
+  const { canisterId, idl } = await installIdentityCanister();
+  const identity1 = await createEcdsaIdentityActor(canisterId, idl);
+  const identity2 = await createEcdsaIdentityActor(canisterId, idl);
+
+  const principal1 = await identity1.whoami_query();
+  const principal2 = await identity2.whoami_query();
+  expect(principal1).not.toEqual(principal2);
+});
+
 jest.setTimeout(30000);
 test('delegation: principal is the same between delegated keys with secp256k1', async () => {
   const { canisterId, idl } = await installIdentityCanister();

e2e/node/jest.config.ts

@@ -1,6 +1,7 @@
 import type { Config } from '@jest/types';
 const config: Config.InitialOptions = {
   verbose: true,
+  testEnvironment: 'jsdom',
   testPathIgnorePatterns: ['/node_modules/', '/lib/', '/dist/', '/docs/'],
   testMatch: ['**/?(*.)+(spec|test).[jt]s?(x)'],
   roots: [`<rootDir>/e2e/node`],
@@ -12,7 +13,6 @@ const config: Config.InitialOptions = {
     '^.+\\.ts$': 'ts-jest',
   },
   collectCoverageFrom: ['**/*.{ts,tsx}'],
-  name: 'e2e/node',
   displayName: 'e2e-node',
   rootDir: '../..',
 };

e2e/node/package.json

@@ -1,7 +1,7 @@
 {
   "private": true,
   "name": "@do-not-publish/ic-node-e2e-tests",
-  "version": "0.12.0",
+  "version": "0.12.1",
   "scripts": {
     "ci": "npm run e2e",
     "e2e": "jest --verbose",
@@ -16,27 +16,36 @@
     "test": ""
   },
   "dependencies": {
-    "@dfinity/agent": "^0.12.0",
-    "@dfinity/authentication": "^0.12.0",
-    "@dfinity/identity": "^0.12.0",
-    "@dfinity/principal": "^0.12.0",
+    "@dfinity/agent": "^0.12.1",
+    "@dfinity/authentication": "^0.12.1",
+    "@dfinity/identity": "^0.12.1",
+    "@dfinity/principal": "^0.12.1",
     "@trust/webcrypto": "^0.9.2",
-    "@types/base64-js": "^1.2.5",
-    "@types/jest": "^26.0.23",
-    "@types/node": "^13.7.7",
-    "@typescript-eslint/eslint-plugin": "^4.14.2",
-    "@typescript-eslint/parser": "^4.14.2",
-    "eslint": "^7.19.0",
-    "eslint-plugin-jsdoc": "^31.6.0",
-    "jest": "^27.3.1",
-    "node-fetch": "^2.6.7",
+    "@types/base64-js": "^1.3.0",
+    "@types/jest": "^28.1.4",
+    "@typescript-eslint/eslint-plugin": "^5.30.5",
+    "@typescript-eslint/parser": "^5.30.5",
+    "eslint": "^8.19.0",
+    "eslint-plugin-jsdoc": "^39.3.3",
+    "jest": "^28.1.2",
     "text-encoding": "^0.7.0",
-    "ts-jest": "^27.0.7",
-    "ts-node": "^9.1.1",
-    "typescript": "^3.6.3",
-    "whatwg-fetch": "^3.0.0"
+    "ts-jest": "^28.0.5",
+    "ts-node": "^10.8.2",
+    "typescript": "^4.7.4",
+    "whatwg-fetch": "^3.6.2"
   },
-  "jest": {
-    "preset": "ts-jest"
+  "devDependencies": {
+    "@babel/preset-env": "^7.18.6",
+    "@babel/preset-typescript": "^7.18.6",
+    "@peculiar/webcrypto": "^1.4.0",
+    "@tsconfig/node16": "^1.0.3",
+    "@tsconfig/node17": "^1.0.1",
+    "@types/isomorphic-fetch": "^0.0.36",
+    "@types/text-encoding": "^0.0.36",
+    "isomorphic-fetch": "^3.0.0",
+    "jest-environment-jsdom": "^28.1.3",
+    "locus": "^2.0.4",
+    "node-webcrypto-p11": "^2.5.0",
+    "webcrypto-core": "^1.7.5"
   }
 }

e2e/node/test-setup.ts

@@ -5,9 +5,21 @@
 // a feature that JSDom doesn't.
 //
 // Note that we can use webpack configuration to make some features available to
+
 // Node.js in a similar way.
+// import { TextEncoder, TextDecoder } from 'text-encoding'; // eslint-disable-line
+// import fetch from 'isomorphic-fetch';
+// global.crypto = crypto as unknown as Crypto;
+// console.log('subtle', crypto['subtle']); // eslint-disable-line
+// global.TextDecoder = TextDecoder; // eslint-disable-line
+// global.TextEncoder = TextEncoder;
+
+// global.TextDecoder = TextDecoder; // eslint-disable-line
+// (global.fetch as any) = fetch;
+import fetch from 'isomorphic-fetch';
+global.fetch = fetch;
+import * as crypto from 'crypto';
 
-global.crypto = require('@trust/webcrypto');
-global.TextEncoder = require('text-encoding').TextEncoder; // eslint-disable-line
-global.TextDecoder = require('text-encoding').TextDecoder; // eslint-disable-line
-global.fetch = require('node-fetch');
+(global as any).crypto = {
+  subtle: (crypto.webcrypto as any).subtle,
+};