@seriousme/opifex 1.4.0 → 1.5.0

package/CHANGELOG.md

@@ -4,6 +4,18 @@
 
 ### Changed
 
+## [v1.5.0] 02-01-2025
+
+### Changed
+
+- added client certificate support to mqtts.ts
+
+## [v1.4.0] 02-01-2025
+
+### Changed
+
+- added client certificate support (w0otness)
+
 ## [v1.3.0] 19-11-2024
 
 ### Changed

package/bin/mqtt.ts

@@ -2,7 +2,8 @@
 import { DEFAULT_URL } from "../client/mod.ts";
 import { logger, LogLevel } from "../utils/mod.ts";
 import { getArgs, parseArgs } from "../utils/mod.ts";
-import { getCaCerts, TcpClient } from "../node/client.ts";
+import { getFileData, TcpClient } from "../node/client.ts";
+import type { Args } from "../utils/args.ts";
 
 const client = new TcpClient();
 const encoder = new TextEncoder();
@@ -21,18 +22,30 @@ const ConnectHelp = `
   -i/--clientId   the clientId to connect to the server
   -U/--username   the username to connect to the server
   -P/--password   the password to connect to the server
-  -c/--certFile   the path to a certFile
+  -C/--caFile     the path to a CA certificate file
+  -c/--certFile   the path to a certificate file
+  -k/--keyFile    the path to a key file
   -n/--noClean    try to resume a previous session
   -h/--help       this text
   `;
 
 const connectOpts = {
-  string: ["url", "username", "password", "certFile", "clientId"],
+  string: [
+    "url",
+    "username",
+    "password",
+    "caFile",
+    "certFile",
+    "keyFile",
+    "clientId",
+  ],
   alias: {
     u: "url",
     U: "username",
     P: "password",
+    C: "caFile",
     c: "certFile",
+    k: "keyFile",
     i: "clientId",
     n: "noClean",
     h: "help",
@@ -80,9 +93,25 @@ function parseQos(qosArg: string | number) {
   return 0;
 }
 
+async function getTLSdata(connectArgs: Args) {
+  const caFileData = await getFileData(connectArgs.caFile);
+  const caCerts = caFileData ? [caFileData] : undefined;
+  const cert = await getFileData(connectArgs.certFile);
+  const key = await getFileData(connectArgs.keyFile);
+  return {
+    caCerts,
+    cert,
+    key,
+  };
+}
+
 async function subscribe() {
   const connectArgs = parseArgs(getArgs(), connectOpts);
-  const caCerts = await getCaCerts(connectArgs.certFile);
+  const {
+    caCerts,
+    cert,
+    key,
+  } = await getTLSdata(connectArgs);
   const subscribeArgs = parseArgs(getArgs(), subscribeOpts);
   if (connectArgs.help) {
     console.log(SubscribeHelp);
@@ -96,6 +125,8 @@ async function subscribe() {
     await client.connect({
       url: connectArgs.url,
       caCerts,
+      cert,
+      key,
       options: {
         username: connectArgs.username,
         password: encoder.encode(connectArgs.password),
@@ -157,7 +188,11 @@ const publishOpts = {
 
 async function publish() {
   const connectArgs = parseArgs(getArgs(), connectOpts);
-  const caCerts = await getCaCerts(connectArgs.certFile);
+  const {
+    caCerts,
+    cert,
+    key,
+  } = await getTLSdata(connectArgs);
   const publishArgs = parseArgs(getArgs(), publishOpts);
   if (connectArgs.help) {
     console.log(PublishHelp);
@@ -171,6 +206,8 @@ async function publish() {
     await client.connect({
       url: connectArgs.url,
       caCerts,
+      cert,
+      key,
       options: {
         username: connectArgs.username,
         password: encoder.encode(connectArgs.password),

package/deno/client.ts

@@ -4,15 +4,15 @@ import { Client } from "../client/client.ts";
 import { logger } from "../client/deps.ts";
 import type { SockConn } from "../client/deps.ts";
 
-export async function getCaCerts(filename: string | undefined) {
+export async function getFileData(filename: string | undefined) {
   if (!filename) {
     return;
   }
-  const caCerts = await Deno.readTextFile(filename);
-  if (caCerts === "") {
+  const data = await Deno.readTextFile(filename);
+  if (data === "") {
     return;
   }
-  return [caCerts];
+  return data;
 }
 
 export class TcpClient extends Client {

package/deno.json

@@ -1,6 +1,6 @@
 {
   "name": "@seriousme/opifex",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "exports": {
     "./server": "./server/mod.ts",
     "./client": "./client/mod.ts"

package/dist/bin/mqtt.js

@@ -2,7 +2,7 @@
 import { DEFAULT_URL } from "../client/mod.js";
 import { logger, LogLevel } from "../utils/mod.js";
 import { getArgs, parseArgs } from "../utils/mod.js";
-import { getCaCerts, TcpClient } from "../node/client.js";
+import { getFileData, TcpClient } from "../node/client.js";
 const client = new TcpClient();
 const encoder = new TextEncoder();
 const decoder = new TextDecoder();
@@ -18,17 +18,29 @@ const ConnectHelp = `
   -i/--clientId   the clientId to connect to the server
   -U/--username   the username to connect to the server
   -P/--password   the password to connect to the server
-  -c/--certFile   the path to a certFile
+  -C/--caFile     the path to a CA certificate file
+  -c/--certFile   the path to a certificate file
+  -k/--keyFile    the path to a key file
   -n/--noClean    try to resume a previous session
   -h/--help       this text
   `;
 const connectOpts = {
-    string: ["url", "username", "password", "certFile", "clientId"],
+    string: [
+        "url",
+        "username",
+        "password",
+        "caFile",
+        "certFile",
+        "keyFile",
+        "clientId",
+    ],
     alias: {
         u: "url",
         U: "username",
         P: "password",
+        C: "caFile",
         c: "certFile",
+        k: "keyFile",
         i: "clientId",
         n: "noClean",
         h: "help",
@@ -72,9 +84,20 @@ function parseQos(qosArg) {
     console.log("QoS must be between 0 and 2");
     return 0;
 }
+async function getTLSdata(connectArgs) {
+    const caFileData = await getFileData(connectArgs.caFile);
+    const caCerts = caFileData ? [caFileData] : undefined;
+    const cert = await getFileData(connectArgs.certFile);
+    const key = await getFileData(connectArgs.keyFile);
+    return {
+        caCerts,
+        cert,
+        key,
+    };
+}
 async function subscribe() {
     const connectArgs = parseArgs(getArgs(), connectOpts);
-    const caCerts = await getCaCerts(connectArgs.certFile);
+    const { caCerts, cert, key, } = await getTLSdata(connectArgs);
     const subscribeArgs = parseArgs(getArgs(), subscribeOpts);
     if (connectArgs.help) {
         console.log(SubscribeHelp);
@@ -88,6 +111,8 @@ async function subscribe() {
         await client.connect({
             url: connectArgs.url,
             caCerts,
+            cert,
+            key,
             options: {
                 username: connectArgs.username,
                 password: encoder.encode(connectArgs.password),
@@ -145,7 +170,7 @@ const publishOpts = {
 };
 async function publish() {
     const connectArgs = parseArgs(getArgs(), connectOpts);
-    const caCerts = await getCaCerts(connectArgs.certFile);
+    const { caCerts, cert, key, } = await getTLSdata(connectArgs);
     const publishArgs = parseArgs(getArgs(), publishOpts);
     if (connectArgs.help) {
         console.log(PublishHelp);
@@ -159,6 +184,8 @@ async function publish() {
         await client.connect({
             url: connectArgs.url,
             caCerts,
+            cert,
+            key,
             options: {
                 username: connectArgs.username,
                 password: encoder.encode(connectArgs.password),

package/dist/node/client.js

@@ -6,15 +6,15 @@ import { readFile } from "node:fs/promises";
 import { createConnection } from "node:net";
 import * as tls from "node:tls";
 import { wrapNodeSocket } from "./wrapNodeSocket.js";
-export async function getCaCerts(filename) {
+export async function getFileData(filename) {
     if (!filename) {
         return;
     }
-    const caCerts = await readFile(filename, { encoding: "utf-8" });
-    if (caCerts === "") {
+    const data = await readFile(filename, { encoding: "utf-8" });
+    if (data === "") {
         return;
     }
-    return [caCerts];
+    return data;
 }
 export class TcpClient extends Client {
     connectMQTT(hostname, port = 1883) {
@@ -30,15 +30,15 @@ export class TcpClient extends Client {
             });
         });
     }
-    connectMQTTS(hostname, port = 8883, caCerts) {
+    connectMQTTS(hostname, port = 8883, ca, cert, key) {
         const opts = {
             host: hostname,
             port,
-            secureContext: caCerts
-                ? tls.createSecureContext({ cert: caCerts })
+            secureContext: (ca || key || cert)
+                ? tls.createSecureContext({ ca, cert, key })
                 : undefined,
         };
-        logger.debug({ hostname, port, caCerts });
+        logger.debug({ hostname, port, ca, cert });
         return new Promise((resolve, reject) => {
             const socket = tls.connect(opts, () => {
                 logger.debug("Connected to server");

package/node/client.ts

@@ -8,15 +8,15 @@ import * as tls from "node:tls";
 import type { SockConn } from "../socket/socket.ts";
 import { wrapNodeSocket } from "./wrapNodeSocket.ts";
 
-export async function getCaCerts(filename: string | undefined) {
+export async function getFileData(filename: string | undefined) {
   if (!filename) {
     return;
   }
-  const caCerts = await readFile(filename, { encoding: "utf-8" });
-  if (caCerts === "") {
+  const data = await readFile(filename, { encoding: "utf-8" });
+  if (data === "") {
     return;
   }
-  return [caCerts];
+  return data;
 }
 
 export class TcpClient extends Client {
@@ -40,16 +40,18 @@ export class TcpClient extends Client {
   protected connectMQTTS(
     hostname: string,
     port = 8883,
-    caCerts?: string[],
+    ca?: string[],
+    cert?: string,
+    key?: string,
   ): Promise<SockConn> {
     const opts = {
       host: hostname,
       port,
-      secureContext: caCerts
-        ? tls.createSecureContext({ cert: caCerts })
+      secureContext: (ca || key || cert)
+        ? tls.createSecureContext({ ca, cert, key })
         : undefined,
     };
-    logger.debug({ hostname, port, caCerts });
+    logger.debug({ hostname, port, ca, cert });
     return new Promise((resolve, reject) => {
       const socket = tls.connect(opts, () => {
         logger.debug("Connected to server");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seriousme/opifex",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "description": "MQTT client & server for Deno & NodeJS",
   "type": "module",
   "scripts": {