feat: Backup and Restore (#215)

Signed-off-by: Curtis Harding <[email protected]>

.vscode/launch.json

@@ -32,7 +32,6 @@
       "request": "launch",
       "program": "${workspaceRoot}/node_modules/jest/bin/jest.js",
       "args": [
-        "${fileBasenameNoExtension}",
         "--colors",
         "--workerThreads",
         "--detectOpenHandles",
@@ -44,6 +43,24 @@
         "${workspaceRoot}/../../node_modules/**/*",
         "<node_internals>/**/*"
       ]
+    },
+    {
+      "name": "TEST:file",
+      "type": "node",
+      "request": "launch",
+      "program": "${workspaceRoot}/node_modules/jest/bin/jest.js",
+      "args": [
+        "--colors",
+        "--workerThreads",
+        "--detectOpenHandles",
+        "--maxWorkers",
+        "1",
+        "${fileBasenameNoExtension}",
+      ],
+      "skipFiles": [
+        "${workspaceRoot}/../../node_modules/**/*",
+        "<node_internals>/**/*"
+      ]
     }
   ]
-}
+}

docs/examples/Backup.md

@@ -0,0 +1,27 @@
+# Edge SDK Backup & Restore
+
+## Requirements
+1. SDK A - a used instance with data in the store.
+2. SDK B - an unused instance, with an empty store.
+
+
+## Flow
+1. SDK A creates a Backup `jwe`
+2. SDK B restores from the `jwe`
+
+
+## Code Reference
+* Create the `jwe` using the Agent function provided.
+
+Example 
+```TS
+const jwe = await Agent_a.backup.createJWE();
+```
+
+* Transfer the `jwe` to another SDK.
+* Restore from the `jwe` using the Agent function provided.
+
+Example
+```TS
+await Agent_b.backup.restore(jwe);
+```

package.json

@@ -180,9 +180,10 @@
     "outputName": "junit.xml"
   },
   "dependencies": {
-    "@atala/apollo": "~1.2.16",
+    "@atala/apollo": "^1.3.4",
     "@scure/bip32": "^1.3.0",
     "@scure/bip39": "^1.1.1",
+    "@sinclair/typebox": "^0.32.31",
     "@stablelib/base64": "^1.0.1",
     "@stablelib/sha256": "^1.0.1",
     "@stablelib/uuid": "^1.0.2",
@@ -210,4 +211,4 @@
   "overrides": {
     "crypto-js": "^4.2.0"
   }
-}
+}

src/apollo/Apollo.ts

@@ -30,13 +30,14 @@ import { Secp256k1PublicKey } from "./utils/Secp256k1PublicKey";
 import { Ed25519PublicKey } from "./utils/Ed25519PublicKey";
 import { X25519PublicKey } from "./utils/X25519PublicKey";
 
-import ApolloPKG from "@atala/apollo";
 import { DerivationPath } from "./utils/derivation/DerivationPath";
-
-const ApolloSDK = ApolloPKG.io.iohk.atala.prism.apollo;
+import { notEmptyString } from "../utils";
+import ApolloPKG from "@atala/apollo";
+const ApolloSDK = ApolloPKG.org.hyperledger.identus.apollo;
 const Mnemonic = ApolloSDK.derivation.Mnemonic.Companion;
 const HDKey = ApolloSDK.derivation.HDKey;
 const BigIntegerWrapper = ApolloSDK.derivation.BigIntegerWrapper;
