@libp2p/pubsub 0.0.0 → 1.0.2

package/dist/src/message/sign.d.ts

@@ -0,0 +1,17 @@
+import { PeerId } from '@libp2p/peer-id';
+import type { Message } from '@libp2p/interfaces/pubsub';
+export declare const SignPrefix: Uint8Array;
+/**
+ * Signs the provided message with the given `peerId`
+ */
+export declare function signMessage(peerId: PeerId, message: Message): Promise<Message>;
+/**
+ * Verifies the signature of the given message
+ */
+export declare function verifySignature(message: Message): Promise<boolean>;
+/**
+ * Returns the PublicKey associated with the given message.
+ * If no, valid PublicKey can be retrieved an error will be returned.
+ */
+export declare function messagePublicKey(message: Message): Promise<Uint8Array>;
+//# sourceMappingURL=sign.d.ts.map

package/dist/src/message/sign.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sign.d.ts","sourceRoot":"","sources":["../../../src/message/sign.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AAExC,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAA;AAExD,eAAO,MAAM,UAAU,YAAyC,CAAA;AAEhE;;GAEG;AACH,wBAAsB,WAAW,CAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,oBAyBlE;AAED;;GAEG;AACH,wBAAsB,eAAe,CAAE,OAAO,EAAE,OAAO,oBAyBtD;AAED;;;GAGG;AACH,wBAAsB,gBAAgB,CAAE,OAAO,EAAE,OAAO,uBAyBvD"}

package/dist/src/message/sign.js

@@ -0,0 +1,84 @@
+import * as PeerIdFactory from '@libp2p/peer-id-factory';
+import { RPC } from './rpc.js';
+import { concat as uint8ArrayConcat } from 'uint8arrays/concat';
+import { fromString as uint8ArrayFromString } from 'uint8arrays/from-string';
+import { normalizeOutRpcMessage } from '../utils.js';
+import { PeerId } from '@libp2p/peer-id';
+import { keys } from '@libp2p/crypto';
+export const SignPrefix = uint8ArrayFromString('libp2p-pubsub:');
+/**
+ * Signs the provided message with the given `peerId`
+ */
+export async function signMessage(peerId, message) {
+    // Get the message in bytes, and prepend with the pubsub prefix
+    const bytes = uint8ArrayConcat([
+        SignPrefix,
+        RPC.Message.encode(normalizeOutRpcMessage(message)).finish()
+    ]);
+    if (peerId.privateKey == null) {
+        throw new Error('Cannot sign message, no private key present');
+    }
+    if (peerId.publicKey == null) {
+        throw new Error('Cannot sign message, no public key present');
+    }
+    const privateKey = await keys.unmarshalPrivateKey(peerId.privateKey);
+    const signature = await privateKey.sign(bytes);
+    const outputMessage = {
+        ...message,
+        signature: signature,
+        key: peerId.publicKey
+    };
+    return outputMessage;
+}
+/**
+ * Verifies the signature of the given message
+ */
+export async function verifySignature(message) {
+    if (message.signature == null) {
+        throw new Error('Message must contain a signature to be verified');
+    }
+    if (message.from == null) {
+        throw new Error('Message must contain a from property to be verified');
+    }
+    // Get message sans the signature
+    const bytes = uint8ArrayConcat([
+        SignPrefix,
+        RPC.Message.encode({
+            ...message,
+            signature: undefined,
+            key: undefined
+        }).finish()
+    ]);
+    // Get the public key
+    const pubKeyBytes = await messagePublicKey(message);
+    const pubKey = keys.unmarshalPublicKey(pubKeyBytes);
+    // verify the base message
+    return await pubKey.verify(bytes, message.signature);
+}
+/**
+ * Returns the PublicKey associated with the given message.
+ * If no, valid PublicKey can be retrieved an error will be returned.
+ */
+export async function messagePublicKey(message) {
+    // should be available in the from property of the message (peer id)
+    if (message.from == null) {
+        throw new Error('Could not get the public key from the originator id');
+    }
+    const from = PeerId.fromBytes(message.from);
+    if (message.key != null) {
+        const keyPeerId = await PeerIdFactory.createFromPubKey(keys.unmarshalPublicKey(message.key));
+        // the key belongs to the sender, return the key
+        if (!keyPeerId.equals(from)) {
+            throw new Error('Public Key does not match the originator');
+        }
+        if (keyPeerId.publicKey != null) {
+            return keyPeerId.publicKey;
+        }
+    }
+    else if (from.publicKey != null) {
+        return from.publicKey;
+    }
+    // We couldn't validate pubkey is from the originator, error
+    throw new Error('Could not get the public key from the originator id');
+}
+//# sourceMappingURL=sign.js.map

