@seriousme/opifex 1.1.0

package/.github/workflows/closeStale.yml

@@ -0,0 +1,15 @@
+name: "Close stale issues"
+on:
+  schedule:
+    - cron: "5 0 * * *"
+
+jobs:
+  stale:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/stale@v3
+        with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+          days-before-stale: 30
+          days-before-close: 5
+          stale-issue-message: This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days'

package/.github/workflows/codeql-analysis.yml

@@ -0,0 +1,71 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [master]
+  schedule:
+    - cron: "27 16 * * 3"
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: ["javascript"]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
+        # Learn more:
+        # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v1
+        with:
+          languages: ${{ matrix.language }}
+          # If you wish to specify custom queries, you can do so here or in a config file.
+          # By default, queries listed here will override any specified in a config file.
+          # Prefix the list here with "+" to use these queries and those in the config file.
+          # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+      # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+      # If this step fails, then you should remove it and run the build manually (see below)
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v1
+
+      # ℹ️ Command-line programs to run using the OS shell.
+      # 📚 https://git.io/JvXDl
+
+      # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+      #    and modify them (or add more) to build your code if your project
+      #    uses a compiled language
+
+      #- run: |
+      #   make bootstrap
+      #   make release
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v1

package/.github/workflows/deno-ci.yml

@@ -0,0 +1,16 @@
+# This workflow will test on Deno lastest stable major and canary
+# see https://github.com/marketplace/actions/setup-deno for details
+name: Deno CI
+on: [push, pull_request]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: denoland/setup-deno@v2
+        with:
+          deno-version: vx.x.x # Run with latest stable Deno.
+      - run: deno install
+      - run: deno fmt --check
+      - run: deno lint
+      - run: deno test -A

package/.github/workflows/nodejs-ci.yml

@@ -0,0 +1,23 @@
+# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Node.js CI
+
+on: [push, pull_request]
+
+permissions: {}
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: ["22", "23"]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: npm run test

package/.github/workflows/publish.yml

@@ -0,0 +1,16 @@
+name: Publish
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write # The OIDC ID token is used for authentication with JSR.
+    steps:
+      - uses: actions/checkout@v4
+      - run: npx jsr publish

package/.vscode/extensions.json

@@ -0,0 +1,10 @@
+{
+  // See https://go.microsoft.com/fwlink/?LinkId=827846 to learn about workspace recommendations.
+  // Extension identifier format: ${publisher}.${name}. Example: vscode.csharp
+
+  // List of extensions which should be recommended for users of this workspace.
+  "recommendations": ["denoland.vscode-deno"],
+
+  // List of extensions recommended by VS Code that should not be recommended for users of this workspace.
+  "unwantedRecommendations": []
+}

package/.vscode/settings.json

@@ -0,0 +1,12 @@
+{
+  "deno.enable": true,
+  "deno.suggest.imports.hosts": {
+    "https://deno.land": true,
+    "https://io": false,
+    "https://d": false,
+    "https://de": false,
+    "https://deno": false,
+    "https://deno.": false,
+    "https://deno.la": false
+  }
+}