+
 /**
  * Apollo defines the set of cryptographic operations.
  *
@@ -274,6 +275,18 @@ export default class Apollo implements ApolloInterface, KeyRestoration {
         if (keyData) {
           return new Ed25519PrivateKey(keyData);
         }
+
+        const seedHex = parameters[KeyProperties.seed];
+        if (notEmptyString(seedHex)) {
+          const derivationParam = parameters[KeyProperties.derivationPath] ?? "m/0'/0'/0'";
+          const derivationPath = DerivationPath.from(derivationParam);
+          const seed = Int8Array.from(Buffer.from(seedHex, "hex"));
+          const hdKey = ApolloSDK.derivation.EdHDKey.Companion.initFromSeed(seed).derive(derivationPath.toString());
+          const edKey = Ed25519PrivateKey.from.Buffer(Buffer.from(hdKey.privateKey));
+
+          return edKey;
+        }
+
         const keyPair = Ed25519KeyPair.generateKeyPair();
         return keyPair.privateKey;
       }
@@ -322,6 +335,19 @@ export default class Apollo implements ApolloInterface, KeyRestoration {
         if (keyData) {
           return new X25519PrivateKey(keyData);
         }
+
+        const seedHex = parameters[KeyProperties.seed];
+        if (notEmptyString(seedHex)) {
+          const derivationParam = parameters[KeyProperties.derivationPath] ?? "m/0'/0'/0'";
+          const derivationPath = DerivationPath.from(derivationParam);
+          const seed = Int8Array.from(Buffer.from(seedHex, "hex"));
+          const hdKey = ApolloSDK.derivation.EdHDKey.Companion.initFromSeed(seed).derive(derivationPath.toString());
+          const edKey = Ed25519PrivateKey.from.Buffer(Buffer.from(hdKey.privateKey));
+          const xKey = edKey.x25519();
+
+          return xKey;
+        }
+
         const keyPair = X25519KeyPair.generateKeyPair();
         return keyPair.privateKey;
       }

src/apollo/utils/Ed25519KeyPair.ts

@@ -1,7 +1,8 @@
-import ApolloBaseAsymmetricEncryption from "@atala/apollo";
 import { KeyPair } from "../../domain";
 import { Ed25519PrivateKey } from "./Ed25519PrivateKey";
 import { Ed25519PublicKey } from "./Ed25519PublicKey";
+import ApolloPKG from "@atala/apollo";
+const ApolloSDK = ApolloPKG.org.hyperledger.identus.apollo;
 
 /**
  * @ignore
@@ -15,8 +16,7 @@ export class Ed25519KeyPair extends KeyPair {
   }
 
   static generateKeyPair() {
-    const keyPair =
-      ApolloBaseAsymmetricEncryption.io.iohk.atala.prism.apollo.utils.KMMEdKeyPair.Companion.generateKeyPair();
+    const keyPair = ApolloSDK.utils.KMMEdKeyPair.Companion.generateKeyPair();
 
     return new Ed25519KeyPair(
       new Ed25519PrivateKey(keyPair.privateKey.raw),

src/apollo/utils/Ed25519PrivateKey.ts

@@ -1,5 +1,5 @@
-import ApolloPkg from "@atala/apollo";
 import { Ed25519PublicKey } from "./Ed25519PublicKey";
+import { X25519PrivateKey } from "./X25519PrivateKey";
 import {
   Curve,
   ExportableKey,
@@ -11,6 +11,8 @@ import {
   SignableKey
 } from "../../domain";
 
+import ApolloPKG from "@atala/apollo";
+const ApolloSDK = ApolloPKG.org.hyperledger.identus.apollo;
 
 /**
  * @ignore
@@ -48,15 +50,17 @@ export class Ed25519PrivateKey extends PrivateKey implements ExportableKey, Sign
     return Buffer.from(signature);
   }
 
+  x25519() {
+    const key = this.getInstance().x25519PrivateKey();
+    return X25519PrivateKey.from.Buffer(key.raw);
+  }
+
   private getInstance(
     value?: Int8Array | Uint8Array
-  ): ApolloPkg.io.iohk.atala.prism.apollo.utils.KMMEdPrivateKey {
+  ) {
     // eslint-disable-next-line no-extra-boolean-cast
     const bytes = !!value ? Buffer.from(value) : this.raw;
-    const instance =
-      new ApolloPkg.io.iohk.atala.prism.apollo.utils.KMMEdPrivateKey(
-        Int8Array.from(bytes)
-      );
+    const instance = new ApolloSDK.utils.KMMEdPrivateKey(Int8Array.from(bytes));
 
     return instance;
   }

src/apollo/utils/Ed25519PublicKey.ts

@@ -1,4 +1,3 @@
-import ApolloPkg from "@atala/apollo";
 import {
   Curve,
   ExportableKey,
@@ -10,6 +9,9 @@ import {
   VerifiableKey
 } from "../../domain";
 
+import ApolloPKG from "@atala/apollo";
+const ApolloSDK = ApolloPKG.org.hyperledger.identus.apollo;
+
 /**
  * @ignore
  */
@@ -46,13 +48,10 @@ export class Ed25519PublicKey extends PublicKey implements ExportableKey, Storab
 
   private getInstance(
     value?: Int8Array | Uint8Array
-  ): ApolloPkg.io.iohk.atala.prism.apollo.utils.KMMEdPublicKey {
+  ) {
     // eslint-disable-next-line no-extra-boolean-cast
     const bytes = !!value ? Buffer.from(value) : this.raw;
-    const instance =
-      new ApolloPkg.io.iohk.atala.prism.apollo.utils.KMMEdPublicKey(
-        Int8Array.from(bytes)
-      );
+    const instance = new ApolloSDK.utils.KMMEdPublicKey(Int8Array.from(bytes));
 
     return instance;
   }

src/apollo/utils/Secp256k1KeyPair.ts

@@ -1,9 +1,8 @@
 import { KeyPair, MnemonicWordList } from "../../domain";