package/dist/src/message/sign.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sign.js","sourceRoot":"","sources":["../../../src/message/sign.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,aAAa,MAAM,yBAAyB,CAAA;AACxD,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAA;AAC9B,OAAO,EAAE,MAAM,IAAI,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AAC/D,OAAO,EAAE,UAAU,IAAI,oBAAoB,EAAE,MAAM,yBAAyB,CAAA;AAC5E,OAAO,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAA;AACpD,OAAO,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AACxC,OAAO,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAA;AAGrC,MAAM,CAAC,MAAM,UAAU,GAAG,oBAAoB,CAAC,gBAAgB,CAAC,CAAA;AAEhE;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,WAAW,CAAE,MAAc,EAAE,OAAgB;IACjE,+DAA+D;IAC/D,MAAM,KAAK,GAAG,gBAAgB,CAAC;QAC7B,UAAU;QACV,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,sBAAsB,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,EAAE;KAC7D,CAAC,CAAA;IAEF,IAAI,MAAM,CAAC,UAAU,IAAI,IAAI,EAAE;QAC7B,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAA;KAC/D;IAED,IAAI,MAAM,CAAC,SAAS,IAAI,IAAI,EAAE;QAC5B,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAA;KAC9D;IAED,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,UAAU,CAAC,CAAA;IACpE,MAAM,SAAS,GAAG,MAAM,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IAE9C,MAAM,aAAa,GAAY;QAC7B,GAAG,OAAO;QACV,SAAS,EAAE,SAAS;QACpB,GAAG,EAAE,MAAM,CAAC,SAAS;KACtB,CAAA;IAED,OAAO,aAAa,CAAA;AACtB,CAAC;AAED;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,eAAe,CAAE,OAAgB;IACrD,IAAI,OAAO,CAAC,SAAS,IAAI,IAAI,EAAE;QAC7B,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAA;KACnE;IAED,IAAI,OAAO,CAAC,IAAI,IAAI,IAAI,EAAE;QACxB,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAA;KACvE;IAED,iCAAiC;IACjC,MAAM,KAAK,GAAG,gBAAgB,CAAC;QAC7B,UAAU;QACV,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC;YACjB,GAAG,OAAO;YACV,SAAS,EAAE,SAAS;YACpB,GAAG,EAAE,SAAS;SACf,CAAC,CAAC,MAAM,EAAE;KACZ,CAAC,CAAA;IAEF,qBAAqB;IACrB,MAAM,WAAW,GAAG,MAAM,gBAAgB,CAAC,OAAO,CAAC,CAAA;IACnD,MAAM,MAAM,GAAG,IAAI,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAA;IAEnD,0BAA0B;IAC1B,OAAO,MAAM,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,SAAS,CAAC,CAAA;AACtD,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CAAE,OAAgB;IACtD,oEAAoE;IACpE,IAAI,OAAO,CAAC,IAAI,IAAI,IAAI,EAAE;QACxB,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAA;KACvE;IAED,MAAM,IAAI,GAAG,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;IAE3C,IAAI,OAAO,CAAC,GAAG,IAAI,IAAI,EAAE;QACvB,MAAM,SAAS,GAAG,MAAM,aAAa,CAAC,gBAAgB,CAAC,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAA;QAE5F,gDAAgD;QAChD,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE;YAC3B,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAA;SAC5D;QAED,IAAI,SAAS,CAAC,SAAS,IAAI,IAAI,EAAE;YAC/B,OAAO,SAAS,CAAC,SAAS,CAAA;SAC3B;KACF;SAAM,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,EAAE;QACjC,OAAO,IAAI,CAAC,SAAS,CAAA;KACtB;IAED,4DAA4D;IAC5D,MAAM,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAA;AACxE,CAAC"}

package/dist/src/message/topic-descriptor.d.ts