package/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Hans Klunder
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,34 @@
+[![Deno CI](https://github.com/seriousme/opifex/actions/workflows/deno-ci.yml/badge.svg)](https://github.com/seriousme/opifex/actions/workflows/deno-ci.yml)
+[![CodeQL](https://github.com/seriousme/opifex/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/seriousme/opifex/actions/workflows/codeql-analysis.yml)
+
+# Opifex
+
+Opifex aims to provide a MQTT server and MQTT client in Typescript to be used
+with [Deno](https://deno.land) or [NodeJS](https://nodejs.org) It has _no_ third
+party dependencies, it only relies on built in modules.
+
+Its a work in progress, only does MQTT 3.1.1 and currently only has memory based
+persistence.
+
+There are separate usage instructions for:
+
+- [Deno](deno/README.md)
+- [NodeJS](node/README.md)
+
+The client and server libs should also work on Bun as they are engine
+independent, but the demo server and client currently do not work on Bun because
+of some socket incompatibilities between Bun and the rest.
+
+## Naming
+
+Some MQTT servers have names like:
+
+- [Mosquitto](https://en.wikipedia.org/wiki/Mosquito)
+- [Mosca](https://it.wikipedia.org/wiki/Musca_domestica)
+- [Aedes](https://en.wikipedia.org/wiki/Aedes)
+
+So to stay with the theme: [Opifex](https://en.wikipedia.org/wiki/Opifex_(fly))
+
+# License
+
+Licensed under [MIT](LICENSE.txt)

package/bin/conformanceServer.ts

@@ -0,0 +1,70 @@
+#!/usr/bin/env -S node --experimental-strip-types
+// this server is intended to be used with https://github.com/eclipse/iottestware
+
+import { AuthenticationResult } from "../server/mod.ts";
+import type { Context, TAuthenticationResult, Topic } from "../server/mod.ts";
+import { logger, LogLevel } from "../utils/mod.ts";
+import { getArgs, parseArgs } from "../utils/mod.ts";
+import { TcpServer } from "../deno/server.ts";
+
+const utf8Decoder = new TextDecoder();
+const userTable = new Map();
+userTable.set("IoTester_1", "strong_password");
+userTable.set("IoTester_2", "strong_password");
+const strictUsername = new RegExp(/^[a-zA-Z0-9]{0,23}$/);
+const notAuthorizedTable = new Set();
+notAuthorizedTable.add(["123-456-789", "eclipse/iot/tesware/0data"]);
+
+function isAuthenticated(
+  _ctx: Context,
+  clientId: string,
+  username: string,
+  password: Uint8Array,
+): TAuthenticationResult {
+  const pwd = utf8Decoder.decode(password);
+  logger.debug(
+    `Verifying authentication of client '${clientId}' with username '${username}' and password '${pwd}'`,
+  );
+
+  if (!userTable.has(username)) {
+    if (!strictUsername.test(username)) {
+      return AuthenticationResult.badUsernameOrPassword;
+    }
+  }
+  const pass = userTable.get(username);
+  if (pwd === pass) {
+    return AuthenticationResult.ok;
+  }
+  return AuthenticationResult.notAuthorized;
+}
+
+function isAuthorizedToPublish(ctx: Context, topic: Topic): boolean {
+  logger.debug(
+    `Checking authorization of client '${ctx.store?.clientId}' to publish on topic '${topic}'`,
+  );
+  // if (notAuthorizedTable.has([ctx.client,topic])){
+  //   return false;
+  // }
+  return true;
+}
+function isAuthorizedToSubscribe(ctx: Context, topic: Topic): boolean {
+  logger.debug(
+    `Checking authorization of client '${ctx.store?.clientId}' to subscribe to topic '${topic}'`,
+  );
+  return true;
+}
+
+/** start the server **/
+const { _: [portNum] } = parseArgs(getArgs());
+const port = Number(portNum ?? 1883);
+const hostname = "::";
+logger.level(LogLevel.info);
+const tcpServer = new TcpServer({ port, hostname }, {
+  handlers: {
+    isAuthenticated,
+    isAuthorizedToPublish,
+    isAuthorizedToSubscribe,
+  },
+});
+tcpServer.start();
+logger.info(`Server started on port ${tcpServer.port}`);

package/bin/demoServer.ts

@@ -0,0 +1,64 @@
+#!/usr/bin/env -S node --experimental-strip-types
+import { TcpServer } from "../node/server.ts";
+import type { Context, TAuthenticationResult, Topic } from "../server/mod.ts";
+import { AuthenticationResult } from "../server/mod.ts";
+import { getArgs, logger, LogLevel, parseArgs } from "../utils/mod.ts";
+
+const utf8Decoder = new TextDecoder();
+const userTable = new Map();
+userTable.set("IoTester_1", "strong_password");
+userTable.set("IoTester_2", "strong_password");
+// const strictUsername = new RegExp(/^[a-zA-Z0-9]{0,23}$/);
+
+function isAuthenticated(
+  _ctx: Context,
+  clientId: string,
+  username: string,
+  password: Uint8Array,
+): TAuthenticationResult {
+  const pwd = utf8Decoder.decode(password);
+  logger.info(
+    `Verifying authentication of client '${clientId}' with username '${username}' and password '${pwd}'`,
+  );
+
+  return AuthenticationResult.ok;
+  // if (!userTable.has(username)) {
+  //   if (!strictUsername.test(username)) {
+  //     return AuthenticationResult.badUsernameOrPassword;
+  //   }
+  // }
+
+  // const pass = userTable.get(username);
+  // if (pwd === pass) {
+  //   return AuthenticationResult.ok;
+  // }
+  // return AuthenticationResult.badUsernameOrPassword;
+}
+
+function isAuthorizedToPublish(ctx: Context, topic: Topic): boolean {
+  logger.debug(
+    `Checking authorization of client '${ctx.store?.clientId}' to publish on topic '${topic}'`,
+  );
+  return true;
+}
+function isAuthorizedToSubscribe(ctx: Context, topic: Topic): boolean {
+  logger.debug(
+    `Checking authorization of client '${ctx.store?.clientId}' to subscribe to topic '${topic}'`,
+  );
+  return true;
+}
+
+/** start the server **/
+const { _: [portNum] } = parseArgs(getArgs());
+const port = Number(portNum ?? 1883);
+const hostname = "::";
+logger.level(LogLevel.info);
+const tcpServer = new TcpServer({ port, hostname }, {
+  handlers: {
+    isAuthenticated,
+    isAuthorizedToPublish,
+    isAuthorizedToSubscribe,
+  },
+});
+tcpServer.start();
+logger.info(`Server started on port ${tcpServer.port}`);

package/bin/mqtt.ts

@@ -0,0 +1,211 @@
+#!/usr/bin/env -S node --experimental-strip-types
+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";
+
+const client = new TcpClient();
+const encoder = new TextEncoder();
+const decoder = new TextDecoder();
+logger.level(LogLevel.info);
+
+const MQTTHelp = `MQTT.ts command line interface, available commands are:
+
+    * publish     publish a message to the broker
+    * subscribe   subscribe for updates from the broker
+
+Launch 'mqtt.ts [command] --help' to know more about the commands.`;
+
+const ConnectHelp = `
+  -u/--url        the URL to connect to: default is ${DEFAULT_URL}
+  -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
+  -n/--noClean    try to resume a previous session
+  -h/--help       this text
+  `;
+
+const connectOpts = {
+  string: ["url", "username", "password", "certFile", "clientId"],
+  alias: {
+    u: "url",
+    U: "username",
+    P: "password",
+    c: "certFile",
+    i: "clientId",
+    n: "noClean",
+    h: "help",
+  },
+  boolean: ["noClean", "help"],
+  default: {
+    noClean: false,
+  },
+};
+
+const SubscribeHelp = `Usage: MQTT.ts subscribe <options>
+
+Where options are:
+  -t/--topic      the topic to use
+  -q/--qos        the QoS (0/1/2) to use, default is 0
+${ConnectHelp}
+Example: MQTT.ts subscribe -t hello`;
+
+const subscribeOpts = {
+  string: ["topic"],
+  alias: {
+    t: "topic",
+    q: "qos",
+  },
+  default: {
+    qos: 0,
+    topic: "",
+  },
+};
+
+function parseQos(qosArg: string | number) {
+  const qos = Number(qosArg);
+  switch (qos) {
+    case 0:
+      return 0;
+    case 1:
+      return 1;
+    case 2:
+      return 2;
+    default:
+      break;
+  }
+  console.log("QoS must be between 0 and 2");
+  return 0;
+}
+
+async function subscribe() {
+  const connectArgs = parseArgs(getArgs(), connectOpts);
+  const caCerts = await getCaCerts(connectArgs.certFile);
+  const subscribeArgs = parseArgs(getArgs(), subscribeOpts);
+  if (connectArgs.help) {
+    console.log(SubscribeHelp);
+    return;
+  }
+  if (subscribeArgs.topic === undefined) {
+    console.log("Missing `topic`");
+    return;
+  }
+  try {
+    await client.connect({
+      url: connectArgs.url,
+      caCerts,
+      options: {
+        username: connectArgs.username,
+        password: encoder.encode(connectArgs.password),
+        clientId: connectArgs.clientId,
+        clean: !connectArgs.noClean,
+        keepAlive: 60,
+      },
+    });
+    logger.debug("Connected !");
+
+    client.subscribe({
+      subscriptions: [
+        {
+          topicFilter: subscribeArgs.topic,
+          qos: parseQos(subscribeArgs.qos),
+        },
+      ],
+    });
+    logger.debug("Subscribed!");
+
+    for await (const message of client.messages()) {
+      console.log(decoder.decode(message.payload));
+    }
+  } catch (err) {
+    if (err instanceof Error) {
+      logger.info(err.message);
+    }
+  }
+}
+
+const PublishHelp = `Usage: MQTT.ts publish <options>
+
+Where options are:
+  -t/--topic      the topic to use
+  -m/--message    the message to send
+  -q/--qos        the QoS (0/1/2) to use, default is 0
+  -r/--retain     if the message should be retained, default is false
+${ConnectHelp}
+Example: MQTT.ts publish -t hello -m world`;
+
+const publishOpts = {
+  string: ["topic", "message"],
+  boolean: ["retain"],
+  alias: {
+    t: "topic",
+    m: "message",
+    q: "qos",
+    r: "retain",
+  },
+  default: {
+    qos: 0,
+    dup: false,
+    retain: false,
+    topic: undefined,
+    message: "",
+  },
+};
+
+async function publish() {
+  const connectArgs = parseArgs(getArgs(), connectOpts);
+  const caCerts = await getCaCerts(connectArgs.certFile);
+  const publishArgs = parseArgs(getArgs(), publishOpts);
+  if (connectArgs.help) {
+    console.log(PublishHelp);
+    return;
+  }
+  if (publishArgs.topic === undefined) {
+    console.log("Missing `topic`");
+    return;
+  }
+  try {
+    await client.connect({
+      url: connectArgs.url,
+      caCerts,
+      options: {
+        username: connectArgs.username,
+        password: encoder.encode(connectArgs.password),
+        clientId: connectArgs.clientId,
+        clean: !connectArgs.noClean,
+      },
+    });
+    logger.debug("Connected !");
+    await client.publish({
+      topic: publishArgs.topic,
+      payload: encoder.encode(publishArgs.message),
+      retain: publishArgs.retain,
+      qos: parseQos(publishArgs.qos),
+    });
+    logger.debug("Published!");
+    client.disconnect();
+    logger.debug("Disconnected !");
+  } catch (err) {
+    if (err instanceof Error) {
+      logger.info(err.message);
+    }
+  }
+}
+
+function processArgs() {
+  const { _: [cmd] } = parseArgs(getArgs());
+  switch (cmd) {
+    case "publish":
+      publish();
+      break;
+    case "subscribe":
+      subscribe();
+      break;
+    default:
+      console.log(MQTTHelp);
+      break;
+  }
+}
+
+processArgs();