-
 import { Secp256k1PrivateKey } from "./Secp256k1PrivateKey";
 import { Secp256k1PublicKey } from "./Secp256k1PublicKey";
-
-import * as ApolloPKG from "@atala/apollo";
+import ApolloPKG from "@atala/apollo";
+const ApolloSDK = ApolloPKG.org.hyperledger.identus.apollo;
 
 /**
  * @ignore
@@ -17,16 +16,7 @@ export class Secp256k1KeyPair extends KeyPair {
   }
 
   static generateKeyPair() {
-    const {
-      io: {
-        iohk: {
-          atala: {
-            prism: { apollo },
-          },
-        },
-      },
-    } = ApolloPKG;
-    const Mnemonic = apollo.derivation.Mnemonic.Companion;
+    const Mnemonic = ApolloSDK.derivation.Mnemonic.Companion;
     const mnemonics = Mnemonic.createRandomMnemonics() as MnemonicWordList;
     const seed = Mnemonic.createSeed(mnemonics, `mnemonic`);
     const priv = new Secp256k1PrivateKey(Uint8Array.from(seed.slice(0, 32)));

src/apollo/utils/Secp256k1PrivateKey.ts

@@ -1,4 +1,3 @@
-import ApolloPkg from "@atala/apollo";
 import BN from "bn.js";
 
 import * as ECConfig from "../../config/ECConfig";
@@ -14,9 +13,10 @@ import {
   StorableKey,
 } from "../../domain/models/keyManagement";
 
-const Apollo = ApolloPkg.io.iohk.atala.prism.apollo;
-const HDKey = Apollo.derivation.HDKey;
-const BigIntegerWrapper = Apollo.derivation.BigIntegerWrapper;
+import ApolloPKG from "@atala/apollo";
+const ApolloSDK = ApolloPKG.org.hyperledger.identus.apollo;
+const HDKey = ApolloSDK.derivation.HDKey;
+const BigIntegerWrapper = ApolloSDK.derivation.BigIntegerWrapper;
 
 /**
  * @ignore
@@ -36,7 +36,7 @@ export class Secp256k1PrivateKey
   static from = ImportableKey.factory(Secp256k1PrivateKey, { pemLabel: "EC PRIVATE KEY" });
 
   private get native() {
-    return Apollo.utils.KMMECSecp256k1PrivateKey.Companion.secp256k1FromByteArray(
+    return ApolloSDK.utils.KMMECSecp256k1PrivateKey.Companion.secp256k1FromByteArray(
       Int8Array.from(this.raw)
     );
   }

src/apollo/utils/Secp256k1PublicKey.ts

@@ -1,4 +1,3 @@
-import ApolloPkg from "@atala/apollo";
 import BN from "bn.js";
 import BigInteger from "bn.js";
 
@@ -13,6 +12,9 @@ import {
   VerifiableKey
 } from "../../domain/models/keyManagement";
 
+import ApolloPKG from "@atala/apollo";
+const ApolloSDK = ApolloPKG.org.hyperledger.identus.apollo;
+
 /**
  * @ignore
  */
@@ -35,7 +37,7 @@ export class Secp256k1PublicKey extends PublicKey implements StorableKey, Export
   }
 
   private get native() {
-    return ApolloPkg.io.iohk.atala.prism.apollo.utils.KMMECSecp256k1PublicKey.Companion.secp256k1FromBytes(
+    return ApolloSDK.utils.KMMECSecp256k1PublicKey.Companion.secp256k1FromBytes(
       Int8Array.from(this.raw)
     );
   }
@@ -143,7 +145,7 @@ export class Secp256k1PublicKey extends PublicKey implements StorableKey, Export
   static secp256k1FromBytes(encoded: Uint8Array): Secp256k1PublicKey {
     return new Secp256k1PublicKey(
       Uint8Array.from(
-        ApolloPkg.io.iohk.atala.prism.apollo.utils.KMMECSecp256k1PublicKey.Companion.secp256k1FromBytes(
+        ApolloSDK.utils.KMMECSecp256k1PublicKey.Companion.secp256k1FromBytes(
           Int8Array.from(encoded)
         ).raw
       )
@@ -178,7 +180,7 @@ export class Secp256k1PublicKey extends PublicKey implements StorableKey, Export
     const xCoord = Buffer.from(x.toArray());
     const yCoord = Buffer.from(y.toArray());
     const publicKey =
-      ApolloPkg.io.iohk.atala.prism.apollo.utils.KMMECSecp256k1PublicKey.Companion.secp256k1FromByteCoordinates(
+      ApolloSDK.utils.KMMECSecp256k1PublicKey.Companion.secp256k1FromByteCoordinates(
         Int8Array.from(xCoord),
         Int8Array.from(yCoord)
       );