@idos-network/enclave 1.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 idOS Network
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,50 @@
+# idOS Enclave
+
+> ⚖️ Legalities
+>
+> By downloading, installing, or implementing any of the idOS’ SDKs, you acknowledge that you have read and understood idOS’ Privacy Policy and Transparency Document.
+>
+> - <https://www.idos.network/legal/privacy-policy>
+> - <https://www.idos.network/legal/transparency-document>
+
+## Developing the utils locally
+
+```bash
+pnpm build
+```
+
+## Enclave provider
+
+In case you want to build your own enclave (like in a browser-extension) you should use the base or local provider like this:
+
+```typescript
+import type {
+  EncryptionPasswordStore,
+  MPCPasswordContext,
+  PasswordContext,
+} from "@idos-network/enclave";
+import { LocalEnclave, type LocalEnclaveOptions } from "@idos-network/enclave/local";
+
+const ENCLAVE_AUTHORIZED_ORIGINS_KEY = "enclave-authorized-origins";
+
+export class Enclave extends LocalEnclave<LocalEnclaveOptions> {
+  // Override
+}
+```
+
+## MPC
+
+```typescript
+import { idOSClientConfiguration } from "@idos-network/client";
+import { ChromeExtensionStore } from "@idos-network/utils/store";
+import { Enclave as ChromeExtensionEnclave } from "./enclave"; // The custom Enclave from the example above
+
+const configuration = new idOSClientConfiguration<ChromeExtensionEnclave>({
+  nodeUrl: "https://nodes.idos.network",
+  enclaveOptions: {
+    // Your enclave options here
+  },
+  enclaveProvider: ChromeExtensionEnclave,
+  store: new ChromeExtensionStore(),
+});
+```

package/dist/base-0xSNl4rW.d.mts

