Merge pull request #584 from MatrixAI/feature-local-discovery

Local Polykey Node Discovery

Author: amydevs

package-lock.json

@@ -74,6 +74,7 @@
     "@matrixai/events": "^3.2.3",
     "@matrixai/id": "^3.3.6",
     "@matrixai/logger": "^3.1.0",
+    "@matrixai/mdns": "^1.2.0",
     "@matrixai/quic": "^1.0.0",
     "@matrixai/resources": "^1.1.5",
     "@matrixai/rpc": "^0.2.4",

package.json

@@ -7,6 +7,7 @@ import path from 'path';
 import process from 'process';
 import Logger from '@matrixai/logger';
 import { DB } from '@matrixai/db';
+import { MDNS } from '@matrixai/mdns';
 import {
   CreateDestroyStartStop,
   ready,
@@ -83,6 +84,10 @@ type PolykeyAgentOptions = {
     rpcCallTimeoutTime: number;
     rpcParserBufferSize: number;
   };
+  mdns: {
+    groups: Array<string>;
+    port: number;
+  };
 };
 
 interface PolykeyAgent extends CreateDestroyStartStop {}
@@ -167,6 +172,10 @@ class PolykeyAgent {
         connectionHolePunchIntervalTime:
           config.defaultsSystem.nodesConnectionHolePunchIntervalTime,
       },
+      mdns: {
+        groups: config.defaultsSystem.mdnsGroups,
+        port: config.defaultsSystem.mdnsPort,
+      },
     });
     // This can only happen if the caller didn't specify the node path and the
     // automatic detection failed
@@ -201,6 +210,7 @@ class PolykeyAgent {
     let gestaltGraph: GestaltGraph | undefined;
     let identitiesManager: IdentitiesManager | undefined;
     let nodeGraph: NodeGraph | undefined;
+    let mdns: MDNS | undefined;
     let nodeConnectionManager: NodeConnectionManager | undefined;
     let nodeManager: NodeManager | undefined;
     let discovery: Discovery | undefined;
@@ -316,13 +326,23 @@ class PolykeyAgent {
         keyRing,
         logger: logger.getChild(NodeGraph.name),
       });
