@dxos/network-manager 2.33.8-dev.8609bc45 → 2.33.9-dev.002e8917

package/src/network-manager.ts

@@ -2,8 +2,8 @@
 // Copyright 2020 DXOS.org
 //
 
-import assert from 'assert';
 import debug from 'debug';
+import assert from 'node:assert';
 
 import { Event } from '@dxos/async';
 import { GreetingCommandPlugin, ERR_GREET_ALREADY_CONNECTED_TO_SWARM } from '@dxos/credentials';
@@ -12,7 +12,9 @@ import { PublicKey } from '@dxos/protocols';
 import { ComplexMap } from '@dxos/util';
 
 import { ConnectionLog } from './connection-log';
-import { InMemorySignalManager, SignalManager, SignalApi, WebsocketSignalManager } from './signal';
+import { Message } from './proto/gen/dxos/mesh/signal';
+import { InMemorySignalManager, SignalManager, WebsocketSignalManager } from './signal';
+import { MessageRouter } from './signal/message-router';
 import { Swarm, SwarmMapper } from './swarm';
 import { Topology } from './topology';
 import { createWebRTCTransportFactory, inMemoryTransportFactory } from './transport';
@@ -38,6 +40,7 @@ export class NetworkManager {
   private readonly _swarms = new ComplexMap<PublicKey, Swarm>(key => key.toHex());
   private readonly _maps = new ComplexMap<PublicKey, SwarmMapper>(key => key.toHex());
   private readonly _signalManager: SignalManager;
+  private readonly _messageRouter: MessageRouter;
   private readonly _connectionLog?: ConnectionLog;
 
   public readonly topicsUpdated = new Event<void>();
@@ -45,8 +48,8 @@ export class NetworkManager {
   constructor (options: NetworkManagerOptions = {}) {
     this._ice = options.ice ?? [];
 
-    const onOffer = async (message: SignalApi.SignalMessage) =>
-      await this._swarms.get(message.topic)?.onOffer(message) ?? { accept: false };
+    const onOffer = async (message: Message) =>
+      await this._swarms.get(message.topic!)?.onOffer(message) ?? { accept: false };
 
     this._signalManager = options.signal
       ? new WebsocketSignalManager(options.signal, onOffer)
@@ -54,8 +57,14 @@ export class NetworkManager {
 
     this._signalManager.peerCandidatesChanged
       .on(([topic, candidates]) => this._swarms.get(topic)?.onPeerCandidatesChanged(candidates));
-    this._signalManager.onSignal
-      .on(msg => this._swarms.get(msg.topic)?.onSignal(msg));
+
+    this._signalManager.onSignal.on(msg => this._messageRouter.receiveMessage(msg));
+
+    this._messageRouter = new MessageRouter({
+      sendMessage: msg => this._signalManager.signal(msg),
+      onSignal: async (msg) => this._swarms.get(msg.topic!)?.onSignal(msg),
+      onOffer: msg => onOffer(msg)
+    });
 
     if (options.log) {
       this._connectionLog = new ConnectionLog();
@@ -108,7 +117,8 @@ export class NetworkManager {
       peerId,
       topology,
       protocol,
-      this._signalManager,
+      this._messageRouter,
+      this._signalManager.lookup.bind(this._signalManager),
       transportFactory,
       options.label
     );
@@ -167,6 +177,7 @@ export class NetworkManager {
       });
     }
 
+    await this._messageRouter.destroy();
     await this._signalManager.destroy();
   }
 }

package/src/proto/defs/dxos/mesh/signal.proto

@@ -0,0 +1,51 @@
+//
+// Copyright 2020 DXOS.org
+//
+
+syntax = "proto3";
+
+import "@dxos/protocols/src/proto/dxos/halo/keys.proto";
+
+package dxos.mesh.signal;
+
+message Message {
+  /// Sender's public key.
+  PubKey id = 1;
+  /// Receiver`s public key.
+  PubKey remoteId = 2;
+  /// Swarm identefier.
+  PubKey topic = 3;
+  /// Unique connection identifier.
+  PubKey sessionId = 4;
+  /// Message payload.
+  MessageData data = 5;
+  /// Unique message identifier. Used for Acknolegment and matching Anwers to Offers.
+  PubKey messageId = 6;
+}
+
+message MessageData {
+  oneof payload {
+    Offer offer = 1;
+    Answer answer = 2;
+    Signal signal = 3;
+    Acknowledgement ack = 4;
+  }
+}
+
+message Offer {
+}
+
+message Answer {
+  bool accept = 1;
+  /// MessageId of the Offer being answered.
+  PubKey offerMessageId = 2;
+}
+
+message Signal {
+  string json = 1;
+}
+
+message Acknowledgement {
+  // MessageId of the Message being acknowledged.
+  PubKey messageId = 1;
+ }

package/src/proto/gen/dxos/credentials.ts

@@ -0,0 +1,27 @@
+import type { Stream } from "@dxos/codec-protobuf";
+import substitutions from "../../substitutions";
+import * as dxos_halo_keys from "./halo/keys";
+import * as dxos_mesh_signal from "./mesh/signal";
+import * as google_protobuf from "../google/protobuf";
+export interface Message {
+    payload: google_protobuf.Any;
+}
+/**
+ * A generic container message used whenever messages are signed (e.g. PartyCredential)
+ */
+export interface SignedMessage {
+    signed: SignedMessage.Signed;
+    signatures?: SignedMessage.Signature[];
+}
+export namespace SignedMessage {
+    export interface Signed {
+        created: string;
+        nonce: Uint8Array;
+        payload: google_protobuf.Any;
+    }
+    export interface Signature {
+        key: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
+        signature: Uint8Array;
+        keyChain?: dxos_halo_keys.KeyChain;
+    }
+}

package/src/proto/gen/dxos/halo/keys.ts

@@ -0,0 +1,62 @@
+import type { Stream } from "@dxos/codec-protobuf";
+import substitutions from "../../../substitutions";
+import * as dxos_credentials from "../credentials";
+import * as dxos_mesh_signal from "../mesh/signal";
+import * as google_protobuf from "../../google/protobuf";
+export enum KeyType {
+    UNKNOWN = 0,
+    IDENTITY = 1,
+    DEVICE = 2,
+    PARTY = 3,
+    FEED = 4,
+    DXNS_ADDRESS = 5
+}
+export interface PubKey {
+    data?: Uint8Array;
+}
+export interface PrivKey {
+    data?: Uint8Array;
+}
+export interface KeyRecord {
+    /**
+     * The `KeyType` type of the key. This is often unknown for keys from other sources.
+     */
+    type: KeyType;
+    /**
+     * The public key as a Buffer (required).
+     */
+    publicKey: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
+    /**
+     * The secret key as a Buffer (this will never be visible outside the Keyring).
+     */
+    secretKey?: ReturnType<(typeof substitutions)["dxos.halo.keys.PrivKey"]["decode"]>;
+    /**
+     * Is this key from a Greeting "hint"?
+     */
+    hint?: boolean;
+    /**
+     * Determines if this is our key?
+     * Usually true if `secretKey` is present; may be false for "inception keys" such as the Party key.
+     */
+    own?: boolean;
+    /**
+     * Is this key to be trusted?
+     */
+    trusted?: boolean;
+    /**
+     * An RFC-3339 date/time string for when the key was added to the Keyring.
+     */
+    added?: string;
+    /**
+     * An RFC-3339 date/time string for when the key was created.
+     */
+    created?: string;
+}
+export interface KeyRecordList {
+    keys?: KeyRecord[];
+}
+export interface KeyChain {
+    publicKey: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
+    message: dxos_credentials.SignedMessage;
+    parents?: KeyChain[];
+}

package/src/proto/gen/dxos/mesh/signal.ts

@@ -0,0 +1,52 @@
+import type { Stream } from "@dxos/codec-protobuf";
+import substitutions from "../../../substitutions";
+import * as dxos_credentials from "../credentials";
+import * as dxos_halo_keys from "../halo/keys";
+import * as google_protobuf from "../../google/protobuf";
+export interface Message {
+    /**
+     * Sender's public key.
+     */
+    id?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
+    /**
+     * Receiver`s public key.
+     */
+    remoteId?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
+    /**
+     * Swarm identefier.
+     */
+    topic?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
+    /**
+     * Unique connection identifier.
+     */
+    sessionId?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
+    /**
+     * Message payload.
+     */
+    data?: MessageData;
+    /**
+     * Unique message identifier. Used for Acknolegment and matching Anwers to Offers.
+     */
+    messageId?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
+}
+export interface MessageData {
+    offer?: Offer;
+    answer?: Answer;
+    signal?: Signal;
+    ack?: Acknowledgement;
+}
+export interface Offer {
+}
+export interface Answer {
+    accept?: boolean;
+    /**
+     * MessageId of the Offer being answered.
+     */
+    offerMessageId?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
+}
+export interface Signal {
+    json?: string;
+}
+export interface Acknowledgement {
+    messageId?: ReturnType<(typeof substitutions)["dxos.halo.keys.PubKey"]["decode"]>;
+}

package/src/proto/gen/google/protobuf.ts

@@ -0,0 +1,9 @@
+import type { Stream } from "@dxos/codec-protobuf";
+import substitutions from "../../substitutions";
+import * as dxos_credentials from "../dxos/credentials";
+import * as dxos_halo_keys from "../dxos/halo/keys";
+import * as dxos_mesh_signal from "../dxos/mesh/signal";
+export interface Any {
+    type_url?: string;
+    value?: Uint8Array;
+}

package/src/proto/gen/index.ts

@@ -0,0 +1,29 @@
+import { Schema } from "@dxos/codec-protobuf";
+import * as dxos_credentials from "./dxos/credentials";
+import * as dxos_halo_keys from "./dxos/halo/keys";
+import * as dxos_mesh_signal from "./dxos/mesh/signal";
+import * as google_protobuf from "./google/protobuf";
+import substitutions from "../substitutions";
+export interface TYPES {
+    "dxos.credentials.Message": dxos_credentials.Message;
+    "dxos.credentials.SignedMessage": dxos_credentials.SignedMessage;
+    "dxos.credentials.SignedMessage.Signature": dxos_credentials.SignedMessage.Signature;
+    "dxos.credentials.SignedMessage.Signed": dxos_credentials.SignedMessage.Signed;
+    "dxos.halo.keys.KeyChain": dxos_halo_keys.KeyChain;
+    "dxos.halo.keys.KeyRecord": dxos_halo_keys.KeyRecord;
+    "dxos.halo.keys.KeyRecordList": dxos_halo_keys.KeyRecordList;
+    "dxos.halo.keys.KeyType": dxos_halo_keys.KeyType;
+    "dxos.halo.keys.PrivKey": dxos_halo_keys.PrivKey;
+    "dxos.halo.keys.PubKey": dxos_halo_keys.PubKey;
+    "dxos.mesh.signal.Acknowledgement": dxos_mesh_signal.Acknowledgement;
+    "dxos.mesh.signal.Answer": dxos_mesh_signal.Answer;
+    "dxos.mesh.signal.Message": dxos_mesh_signal.Message;
+    "dxos.mesh.signal.MessageData": dxos_mesh_signal.MessageData;
+    "dxos.mesh.signal.Offer": dxos_mesh_signal.Offer;
+    "dxos.mesh.signal.Signal": dxos_mesh_signal.Signal;
+    "google.protobuf.Any": google_protobuf.Any;
+}
+export interface SERVICES {
+}
+export const schemaJson = JSON.parse("{\"nested\":{\"dxos\":{\"nested\":{\"credentials\":{\"nested\":{\"Message\":{\"fields\":{\"payload\":{\"rule\":\"required\",\"type\":\"google.protobuf.Any\",\"id\":1,\"comment\":null}},\"comment\":null},\"SignedMessage\":{\"fields\":{\"signed\":{\"rule\":\"required\",\"type\":\"Signed\",\"id\":1,\"comment\":null},\"signatures\":{\"rule\":\"repeated\",\"type\":\"Signature\",\"id\":2,\"comment\":null}},\"nested\":{\"Signature\":{\"fields\":{\"key\":{\"rule\":\"required\",\"type\":\"PubKey\",\"id\":1,\"comment\":null},\"signature\":{\"rule\":\"required\",\"type\":\"bytes\",\"id\":2,\"comment\":null},\"keyChain\":{\"type\":\"KeyChain\",\"id\":3,\"comment\":null}},\"comment\":null},\"Signed\":{\"fields\":{\"created\":{\"rule\":\"required\",\"type\":\"string\",\"id\":1,\"comment\":null},\"nonce\":{\"rule\":\"required\",\"type\":\"bytes\",\"id\":2,\"comment\":null},\"payload\":{\"rule\":\"required\",\"type\":\"google.protobuf.Any\",\"id\":10,\"comment\":null}},\"comment\":null}},\"comment\":\"A generic container message used whenever messages are signed (e.g. PartyCredential)\"}}},\"halo\":{\"nested\":{\"keys\":{\"nested\":{\"KeyChain\":{\"fields\":{\"publicKey\":{\"rule\":\"required\",\"type\":\"PubKey\",\"id\":1,\"comment\":null},\"message\":{\"rule\":\"required\",\"type\":\"SignedMessage\",\"id\":2,\"comment\":null},\"parents\":{\"rule\":\"repeated\",\"type\":\"KeyChain\",\"id\":3,\"comment\":null}},\"comment\":null},\"KeyRecord\":{\"fields\":{\"type\":{\"rule\":\"required\",\"type\":\"KeyType\",\"id\":1,\"comment\":\"The `KeyType` type of the key. This is often unknown for keys from other sources.\"},\"publicKey\":{\"rule\":\"required\",\"type\":\"PubKey\",\"id\":2,\"comment\":\"The public key as a Buffer (required).\"},\"secretKey\":{\"type\":\"PrivKey\",\"id\":3,\"comment\":\"The secret key as a Buffer (this will never be visible outside the Keyring).\"},\"hint\":{\"type\":\"bool\",\"id\":4,\"comment\":\"Is this key from a Greeting \\\"hint\\\"?\"},\"own\":{\"type\":\"bool\",\"id\":5,\"comment\":\"Determines if this is our key?\\nUsually true if `secretKey` is present; may be false for \\\"inception keys\\\" such as the Party key.\"},\"trusted\":{\"type\":\"bool\",\"id\":6,\"comment\":\"Is this key to be trusted?\"},\"added\":{\"type\":\"string\",\"id\":7,\"comment\":\"An RFC-3339 date/time string for when the key was added to the Keyring.\"},\"created\":{\"type\":\"string\",\"id\":8,\"comment\":\"An RFC-3339 date/time string for when the key was created.\"}},\"comment\":null},\"KeyRecordList\":{\"fields\":{\"keys\":{\"rule\":\"repeated\",\"type\":\"KeyRecord\",\"id\":1,\"comment\":null}},\"comment\":null},\"KeyType\":{\"values\":{\"UNKNOWN\":0,\"IDENTITY\":1,\"DEVICE\":2,\"PARTY\":3,\"FEED\":4,\"DXNS_ADDRESS\":5},\"comment\":null,\"comments\":{\"UNKNOWN\":null,\"IDENTITY\":null,\"DEVICE\":null,\"PARTY\":null,\"FEED\":null,\"DXNS_ADDRESS\":null}},\"PrivKey\":{\"fields\":{\"data\":{\"type\":\"bytes\",\"id\":1,\"comment\":null}},\"comment\":null},\"PubKey\":{\"fields\":{\"data\":{\"type\":\"bytes\",\"id\":1,\"comment\":null}},\"comment\":null}}}}},\"mesh\":{\"nested\":{\"signal\":{\"nested\":{\"Acknowledgement\":{\"fields\":{\"messageId\":{\"type\":\"PubKey\",\"id\":1,\"comment\":null}},\"comment\":null},\"Answer\":{\"fields\":{\"accept\":{\"type\":\"bool\",\"id\":1,\"comment\":null},\"offerMessageId\":{\"type\":\"PubKey\",\"id\":2,\"comment\":\"MessageId of the Offer being answered.\"}},\"comment\":null},\"Message\":{\"fields\":{\"id\":{\"type\":\"PubKey\",\"id\":1,\"comment\":\"Sender's public key.\"},\"remoteId\":{\"type\":\"PubKey\",\"id\":2,\"comment\":\"Receiver`s public key.\"},\"topic\":{\"type\":\"PubKey\",\"id\":3,\"comment\":\"Swarm identefier.\"},\"sessionId\":{\"type\":\"PubKey\",\"id\":4,\"comment\":\"Unique connection identifier.\"},\"data\":{\"type\":\"MessageData\",\"id\":5,\"comment\":\"Message payload.\"},\"messageId\":{\"type\":\"PubKey\",\"id\":6,\"comment\":\"Unique message identifier. Used for Acknolegment and matching Anwers to Offers.\"}},\"comment\":null},\"MessageData\":{\"oneofs\":{\"payload\":{\"oneof\":[\"offer\",\"answer\",\"signal\",\"ack\"],\"comment\":null}},\"fields\":{\"offer\":{\"type\":\"Offer\",\"id\":1,\"comment\":null},\"answer\":{\"type\":\"Answer\",\"id\":2,\"comment\":null},\"signal\":{\"type\":\"Signal\",\"id\":3,\"comment\":null},\"ack\":{\"type\":\"Acknowledgement\",\"id\":4,\"comment\":null}},\"comment\":null},\"Offer\":{\"fields\":{},\"comment\":null},\"Signal\":{\"fields\":{\"json\":{\"type\":\"string\",\"id\":1,\"comment\":null}},\"comment\":null}}}}}}},\"google\":{\"nested\":{\"protobuf\":{\"nested\":{\"Any\":{\"fields\":{\"type_url\":{\"type\":\"string\",\"id\":1},\"value\":{\"type\":\"bytes\",\"id\":2}},\"comment\":null}}}}}}}");
+export const schema = Schema.fromJson<TYPES, SERVICES>(schemaJson, substitutions);

package/src/proto/substitutions.ts

@@ -0,0 +1,9 @@
+//
+// Copyright 2021 DXOS.org
+//
+
+import { publicKeySubstitutions } from '@dxos/protocols';
+
+export default {
+  ...publicKeySubstitutions
+};

package/src/protocol-factory.ts

@@ -2,10 +2,10 @@
 // Copyright 2020 DXOS.org
 //
 
-import assert from 'assert';
 import debug from 'debug';
+import assert from 'node:assert';
 
-import { discoveryKey, keyToString } from '@dxos/crypto';
+import { discoveryKey } from '@dxos/crypto';
 import { Extension, Protocol } from '@dxos/mesh-protocol';
 import { PublicKey } from '@dxos/protocols';
 
@@ -37,7 +37,7 @@ export const protocolFactory = ({ session = {}, plugins = [], getTopics }: Proto
       discoveryToPublicKey: (dk) => {
         const publicKey = getTopics().find(topic => discoveryKey(topic).equals(dk));
         if (publicKey) {
-          protocol.setContext({ topic: keyToString(publicKey) });
+          protocol.setContext({ topic: PublicKey.stringify(publicKey) });
         }
         assert(publicKey, 'PublicKey not found in discovery.');
         return publicKey;
@@ -62,7 +62,7 @@ export interface Plugin {
 
 export const createProtocolFactory = (topic: PublicKey, peerId: PublicKey, plugins: Plugin[]) => protocolFactory({
   getTopics: () => [topic.asBuffer()],
-  session: { peerId: keyToString(peerId.asBuffer()) },
+  session: { peerId: PublicKey.stringify(peerId.asBuffer()) },
   plugins
 });
 
@@ -72,6 +72,6 @@ export const createProtocolFactory = (topic: PublicKey, peerId: PublicKey, plugi
  */
 export const transportProtocolProvider = (rendezvousKey: Buffer, peerId: Buffer, protocolPlugin: any): ProtocolProvider => protocolFactory({
   getTopics: () => [rendezvousKey],
-  session: { peerId: keyToString(peerId) },
+  session: { peerId: PublicKey.stringify(peerId) },
   plugins: [protocolPlugin]
 });

package/src/signal/in-memory-signal-manager.ts

@@ -2,12 +2,13 @@
 // Copyright 2020 DXOS.org
 //
 
-import assert from 'assert';
+import assert from 'node:assert';
 
 import { Event } from '@dxos/async';
 import { PublicKey } from '@dxos/protocols';
 import { ComplexMap, ComplexSet } from '@dxos/util';
 
+import { Answer, Message } from '../proto/gen/dxos/mesh/signal';
 import { SignalApi } from './signal-api';
 import { SignalManager } from './signal-manager';
 
@@ -15,10 +16,10 @@ export class InMemorySignalManager implements SignalManager {
   readonly statusChanged = new Event<SignalApi.Status[]>();
   readonly commandTrace = new Event<SignalApi.CommandTrace>();
   readonly peerCandidatesChanged = new Event<[topic: PublicKey, candidates: PublicKey[]]>()
-  readonly onSignal = new Event<SignalApi.SignalMessage>();
+  readonly onSignal = new Event<Message>();
 
   constructor (
-    private readonly _onOffer: (message: SignalApi.SignalMessage) => Promise<SignalApi.Answer>
+    private readonly _onOffer: (message: Message) => Promise<Answer>
   ) {}
 
   getStatus (): SignalApi.Status[] {
@@ -48,12 +49,14 @@ export class InMemorySignalManager implements SignalManager {
     setTimeout(() => this.peerCandidatesChanged.emit([topic, Array.from(state.swarms.get(topic)!.values())]), 0);
   }
 
-  offer (msg: SignalApi.SignalMessage) {
+  offer (msg: Message) {
+    assert(msg.remoteId);
     assert(state.connections.has(msg.remoteId), 'Peer not connected');
     return state.connections.get(msg.remoteId)!._onOffer(msg);
   }
 
-  async signal (msg: SignalApi.SignalMessage) {
+  async signal (msg: Message) {
+    assert(msg.remoteId);
     assert(state.connections.get(msg.remoteId), 'Peer not connected');
     state.connections.get(msg.remoteId)!.onSignal.emit(msg);
   }