libp2p 0.36.0 → 0.36.2-199395d

package/dist/src/keychain/index.d.ts

@@ -1,4 +1,30 @@
-export = Keychain;
+import { CMS } from './cms.js';
+import 'node-forge/lib/sha512.js';
+import type { PeerId } from '@libp2p/interfaces/peer-id';
+import type { Components } from '@libp2p/interfaces/components';
+export interface DekOptions {
+    hash: string;
+    salt: string;
+    iterationCount: number;
+    keyLength: number;
+}
+export interface KeyChainInit {
+    pass?: string;
+    dek?: DekOptions;
+}
+/**
+ * Information about a key.
+ */
+export interface KeyInfo {
+    /**
+     * The universally unique key id
+     */
+    id: string;
+    /**
+     * The local key name.
+     */
+    name: string;
+}
 /**
  * Manages the lifecycle of a key. Keys are encrypted at rest using PKCS #8.
  *
@@ -7,63 +33,60 @@ export = Keychain;
  * - '/pkcs8/*key-name*', contains the PKCS #8 for the key
  *
  */
-declare class Keychain {
+export declare class KeyChain {
+    private readonly components;
+    private init;
     /**
-     * Generates the options for a keychain.  A random salt is produced.
-     *
-     * @returns {Object}
+     * Creates a new instance of a key chain
      */
-    static generateOptions(): Object;
+    constructor(components: Components, init: KeyChainInit);
     /**
-     * Gets an object that can encrypt/decrypt protected data.
-     * The default options for a keychain.
+     * Gets an object that can encrypt/decrypt protected data
+     * using the Cryptographic Message Syntax (CMS).
      *
-     * @returns {Object}
+     * CMS describes an encapsulation syntax for data protection. It
+     * is used to digitally sign, digest, authenticate, or encrypt
+     * arbitrary message content
      */
-    static get options(): Object;
+    get cms(): CMS;
     /**
-     * Creates a new instance of a key chain.
+     * Generates the options for a keychain.  A random salt is produced.
      *
-     * @param {Datastore} store - where the key are.
-     * @param {KeychainOptions} options
-     * @class
+     * @returns {Object}
      */
-    constructor(store: Datastore, options: KeychainOptions);
-    store: import("interface-datastore").Datastore;
-    opts: any;
+    static generateOptions(): KeyChainInit;
     /**
-     * Gets an object that can encrypt/decrypt protected data
-     * using the Cryptographic Message Syntax (CMS).
-     *
-     * CMS describes an encapsulation syntax for data protection. It
-     * is used to digitally sign, digest, authenticate, or encrypt
-     * arbitrary message content.
+     * Gets an object that can encrypt/decrypt protected data.
+     * The default options for a keychain.
      *
-     * @returns {CMS}
+     * @returns {Object}
      */
-    get cms(): CMS;
+    static get options(): {
+        dek: {
+            keyLength: number;
+            iterationCount: number;
+            salt: string;
+            hash: string;
+        };
+    };
     /**
      * Create a new key.
      *
      * @param {string} name - The local key name; cannot already exist.
      * @param {string} type - One of the key types; 'rsa'.
-     * @param {number} [size = 2048] - The key size in bits. Used for rsa keys only.
-     * @returns {Promise<KeyInfo>}
+     * @param {number} [size = 2048] - The key size in bits. Used for rsa keys only
      */
-    createKey(name: string, type: string, size?: number | undefined): Promise<KeyInfo>;
+    createKey(name: string, type: 'RSA' | 'Ed25519', size?: number): Promise<KeyInfo>;
     /**
      * List all the keys.
      *
      * @returns {Promise<KeyInfo[]>}
      */
-    listKeys(): Promise<KeyInfo[]>;
+    listKeys(): Promise<any[]>;
     /**
-     * Find a key by it's id.
-     *
-     * @param {string} id - The universally unique key identifier.
-     * @returns {Promise<KeyInfo|undefined>}
+     * Find a key by it's id
      */
-    findKeyById(id: string): Promise<KeyInfo | undefined>;
+    findKeyById(id: string): Promise<KeyInfo>;
     /**
      * Find a key by it's name.
      *
@@ -88,12 +111,8 @@ declare class Keychain {
     renameKey(oldName: string, newName: string): Promise<KeyInfo>;
     /**
      * Export an existing key as a PEM encrypted PKCS #8 string
-     *
-     * @param {string} name - The local key name; must already exist.
-     * @param {string} password - The password
-     * @returns {Promise<string>}
      */
-    exportKey(name: string, password: string): Promise<string>;
+    exportKey(name: string, password: string): Promise<any>;
     /**
      * Import a new key from a PEM encoded PKCS #8 string
      *
@@ -105,54 +124,15 @@ declare class Keychain {
     importKey(name: string, pem: string, password: string): Promise<KeyInfo>;
     /**
      * Import a peer key
-     *
-     * @param {string} name - The local key name; must not already exist.
-     * @param {PeerId} peer - The PEM encoded PKCS #8 string
-     * @returns {Promise<KeyInfo>}
      */
     importPeer(name: string, peer: PeerId): Promise<KeyInfo>;
     /**
-     * Gets the private key as PEM encoded PKCS #8 string.
-     *
-     * @param {string} name
-     * @returns {Promise<string>}
+     * Gets the private key as PEM encoded PKCS #8 string
      */
-    _getPrivateKey(name: string): Promise<string>;
+    getPrivateKey(name: string): Promise<string>;
     /**
-     * Rotate keychain password and re-encrypt all assosciated keys
-     *
-     * @param {string} oldPass - The old local keychain password
-     * @param {string} newPass - The new local keychain password
+     * Rotate keychain password and re-encrypt all associated keys
      */
-    rotateKeychainPass(oldPass: string, newPass: string): Promise<undefined>;
-}
-declare namespace Keychain {
-    export { PeerId, Datastore, DekOptions, KeychainOptions, KeyInfo };
+    rotateKeychainPass(oldPass: string, newPass: string): Promise<void>;
 }
-import CMS = require("./cms");
-/**
- * Information about a key.
- */
-type KeyInfo = {
-    /**
-     * - The universally unique key id.
-     */
-    id: string;
-    /**
-     * - The local key name.
-     */
-    name: string;
-};
-type PeerId = import('peer-id');
-type Datastore = import('interface-datastore').Datastore;
-type KeychainOptions = {
-    pass?: string | undefined;
-    dek?: DekOptions | undefined;
-};
-type DekOptions = {
-    hash: string;
-    salt: string;
-    iterationCount: number;
-    keyLength: number;
-};
 //# sourceMappingURL=index.d.ts.map

package/dist/src/keychain/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/keychain/index.js"],"names":[],"mappings":";AAmHA;;;;;;;GAOG;AACH;IAwDE;;;;OAIG;IACH,0BAFa,MAAM,CAOlB;IAED;;;;;OAKG;IACH,6BAEC;IA3ED;;;;;;OAMG;IACH,mBAJW,SAAS,WACT,eAAe,EAmCzB;IA5BC,+CAAkB;IAElB,UAAiD;IA4BnD;;;;;;;;;OASG;IACH,eAEC;IAwBD;;;;;;;OAOG;IACH,gBALW,MAAM,QACN,MAAM,8BAEJ,QAAQ,OAAO,CAAC,CAiD5B;IAED;;;;OAIG;IACH,YAFa,QAAQ,OAAO,EAAE,CAAC,CAc9B;IAED;;;;;OAKG;IACH,gBAHW,MAAM,GACJ,QAAQ,OAAO,GAAC,SAAS,CAAC,CAStC;IAED;;;;;OAKG;IACH,oBAHW,MAAM,GACJ,QAAQ,OAAO,CAAC,CAc5B;IAED;;;;;OAKG;IACH,gBAHW,MAAM,GACJ,QAAQ,OAAO,CAAC,CAc5B;IAED;;;;;;OAMG;IACH,mBAJW,MAAM,WACN,MAAM,GACJ,QAAQ,OAAO,CAAC,CAkC5B;IAED;;;;;;OAMG;IACH,gBAJW,MAAM,YACN,MAAM,GACJ,QAAQ,MAAM,CAAC,CAqB3B;IAED;;;;;;;OAOG;IACH,gBALW,MAAM,OACN,MAAM,YACN,MAAM,GACJ,QAAQ,OAAO,CAAC,CAyC5B;IAED;;;;;;OAMG;IACH,iBAJW,MAAM,QACN,MAAM,GACJ,QAAQ,OAAO,CAAC,CAiC5B;IAED;;;;;OAKG;IACH,qBAHW,MAAM,GACJ,QAAQ,MAAM,CAAC,CAc3B;IAED;;;;;OAKG;IACH,4BAHW,MAAM,WACN,MAAM,sBA2ChB;CACF;;;;;;;;;;;;QAtgBa,MAAM;;;;UACN,MAAM;;cArBP,OAAO,SAAS,CAAC;iBACjB,OAAO,qBAAqB,EAAE,SAAS;;;;;;UAKtC,MAAM;UACN,MAAM;oBACN,MAAM;eACN,MAAM"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/keychain/index.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAA;AAK9B,OAAO,0BAA0B,CAAA;AAEjC,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAA;AACxD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAA;AAK/D,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,cAAc,EAAE,MAAM,CAAA;IACtB,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,YAAY;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,GAAG,CAAC,EAAE,UAAU,CAAA;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;CACb;AA6DD;;;;;;;GAOG;AACH,qBAAa,QAAQ;IACnB,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAY;IACvC,OAAO,CAAC,IAAI,CAAc;IAE1B;;OAEG;gBACU,UAAU,EAAE,UAAU,EAAE,IAAI,EAAE,YAAY;IA8BvD;;;;;;;OAOG;IACH,IAAI,GAAG,QAUN;IAED;;;;OAIG;IACH,MAAM,CAAC,eAAe,IAAK,YAAY;IAOvC;;;;;OAKG;IACH,MAAM,KAAK,OAAO;;;;;;;MAEjB;IAED;;;;;;OAMG;IACG,SAAS,CAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,GAAG,SAAS,EAAE,IAAI,SAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IA0DtF;;;;OAIG;IACG,QAAQ;IAad;;OAEG;IACG,WAAW,CAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAUhD;;;;;OAKG;IACG,aAAa,CAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAiBpD;;;;;OAKG;IACG,SAAS,CAAE,IAAI,EAAE,MAAM;IAc7B;;;;;;OAMG;IACG,SAAS,CAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAuCpE;;OAEG;IACG,SAAS,CAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;IA6B/C;;;;;;;OAOG;IACG,SAAS,CAAE,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAoD/E;;OAEG;IACG,UAAU,CAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAyC/D;;OAEG;IACG,aAAa,CAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAiBnD;;OAEG;IACG,kBAAkB,CAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;CAmD3D"}