@@ -0,0 +1,140 @@
+import { g as RemoveAddressMessageToSign, i as AddAddressSignatureMessage, n as AddAddressMessageToSign, v as RemoveAddressSignatureMessage } from "./types-DKsOwtWL.mjs";
+import { EncryptionPasswordStore as EncryptionPasswordStore$1, WalletType } from "@idos-network/kwil-infra/actions";
+import { idOSCredential } from "@idos-network/credentials/types";
+
+//#region src/types.d.ts
+type PublicEncryptionProfile = {
+  userId: string;
+  userEncryptionPublicKey: string;
+  encryptionPasswordStore: EncryptionPasswordStore$1;
+};
+type PrivateEncryptionProfile = {
+  userId: string;
+  password: string;
+  keyPair: nacl.BoxKeyPair;
+  encryptionPasswordStore: EncryptionPasswordStore$1;
+};
+type EnclaveOptions = {
+  theme?: "light" | "dark";
+  mode?: "new" | "existing";
+  userId?: string;
+  expectedUserEncryptionPublicKey?: string;
+  walletAddress?: string;
+  walletPublicKey?: string;
+  walletType?: WalletType;
+  encryptionPasswordStore?: EncryptionPasswordStore$1;
+};
+type PasswordContext = {
+  encryptionPasswordStore: "user";
+  password: string;
+  duration?: number;
+};
+type MPCPasswordContext = {
+  encryptionPasswordStore: "mpc";
+};
+//#endregion
+//#region src/base.d.ts
+declare abstract class BaseProvider<K extends EnclaveOptions = EnclaveOptions> {
+  readonly options: K;
+  protected _signMethod?: (domain: any, types: any, value: any) => Promise<string>;
+  private _signMethodType?;
+  constructor(options: K);
+  /**
+  * Sets the signer for the enclave.
+  *
+  * @param signer - The signer to set, is later used for MPC if allowed.
+  */
+  setSigner(signer: {
+    signTypedData?: (domain: string, types: string[], value: string) => Promise<string>;
+    signMessage?: (message: string) => Promise<any>;
+    signer?: (message: string) => Promise<any>;
+  }): void;
+  signTypedData(domain: any, types: any, value: any): Promise<string>;
+  /**
+  * Helper method to get the user ID.
+  *
+  * @returns The user ID.
+  */
+  get userId(): string;
+  /**
+  * Resets the enclave (storage etc.)
+  */
+  reset(): Promise<void>;
+  /**
+  * Reconfigures the enclave (theme etc).
+  *
+  * @param options - The options to reconfigure.
+  */
+  reconfigure(options?: Partial<K>): Promise<void>;
+  /**
+  * Loads the enclave (create iframe, open connection, etc.)
+  */
+  load(): Promise<void>;
+  /**
+  * Encrypts a message to a receiver.
+  * This method also checks if the user is authorized to use the keys.
+  *
+  * @param _message - The message to encrypt.
+  * @param _receiverPublicKey - The public key of the receiver.
+  *
+  * @returns The encrypted message.
+  */
+  encrypt(_message: Uint8Array, _receiverPublicKey: Uint8Array): Promise<{
+    content: Uint8Array;
+    encryptorPublicKey: Uint8Array;
+  }>;
+  /**
+  * Decrypts a message from a sender.
+  * This method also checks if the user is authorized to use the keys.
+  *
+  * @param _message - The message to decrypt.
+  * @param _senderPublicKey - The public key of the sender.
+  *
+  * @returns The decrypted message.
+  */
+  decrypt(_message: Uint8Array, _senderPublicKey: Uint8Array): Promise<Uint8Array<ArrayBufferLike>>;
+  /**
+  * This method is used to confirm the user action.
+  *
+  * @param _message - The message to confirm.
+  *
+  * @returns `true` if the user action is confirmed, `false` otherwise.
+  */
+  confirm(_message: string): Promise<boolean>;
+  /**
+  * This method is used to backup the password context.
+  */
+  backupUserEncryptionProfile(): Promise<void>;
+  /**
+  * Gets the public encryption profile.
+  *
+  * @returns The public encryption profile.
+  */
+  ensureUserEncryptionProfile(): Promise<PublicEncryptionProfile>;
+  /**
+  * This method authorizes the origin in case of enclave
+  * to use the keys, without user providing the password or MPC again.
+  *
+  * @returns `true` if the user action is authorized, `false` otherwise.
+  */
+  guardKeys(): Promise<boolean>;
+  /**
+  * Filters the credentials based on the private field filters.
+  *
+  * @param credentials - The credentials to filter.
+  * @param privateFieldFilters - The private field filters.
+  *
+  * @returns The filtered credentials without the content.
+  */
+  filterCredentials(credentials: idOSCredential[], privateFieldFilters: {
+    pick: Record<string, unknown[]>;
+    omit: Record<string, unknown[]>;
+  }): Promise<idOSCredential[]>;
+  addAddressMessageToSign(_address: string, _publicKey: string | undefined, _addressToAddType: string): Promise<AddAddressMessageToSign>;
+  removeAddressMessageToSign(_address: string, _publicKey: string | undefined, _addressToRemoveType: string): Promise<RemoveAddressMessageToSign>;
+  addAddressToMpcSecret(_userId: string, _message: AddAddressSignatureMessage, _signature: string): Promise<string>;
+  removeAddressFromMpcSecret(_userId: string, _message: RemoveAddressSignatureMessage, _signature: string): Promise<string>;
+}
+//#endregion
+export { PasswordContext as a, MPCPasswordContext as i, EnclaveOptions as n, PrivateEncryptionProfile as o, EncryptionPasswordStore$1 as r, PublicEncryptionProfile as s, BaseProvider as t };
+//# sourceMappingURL=base-0xSNl4rW.d.mts.map

