pairnet 0.1.0 → 0.1.1

package/eslint.config.js

@@ -0,0 +1,3 @@
+"use strict";
+
+module.exports = require("@joepie91/eslint-config");

package/index.js

@@ -2,7 +2,7 @@
 
 const crypto = require("crypto");
 const tls = require("tls");
-const debug = require("debug")("pairnet");
+const makeDebug = require("debug-instanced")("pairnet");
 const matchValue = require("match-value");
 const pipe = require("@promistream/pipe");
 const simpleSink = require("@promistream/simple-sink");
@@ -40,7 +40,7 @@ function createQueryError(message) {
 	return error;
 }
 
-async function makeClientSocket({ hostname, port, options, onQuery, protocolConfiguration }) {
+async function makeClientSocket({ hostname, port, options, onQuery, protocolConfiguration, debug }) {
 	let socket = tls.connect({
 		host: hostname,
 		port: port,
@@ -53,7 +53,9 @@ async function makeClientSocket({ hostname, port, options, onQuery, protocolConf
 	});
 
 	let api = await handleProtocol(socket, {
+		debug,
 		protocolConfiguration: protocolConfiguration,
+		role: "client",
 		onQuery: onQuery
 	});
 	
@@ -77,6 +79,8 @@ module.exports = {
 	createMemoryStorage: createMemoryStorage,
 	createFileStorage: createFileStorage,
 	createPeer: async function createPeer(_options) {
+		let debug = makeDebug("peer");
+
 		let { storage, generateClientHello, onClientHello, onServerHello } = validateOptions(arguments, {
 			storage: [ required, isStorageProvider ],
 			generateClientHello: [ required, isFunction ],
@@ -148,7 +152,7 @@ module.exports = {
 					debug(`[pair] Initiating pairing connection to ${hostname}:${port}...`);
 
 					let socket = await makeClientSocket({
-						hostname, port, protocolConfiguration,
+						debug, hostname, port, protocolConfiguration,
 						// We don't care about anything other than pairing messages in this mode, which are in the form of a query reply
 						onQuery: () => {}
 					});
@@ -201,7 +205,7 @@ module.exports = {
 
 					// connect with client certificate made from own identity, and validate server pubkey
 					let socket = await makeClientSocket({
-						hostname, port, protocolConfiguration,
+						debug, hostname, port, protocolConfiguration,
 						onQuery: onQuery
 					});
 		
@@ -252,7 +256,9 @@ module.exports = {
 						debug(`[server] Is trusted: ${isPaired}`);
 		
 						let api = await handleProtocol(socket, {
+							debug,
 							protocolConfiguration,
+							role: "server",
 							onQuery: async (query) => {
 								return matchValue(query.type, {
 									PAIR: async () => {

package/lib/protocol.js

@@ -5,16 +5,13 @@ const decodeCBOR = require("@promistream/decode-cbor");
 const pipe = require("@promistream/pipe");
 const fromNodeStream = require("@promistream/from-node-stream");
 const map = require("@promistream/map");
-const infiniteQueue = require("../streams/infinite-queue");
+const simpleQueue = require("@promistream/simple-queue");
 const simpleSink = require("@promistream/simple-sink");
 const createDebugStream = require("@promistream/debug");
 const objid = require("@joepie91/objid");
 
-const debug = require("debug")("pairnet:protocol");
-
 const createSender = require("./sender");
 const createReplyTracker = require("./reply-tracker");
-const disconnectSocket = require("../promisified/disconnect-socket");
 const filter = require("@promistream/filter");
 
 let NORMAL_QUERY_TYPE = "q";
@@ -45,10 +42,10 @@ async function evaluateQuery(query, handler) {
 	}
 }
 
-module.exports = async function handleProtocol(socket, { onQuery, protocolConfiguration } = {}) {
-	debug("Attaching semantic protocol handler");
+module.exports = async function handleProtocol(socket, { debug, onQuery, protocolConfiguration, role } = {}) {
+	debug(`Attaching semantic protocol handler (role = ${role})`);
 
-	let writeQueue = infiniteQueue([]);
+	let writeQueue = simpleQueue([], { autoEnd: false });
 	let replyTracker = createReplyTracker();
 	let negotiationCompleted = false;
 
@@ -85,15 +82,16 @@ module.exports = async function handleProtocol(socket, { onQuery, protocolConfig
 		// createDebugStream(`pairnet:protocol:receive-pipeline ${objid(socket)}`),
 	]);
 
-	let clientHelloQuery = (protocolConfiguration.isClient)
+	let clientHelloQuery = (role === "client")
 		? sender.sendNegotiationQuery(await protocolConfiguration.generateClientHello())._queryID.toString("hex") // FIXME: Hacky
 		: null;
 
 	// We read messages for as long as negotiation has not been completed yet
+	// TODO[security]: verify that we don't allow server/client confusion anywhere
 	await pipe([
 		incomingMessageStream,
 		simpleSink(async (message) => {
-			debug("Received message:", message);
+			debug("Received message (negotiation phase):", message);
 
 			let isNegotiationMessage = NEGOTIATION_TYPES.has(message.t);
 			let isReplyMessage = REPLY_TYPES.has(message.t);
@@ -107,7 +105,7 @@ module.exports = async function handleProtocol(socket, { onQuery, protocolConfig
 
 					if (helloDecision === false) {
 						// Connection rejected
-						return disconnectSocket(socket);
+						return writeQueue.end();
 					} else {
 						debug(`[readLoop] Negotiation completed on client side; detaching sink...`);
 						return null;
@@ -140,6 +138,8 @@ module.exports = async function handleProtocol(socket, { onQuery, protocolConfig
 	let eventStream = pipe([
 		incomingMessageStream,
 		filter(async (message) => {
+			debug("Received message (operating phase):", message);
+
 			let isReplyMessage = REPLY_TYPES.has(message.t);
 
 			if (message.t === NORMAL_QUERY_TYPE) {
@@ -186,6 +186,6 @@ module.exports = async function handleProtocol(socket, { onQuery, protocolConfig
 	return {
 		eventStream: eventStream,
 		sender: sender,
-		disconnect: () => disconnectSocket(socket)
+		disconnect: () => writeQueue.end()
 	};
 };

package/package.json

@@ -1,47 +1,41 @@
 {
   "name": "pairnet",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "",
   "main": "index.js",
+  "scripts": {
+    "test": "node --test"
+  },
   "keywords": [],
   "author": "Sven Slootweg <admin@cryto.net>",
   "license": "WTFPL",
   "dependencies": {
-    "@joepie91/consumable": "^1.0.1",
     "@joepie91/objid": "^1.0.1",
-    "@promistream/aborted": "^0.1.2",
     "@promistream/decode-cbor": "^0.1.0",
     "@promistream/encode-cbor": "^0.1.0",
-    "@promistream/filter": "^0.1.1",
-    "@promistream/from-node-stream": "^0.1.3",
-    "@promistream/map": "^0.1.1",
-    "@promistream/pipe": "^0.1.6",
-    "@promistream/simple-sink": "^0.3.0",
-    "@promistream/simple-source": "^0.1.4",
-    "@validatem/core": "^0.5.0",
+    "@promistream/filter": "^0.1.3",
+    "@promistream/from-node-stream": "^0.1.6",
+    "@promistream/map": "^0.1.10",
+    "@promistream/pipe": "^0.1.8",
+    "@promistream/simple-queue": "^0.1.7",
+    "@promistream/simple-sink": "^0.3.5",
+    "@validatem/core": "^0.6.3",
     "@validatem/error": "^1.1.0",
     "@validatem/is-function": "^0.1.0",
     "@validatem/is-integer": "^0.1.0",
     "@validatem/is-non-empty-string": "^0.1.0",
-    "@validatem/is-positive": "^1.0.0",
     "@validatem/required": "^0.1.1",
-    "cbor": "^9.0.2",
-    "colorette": "^2.0.20",
-    "debug": "^4.3.4",
+    "cbor": "^10.0.12",
+    "debug": "^4.4.3",
+    "debug-instanced": "^1.0.0",
     "match-value": "^1.1.0",
-    "nanoid": "^3.3.7",
-    "p-defer": "^3",
-    "p-event": "^4",
-    "range": "^0.0.3",
-    "sanitize-filename": "^1.6.3"
+    "nanoid": "^3.3.18",
+    "p-defer": "^3.0.0",
+    "sanitize-filename": "^1.6.4"
   },
   "devDependencies": {
-    "@joepie91/eslint-config": "^1.1.1",
-    "@promistream/debug": "^0.1.0",
-    "@promistream/from-iterable": "^0.1.0",
-    "@promistream/spy": "^0.1.0"
-  },
-  "scripts": {
-    "test": "node --test"
+    "@joepie91/eslint-config": "^2.0.3",
+    "@promistream/debug": "^0.1.2",
+    "eslint": "^10.8.1"
   }
-}
+}

package/promisified/server-close.js

@@ -1,8 +1,8 @@
 "use strict";
 
-const pEvent = require("p-event");
+const { once } = require("node:events");
 
 module.exports = async function serverClose(server) {
 	server.close();
-	await pEvent(server, "close");
+	await once(server, "close");
 };

package/promisified/server-listen.js

@@ -1,10 +1,10 @@
 "use strict";
 
-const pEvent = require("p-event");
+const { once } = require("node:events");
 const debug = require("debug")("pairnet:server-listen");
 
 module.exports = async function serverListen(server, port, hostname) {
 	server.listen(port, hostname);
-	await pEvent(server, "listening");
+	await once(server, "listening");
 	debug(`[createServer] Listening on ${hostname}:${port}...`);
 };

package/.eslintrc

@@ -1,3 +0,0 @@
-{
-	"extends": "@joepie91/eslint-config"
-}

package/promisified/disconnect-socket.js

@@ -1,11 +0,0 @@
-"use strict";
-
-const debug = require("debug")("pairnet");
-const pEvent = require("p-event");
-
-module.exports = async function disconnect(socket) {
-	debug(`[disconnectSocket] Disconnecting...`);
-	socket.destroySoon();
-	await pEvent(socket, "close");
-	debug(`[disconnectSocket] Disconnected!`);
-};

package/streams/infinite-queue.js

@@ -1,37 +0,0 @@
-"use strict";
-
-const simpleSource = require("@promistream/simple-source");
-const Aborted = require("@promistream/aborted");
-const pDefer = require("p-defer");
-
-module.exports = function createInfiniteQueue(initialItems = []) {
-	let queue = initialItems.slice();
-	let defers = [];
-
-	return {
-		push: function (value) {
-			if (defers.length > 0) {
-				defers.shift().resolve(value);
-			} else {
-				queue.push(value);
-			}
-		},
-		stream: simpleSource({
-			onRequest: () => {
-				if (queue.length > 0) {
-					return queue.shift();
-				} else {
-					let defer = pDefer();
-					defers.push(defer);
-					return defer.promise;
-				}
-			},
-			onAbort: (reason) => {
-				for (let defer of defers) {
-					// TODO: Test properly
-					defer.reject(new Aborted("Stream was aborted"));
-				}
-			}
-		})
-	};
-};