+      mdns = new MDNS({
+        logger: logger.getChild(MDNS.name),
+      });
+      await mdns.start({
+        id: keyRing.getNodeId().toBuffer().readUint16BE(),
+        hostname: nodesUtils.encodeNodeId(keyRing.getNodeId()),
+        groups: optionsDefaulted.mdns.groups,
+        port: optionsDefaulted.mdns.port,
+      });
       // Remove your own node ID if provided as a seed node
       const nodeIdOwnEncoded = nodesUtils.encodeNodeId(keyRing.getNodeId());
       delete optionsDefaulted.seedNodes[nodeIdOwnEncoded];
       nodeConnectionManager = new NodeConnectionManager({
         keyRing,
         nodeGraph,
         tlsConfig,
+        mdns,
         seedNodes: optionsDefaulted.seedNodes,
         connectionFindConcurrencyLimit:
           optionsDefaulted.nodes.connectionFindConcurrencyLimit,
@@ -426,6 +446,7 @@ class PolykeyAgent {
       await discovery?.stop();
       await identitiesManager?.stop();
       await gestaltGraph?.stop();
+      await mdns?.stop();
       await acl?.stop();
       await sigchain?.stop();
       await certManager?.stop();
@@ -448,6 +469,7 @@ class PolykeyAgent {
       acl,
       gestaltGraph,
       nodeGraph,
+      mdns,
       taskManager,
       nodeConnectionManager,
       nodeManager,
@@ -486,6 +508,7 @@ class PolykeyAgent {
   public readonly acl: ACL;
   public readonly gestaltGraph: GestaltGraph;
   public readonly nodeGraph: NodeGraph;
+  public readonly mdns: MDNS;
   public readonly taskManager: TaskManager;
   public readonly nodeConnectionManager: NodeConnectionManager;
   public readonly nodeManager: NodeManager;
@@ -530,6 +553,7 @@ class PolykeyAgent {
     acl,
     gestaltGraph,
     nodeGraph,
+    mdns,
     taskManager,
     nodeConnectionManager,
     nodeManager,
@@ -552,6 +576,7 @@ class PolykeyAgent {
     acl: ACL;
     gestaltGraph: GestaltGraph;
     nodeGraph: NodeGraph;
+    mdns: MDNS;
     taskManager: TaskManager;
     nodeConnectionManager: NodeConnectionManager;
     nodeManager: NodeManager;
@@ -576,6 +601,7 @@ class PolykeyAgent {
     this.gestaltGraph = gestaltGraph;
     this.discovery = discovery;
     this.nodeGraph = nodeGraph;
+    this.mdns = mdns;
     this.taskManager = taskManager;
     this.nodeConnectionManager = nodeConnectionManager;
     this.nodeManager = nodeManager;
@@ -624,6 +650,10 @@ class PolykeyAgent {
         | { recoveryCode: string }
         | { privateKey: Buffer }
         | { privateKeyPath: string };
+      mdns: {
+        groups: Array<string>;
+        port: number;
+      };
     }>;
     workers?: number;
     fresh?: boolean;
@@ -637,6 +667,10 @@ class PolykeyAgent {
         agentServicePort: config.defaultsUser.agentServicePort,
         workers: config.defaultsUser.workers,
         ipv6Only: config.defaultsUser.ipv6Only,
+        mdns: {
+          groups: config.defaultsSystem.mdnsGroups,
+          port: config.defaultsSystem.mdnsPort,
+        },
       });
       // Register event handlers
       this.certManager.addEventListener(
@@ -706,6 +740,12 @@ class PolykeyAgent {
         host: optionsDefaulted.clientServiceHost,
         port: optionsDefaulted.clientServicePort,
       });
+      await this.mdns.start({
+        id: this.keyRing.getNodeId().toBuffer().readUint16BE(),
+        hostname: nodesUtils.encodeNodeId(this.keyRing.getNodeId()),
+        groups: optionsDefaulted.mdns.groups,
+        port: optionsDefaulted.mdns.port,
+      });
       await this.nodeManager.start();
       await this.nodeConnectionManager.start({
         host: optionsDefaulted.agentServiceHost,
@@ -768,6 +808,7 @@ class PolykeyAgent {
       await this.vaultManager?.stop();
       await this.discovery?.stop();
       await this.nodeGraph?.stop();
+      await this.mdns?.stop();
       await this.nodeConnectionManager?.stop();
       await this.nodeManager?.stop();
       await this.clientService.stop({ force: true });
@@ -810,6 +851,7 @@ class PolykeyAgent {
     await this.clientService.stop({ force: true });
     await this.identitiesManager.stop();
     await this.gestaltGraph.stop();
+    await this.mdns.stop();
     await this.acl.stop();
     await this.sigchain.stop();
     await this.certManager.stop();

src/PolykeyAgent.ts

@@ -53,7 +53,9 @@ class NodesAdd extends UnaryHandler<
     // Pinging to authenticate the node
     if (
       (input.ping ?? false) &&
-      !(await nodeManager.pingNode(nodeId, { host, port }))
+      !(await nodeManager.pingNode(nodeId, [
+        { host, port, scopes: ['external'] },
+      ]))
     ) {
       throw new nodeErrors.ErrorNodePingFailed(
         'Failed to authenticate target node',

src/client/handlers/NodesAdd.ts

@@ -1,8 +1,8 @@
 import type {
-  AddressMessage,
   ClientRPCRequestParams,
   ClientRPCResponseResult,
   NodeIdMessage,
+  NodesFindMessage,
 } from '../types';
 import type { NodeId } from '../../ids';
 import type NodeConnectionManager from '../../nodes/NodeConnectionManager';
@@ -17,11 +17,11 @@ class NodesFind extends UnaryHandler<
     nodeConnectionManager: NodeConnectionManager;
   },
   ClientRPCRequestParams<NodeIdMessage>,
-  ClientRPCResponseResult<AddressMessage>
+  ClientRPCResponseResult<NodesFindMessage>
 > {
   public handle = async (
     input: ClientRPCRequestParams<NodeIdMessage>,
-  ): Promise<ClientRPCResponseResult<AddressMessage>> => {
+  ): Promise<ClientRPCResponseResult<NodesFindMessage>> => {
     const { nodeConnectionManager } = this.container;
 
     const {
@@ -39,13 +39,12 @@ class NodesFind extends UnaryHandler<
         nodeId: input.nodeIdEncoded,
       },
     );
-    const address = await nodeConnectionManager.findNode(nodeId);
-    if (address == null) throw new nodesErrors.ErrorNodeGraphNodeIdNotFound();
+    const addresses = await nodeConnectionManager.findNodeAll(nodeId);
+    if (addresses.length === 0) {
+      throw new nodesErrors.ErrorNodeGraphNodeIdNotFound();
+    }
 
-    return {
-      host: address.host,
-      port: address.port,
-    };
+    return { addresses };
   };
 }
 

src/client/handlers/NodesFind.ts

@@ -109,6 +109,10 @@ type AddressMessage = {
 
 type NodeAddressMessage = NodeIdMessage & AddressMessage;
 
+type NodesFindMessage = {
+  addresses: Array<AddressMessage>;
+};
+
 type NodesGetMessage = NodeAddressMessage & { bucketIndex: number };
 
 type NodesAddMessage = NodeAddressMessage & {
@@ -327,6 +331,7 @@ export type {
   NodeIdMessage,
   AddressMessage,
   NodeAddressMessage,
+  NodesFindMessage,
   NodeConnectionMessage,
   ActionsListMessage,
   SetIdentityActionMessage,

src/client/types.ts

@@ -13,10 +13,12 @@ const testnet: Record<string, NodeAddress> = {
   v7v9ptvcdbdf8p4upok3prpmu3938ns8v4g45dib7sm5hqvvehv70: {
     host: 'testnet.polykey.com' as Host,
     port: 1314 as Port,
+    scopes: ['external'],
   },
   v270ktdd3cs3mp1r3q3dkmick92bn927mii9or4sgroeogd1peqb0: {
     host: 'testnet.polykey.com' as Host,
     port: 1314 as Port,
+    scopes: ['external'],
   },
 };
 
@@ -246,6 +248,25 @@ const config = {
      * Interval for hole punching reverse node connections.
      */
     nodesConnectionHolePunchIntervalTime: 1_000, // 1 second
+    /**
+     * Multicast group addresses that the MDNS stack will operate on.
+     *
+     * These values are well-known, and hence must not be changed by the user.
+     *
+     * The default values of these groups must start with either `224.0` (IPv4) or `ff02` (IPv6).
+     * The default values of `224.0.0.250` and `ff02::fa17` have been selected due to
+     * the resemblance of `fa17` to the latin word `fait`, and `250` being the decimal representation of that.
+     */
+    mdnsGroups: ['224.0.0.250', 'ff02::fa17'],
+    /**
+     * The port that the MDNS stack will operate on.
+     *
+     * This is well-known, and hence must not be changed by the user.
+     *
+     * The default value has been selected as the decimal decimal representation of `fa17`,
+     * which resembles the latin word `fait`.
+     */
+    mdnsPort: 64023,
   },
   /**
    * Default user configuration.