@@ -0,0 +1,254 @@
+import * as $protobuf from 'protobufjs'
+/** Properties of a TopicDescriptor. */
+export interface ITopicDescriptor {
+
+  /** TopicDescriptor name */
+  name?: (string|null)
+
+  /** TopicDescriptor auth */
+  auth?: (TopicDescriptor.IAuthOpts|null)
+
+  /** TopicDescriptor enc */
+  enc?: (TopicDescriptor.IEncOpts|null)
+}
+
+/** Represents a TopicDescriptor. */
+export class TopicDescriptor implements ITopicDescriptor {
+  /**
+   * Constructs a new TopicDescriptor.
+   *
+   * @param [p] - Properties to set
+   */
+  constructor (p?: ITopicDescriptor);
+
+  /** TopicDescriptor name. */
+  public name?: (string|null)
+
+  /** TopicDescriptor auth. */
+  public auth?: (TopicDescriptor.IAuthOpts|null)
+
+  /** TopicDescriptor enc. */
+  public enc?: (TopicDescriptor.IEncOpts|null)
+
+  /** TopicDescriptor _name. */
+  public _name?: 'name'
+
+  /** TopicDescriptor _auth. */
+  public _auth?: 'auth'
+
+  /** TopicDescriptor _enc. */
+  public _enc?: 'enc'
+
+  /**
+   * Encodes the specified TopicDescriptor message. Does not implicitly {@link TopicDescriptor.verify|verify} messages.
+   *
+   * @param m - TopicDescriptor message or plain object to encode
+   * @param [w] - Writer to encode to
+   * @returns Writer
+   */
+  public static encode (m: ITopicDescriptor, w?: $protobuf.Writer): $protobuf.Writer;
+
+  /**
+   * Decodes a TopicDescriptor message from the specified reader or buffer.
+   *
+   * @param r - Reader or buffer to decode from
+   * @param [l] - Message length if known beforehand
+   * @returns TopicDescriptor
+   * @throws {Error} If the payload is not a reader or valid buffer
+   * @throws {$protobuf.util.ProtocolError} If required fields are missing
+   */
+  public static decode (r: ($protobuf.Reader|Uint8Array), l?: number): TopicDescriptor;
+
+  /**
+   * Creates a TopicDescriptor message from a plain object. Also converts values to their respective internal types.
+   *
+   * @param d - Plain object
+   * @returns TopicDescriptor
+   */
+  public static fromObject (d: { [k: string]: any }): TopicDescriptor;
+
+  /**
+   * Creates a plain object from a TopicDescriptor message. Also converts values to other types if specified.
+   *
+   * @param m - TopicDescriptor
+   * @param [o] - Conversion options
+   * @returns Plain object
+   */
+  public static toObject (m: TopicDescriptor, o?: $protobuf.IConversionOptions): { [k: string]: any };
+
+  /**
+   * Converts this TopicDescriptor to JSON.
+   *
+   * @returns JSON object
+   */
+  public toJSON (): { [k: string]: any };
+}
+
+export namespace TopicDescriptor {
+
+  /** Properties of an AuthOpts. */
+  interface IAuthOpts {
+
+    /** AuthOpts mode */
+    mode?: (TopicDescriptor.AuthOpts.AuthMode|null)
+
+    /** AuthOpts keys */
+    keys?: (Uint8Array[]|null)
+  }
+
+  /** Represents an AuthOpts. */
+  class AuthOpts implements IAuthOpts {
+    /**
+     * Constructs a new AuthOpts.
+     *
+     * @param [p] - Properties to set
+     */
+    constructor (p?: TopicDescriptor.IAuthOpts);
+
+    /** AuthOpts mode. */
+    public mode?: (TopicDescriptor.AuthOpts.AuthMode|null)
+
+    /** AuthOpts keys. */
+    public keys: Uint8Array[]
+
+    /** AuthOpts _mode. */
+    public _mode?: 'mode'
+
+    /**
+     * Encodes the specified AuthOpts message. Does not implicitly {@link TopicDescriptor.AuthOpts.verify|verify} messages.
+     *
+     * @param m - AuthOpts message or plain object to encode
+     * @param [w] - Writer to encode to
+     * @returns Writer
+     */
+    public static encode (m: TopicDescriptor.IAuthOpts, w?: $protobuf.Writer): $protobuf.Writer;
+
+    /**
+     * Decodes an AuthOpts message from the specified reader or buffer.
+     *
+     * @param r - Reader or buffer to decode from
+     * @param [l] - Message length if known beforehand
+     * @returns AuthOpts
+     * @throws {Error} If the payload is not a reader or valid buffer
+     * @throws {$protobuf.util.ProtocolError} If required fields are missing
+     */
+    public static decode (r: ($protobuf.Reader|Uint8Array), l?: number): TopicDescriptor.AuthOpts;
+
+    /**
+     * Creates an AuthOpts message from a plain object. Also converts values to their respective internal types.
+     *
+     * @param d - Plain object
+     * @returns AuthOpts
+     */
+    public static fromObject (d: { [k: string]: any }): TopicDescriptor.AuthOpts;
+
+    /**
+     * Creates a plain object from an AuthOpts message. Also converts values to other types if specified.
+     *
+     * @param m - AuthOpts
+     * @param [o] - Conversion options
+     * @returns Plain object
+     */
+    public static toObject (m: TopicDescriptor.AuthOpts, o?: $protobuf.IConversionOptions): { [k: string]: any };
+
+    /**
+     * Converts this AuthOpts to JSON.
+     *
+     * @returns JSON object
+     */
+    public toJSON (): { [k: string]: any };
+  }
+
+  namespace AuthOpts {
+
+    /** AuthMode enum. */
+    enum AuthMode {
+      NONE = 0,
+      KEY = 1,
+      WOT = 2
+    }
+  }
+
+  /** Properties of an EncOpts. */
+  interface IEncOpts {
+
+    /** EncOpts mode */
+    mode?: (TopicDescriptor.EncOpts.EncMode|null)
+
+    /** EncOpts keyHashes */
+    keyHashes?: (Uint8Array[]|null)
+  }
+
+  /** Represents an EncOpts. */
+  class EncOpts implements IEncOpts {
+    /**
+     * Constructs a new EncOpts.
+     *
+     * @param [p] - Properties to set
+     */
+    constructor (p?: TopicDescriptor.IEncOpts);
+
+    /** EncOpts mode. */
+    public mode?: (TopicDescriptor.EncOpts.EncMode|null)
+
+    /** EncOpts keyHashes. */
+    public keyHashes: Uint8Array[]
+
+    /** EncOpts _mode. */
+    public _mode?: 'mode'
+
+    /**
+     * Encodes the specified EncOpts message. Does not implicitly {@link TopicDescriptor.EncOpts.verify|verify} messages.
+     *
+     * @param m - EncOpts message or plain object to encode
+     * @param [w] - Writer to encode to
+     * @returns Writer
+     */
+    public static encode (m: TopicDescriptor.IEncOpts, w?: $protobuf.Writer): $protobuf.Writer;
+
+    /**
+     * Decodes an EncOpts message from the specified reader or buffer.
+     *
+     * @param r - Reader or buffer to decode from
+     * @param [l] - Message length if known beforehand
+     * @returns EncOpts
+     * @throws {Error} If the payload is not a reader or valid buffer
+     * @throws {$protobuf.util.ProtocolError} If required fields are missing
+     */
+    public static decode (r: ($protobuf.Reader|Uint8Array), l?: number): TopicDescriptor.EncOpts;
+
+    /**
+     * Creates an EncOpts message from a plain object. Also converts values to their respective internal types.
+     *
+     * @param d - Plain object
+     * @returns EncOpts
+     */
+    public static fromObject (d: { [k: string]: any }): TopicDescriptor.EncOpts;
+
+    /**
+     * Creates a plain object from an EncOpts message. Also converts values to other types if specified.
+     *
+     * @param m - EncOpts
+     * @param [o] - Conversion options
+     * @returns Plain object
+     */
+    public static toObject (m: TopicDescriptor.EncOpts, o?: $protobuf.IConversionOptions): { [k: string]: any };
+
+    /**
+     * Converts this EncOpts to JSON.
+     *
+     * @returns JSON object
+     */
+    public toJSON (): { [k: string]: any };
+  }
+
+  namespace EncOpts {
+
+    /** EncMode enum. */
+    enum EncMode {
+      NONE = 0,
+      SHAREDKEY = 1,
+      WOT = 2
+    }
+  }
+}