package/dist/base-0xSNl4rW.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base-0xSNl4rW.d.mts","names":[],"sources":["../src/types.ts","../src/base.ts"],"mappings":";;;;;KAIY,uBAAA;EACV,MAAA;EACA,uBAAA;EACA,uBAAA,EAAyB,yBAAA;AAAA;AAAA,KAGf,wBAAA;EACV,MAAA;EACA,QAAA;EACA,OAAA,EAAS,IAAA,CAAK,UAAA;EACd,uBAAA,EAAyB,yBAAA;AAAA;AAAA,KAGf,cAAA;EACV,KAAA;EACA,IAAA;EACA,MAAA;EACA,+BAAA;EACA,aAAA;EACA,eAAA;EACA,UAAA,GAAa,UAAA;EACb,uBAAA,GAA0B,yBAAA;AAAA;AAAA,KAGhB,eAAA;EACV,uBAAA;EACA,QAAA;EACA,QAAA;AAAA;AAAA,KAGU,kBAAA;EACV,uBAAA;AAAA;;;uBCtBoB,YAAA,WAAuB,cAAA,GAAiB,cAAA;EAAA,SACnD,OAAA,EAAS,CAAA;EAAA,UAGR,WAAA,IAAe,MAAA,OAAa,KAAA,OAAY,KAAA,UAAe,OAAA;EAAA,QACzD,eAAA;EAER,WAAA,CAAY,OAAA,EAAS,CAAA;EDbI;;;;;ECsBzB,SAAA,CAAU,MAAA;IACR,aAAA,IAAiB,MAAA,UAAgB,KAAA,YAAiB,KAAA,aAAkB,OAAA;IAEpE,WAAA,IAAe,OAAA,aAAoB,OAAA;IAEnC,MAAA,IAAU,OAAA,aAAoB,OAAA;EAAA;EA4BhC,aAAA,CAAoB,MAAA,OAAa,KAAA,OAAY,KAAA,QAAa,OAAA;;;;;;MAkDtD,MAAA,CAAA;;;;EAUJ,KAAA,CAAA,GAAe,OAAA;EDzGL;;;;;ECkHV,WAAA,CAAkB,OAAA,GAAS,OAAA,CAAQ,CAAA,IAAU,OAAA;;;;EAO7C,IAAA,CAAA,GAAc,OAAA;;;;;;AD9GhB;;;;EC2HE,OAAA,CACE,QAAA,EAAU,UAAA,EACV,kBAAA,EAAoB,UAAA,GACnB,OAAA;IAAU,OAAA,EAAS,UAAA;IAAY,kBAAA,EAAoB,UAAA;EAAA;ED3HtD;AAGF;;;;;;;;ECqIE,OAAA,CACE,QAAA,EAAU,UAAA,EACV,gBAAA,EAAkB,UAAA,GACjB,OAAA,CAAQ,UAAA,CAAW,eAAA;EA7JF;;;;;;;EAwKpB,OAAA,CAAc,QAAA,WAAmB,OAAA;;;;EAOjC,2BAAA,CAAA,GAAqC,OAAA;;;;;;EASrC,2BAAA,CAAA,GAAqC,OAAA,CAAQ,uBAAA;;;;;;;EAU7C,SAAA,CAAA,GAAmB,OAAA;;;;;;;;;EAYnB,iBAAA,CACE,WAAA,EAAa,cAAA,IACb,mBAAA;IAAuB,IAAA,EAAM,MAAA;IAA2B,IAAA,EAAM,MAAA;EAAA,IAC7D,OAAA,CAAQ,cAAA;EAoDX,uBAAA,CACE,QAAA,UACA,UAAA,sBACA,iBAAA,WACC,OAAA,CAAQ,uBAAA;EAIX,0BAAA,CACE,QAAA,UACA,UAAA,sBACA,oBAAA,WACC,OAAA,CAAQ,0BAAA;EAIX,qBAAA,CACE,OAAA,UACA,QAAA,EAAU,0BAAA,EACV,UAAA,WACC,OAAA;EAIH,0BAAA,CACE,OAAA,UACA,QAAA,EAAU,6BAAA,EACV,UAAA,WACC,OAAA;AAAA"}