node-red-contrib-tdn-eventsub 0.1.0

package/nodes/rest-server.html

@@ -0,0 +1,120 @@
+<script type="text/javascript">
+    RED.nodes.registerType('tdn-rest-server', {
+        category: 'config',
+        defaults: {
+            name: { value: '' },
+            url: { value: '', required: true },
+            port: { value: 8904, required: true, validate: RED.validators.number() },
+            authScheme: { value: '', validate: function (v) { return !v || /^[!#$%&'*+.^_`|~0-9A-Za-z-]+$/.test(String(v).trim()); } },
+            fingerprint: {
+                value: '',
+                validate: function (v) {
+                    if (!v) return true;
+                    var h = String(v).replace(/[^0-9a-f]/gi, '');
+                    return h.length === 40 || h.length === 64;
+                }
+            },
+            rejectUnauthorized: { value: true },
+            rewriteHrefs: { value: true },
+            timeout: { value: 30000, validate: RED.validators.number() },
+            certPath: { value: '' },
+            keyPath: { value: '' },
+            pfxPath: { value: '' }
+        },
+        credentials: {
+            apiKey: { type: 'password', required: true },
+            passphrase: { type: 'password' }
+        },
+        label: function () {
+            return this.name || ((this.url || 'rest-server') + ':' + (this.port || 8904));
+        }
+    });
+</script>
+
+<script type="text/html" data-template-name="tdn-rest-server">
+    <div class="form-row">
+        <label for="node-config-input-name"><i class="fa fa-tag"></i> Name</label>
+        <input type="text" id="node-config-input-name" placeholder="REST Server">
+    </div>
+    <div class="form-row">
+        <label for="node-config-input-url"><i class="fa fa-globe"></i> URL / host</label>
+        <input type="text" id="node-config-input-url" placeholder="https://rest-server or 192.168.1.10">
+    </div>
+    <div class="form-row">
+        <label for="node-config-input-port"><i class="fa fa-plug"></i> Port</label>
+        <input type="text" id="node-config-input-port" placeholder="8904" style="width:100px">
+    </div>
+    <div class="form-row">
+        <label for="node-config-input-apiKey"><i class="fa fa-key"></i> API key</label>
+        <input type="password" id="node-config-input-apiKey" placeholder="XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX-XXXX">
+    </div>
+    <div class="form-row">
+        <label for="node-config-input-authScheme"><i class="fa fa-lock"></i> Auth scheme</label>
+        <input type="text" id="node-config-input-authScheme" placeholder="blank = Basic (server v9.0+)">
+    </div>
+    <div class="form-row">
+        <label for="node-config-input-fingerprint"><i class="fa fa-certificate"></i> Cert fingerprint</label>
+        <input type="text" id="node-config-input-fingerprint" placeholder="optional SHA-256 or SHA-1 of server cert">
+    </div>
+    <div class="form-row">
+        <label>&nbsp;</label>
+        <input type="checkbox" id="node-config-input-rejectUnauthorized" style="display:inline-block;width:auto;vertical-align:top">
+        <label for="node-config-input-rejectUnauthorized" style="width:auto">Verify server certificate against CA (ignored when a fingerprint is set)</label>
+    </div>
+    <div class="form-row">
+        <label>&nbsp;</label>
+        <input type="checkbox" id="node-config-input-rewriteHrefs" style="display:inline-block;width:auto;vertical-align:top">
+        <label for="node-config-input-rewriteHrefs" style="width:auto">Force returned links back onto this host:port</label>
+    </div>
+    <div class="form-row">
+        <label for="node-config-input-timeout"><i class="fa fa-clock-o"></i> Timeout (ms)</label>
+        <input type="text" id="node-config-input-timeout" placeholder="30000" style="width:100px">
+    </div>
+    <hr>
+    <div class="form-tips">Client certificate &mdash; only if the REST Client item on the server has a thumbprint set. Use PEM cert + key, <i>or</i> a PFX.</div>
+    <div class="form-row">
+        <label for="node-config-input-certPath">Cert (PEM)</label>
+        <input type="text" id="node-config-input-certPath" placeholder="/path/client.crt">
+    </div>
+    <div class="form-row">
+        <label for="node-config-input-keyPath">Key (PEM)</label>
+        <input type="text" id="node-config-input-keyPath" placeholder="/path/client.key">
+    </div>
+    <div class="form-row">
+        <label for="node-config-input-pfxPath">PFX / P12</label>
+        <input type="text" id="node-config-input-pfxPath" placeholder="/path/client.pfx">
+    </div>
+    <div class="form-row">
+        <label for="node-config-input-passphrase">Passphrase</label>
+        <input type="password" id="node-config-input-passphrase">
+    </div>
+</script>
+
+<script type="text/html" data-help-name="tdn-rest-server">
+    <p>Connection to a REST Server API endpoint, shared by all TDN REST nodes.</p>
+    <h3>Properties</h3>
+    <dl class="message-properties">
+        <dt>URL / host <span class="property-type">string</span></dt>
+        <dd>Server hostname, IP, or URL. <code>https://</code> is assumed. A path (e.g. <code>/api</code>) is optional.</dd>
+        <dt>Port <span class="property-type">number</span></dt>
+        <dd>REST port, default <code>8904</code>.</dd>
+        <dt>API key <span class="property-type">credential</span></dt>
+        <dd>Stored as a Node-RED credential and treated as opaque.</dd>
+        <dt class="optional">Auth scheme <span class="property-type">string</span></dt>
+        <dd>Blank (default): the key is sent as <code>Authorization: Basic base64(":" + key)</code>, accepted by server v9.0+.
+            For older servers, enter the API-key scheme token from your server's REST API documentation;
+            the key is then sent as <code>Authorization: &lt;scheme&gt; &lt;key&gt;</code>.</dd>
+        <dt class="optional">Cert fingerprint <span class="property-type">string</span></dt>
+        <dd>SHA-256 (64 hex) or SHA-1 (40 hex) of the <b>server</b> certificate, colons optional.
+            When set, the connection is accepted only if the presented certificate matches, even if it is self-signed.
+            The check happens before any request (and therefore the API key) is sent.
+            A mismatch error reports the actual fingerprint so you can copy it.</dd>
+        <dt>Verify server certificate</dt>
+        <dd>Normal CA verification when no fingerprint is set. Untick only for lab use.</dd>
+        <dt>Force returned links back onto this host:port</dt>
+        <dd>The server builds <code>href</code>s from its own machine name, which may not resolve from Node-RED.
+            When ticked, followed links keep their path and query but use the configured host and port.</dd>
+        <dt class="optional">Client certificate</dt>
+        <dd>Needed only when the REST Client item has a thumbprint configured.</dd>
+    </dl>
+</script>

package/nodes/rest-server.js

@@ -0,0 +1,57 @@
+'use strict';
+const { RestClient } = require('../lib/client');
+
+module.exports = function (RED) {
+    function RestServerNode(config) {
+        RED.nodes.createNode(this, config);
+        this.name = config.name;
+        this.url = config.url;
+        this.port = config.port;
+        this.fingerprint = config.fingerprint;
+        this.authScheme = (config.authScheme || '').trim();
+        this.rejectUnauthorized = config.rejectUnauthorized !== false;
+        this.rewriteHrefs = config.rewriteHrefs !== false;
+        this.timeout = parseInt(config.timeout, 10) || 30000;
+        this.certPath = config.certPath;
+        this.keyPath = config.keyPath;
+        this.pfxPath = config.pfxPath;
+
+        const creds = this.credentials || {};
+        this.client = null;
+        this.clientError = null;
+        try {
+            this.client = new RestClient({
+                url: this.url,
+                port: this.port,
+                apiKey: creds.apiKey,
+                authScheme: this.authScheme,
+                fingerprint: this.fingerprint,
+                rejectUnauthorized: this.rejectUnauthorized,
+                rewriteHrefs: this.rewriteHrefs,
+                timeoutMs: this.timeout,
+                certPath: this.certPath,
+                keyPath: this.keyPath,
+                pfxPath: this.pfxPath,
+                passphrase: creds.passphrase
+            });
+            if (!creds.apiKey) this.clientError = new Error('No API key configured');
+            if (this.client.base.protocol === 'http:') this.warn('REST server URL is http:// - the API key will be sent unencrypted');
+        } catch (e) {
+            this.clientError = e;
+            this.error('REST server config: ' + e.message);
+        }
+
+        /** Returns the client or throws the configuration error. */
+        this.getClient = () => {
+            if (this.clientError) throw this.clientError;
+            return this.client;
+        };
+    }
+
+    RED.nodes.registerType('tdn-rest-server', RestServerNode, {
+        credentials: {
+            apiKey: { type: 'password' },
+            passphrase: { type: 'password' }
+        }
+    });
+};

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "node-red-contrib-tdn-eventsub",
+  "version": "0.1.0",
+  "description": "Node-RED nodes for an access-control REST Server API: access groups, cardholders and items lists to global context, plus continuous item status subscriptions.",
+  "main": "lib/client.js",
+  "scripts": {
+    "test": "node test/run.js"
+  },
+  "keywords": [
+    "node-red",
+    "access control",
+    "rest",
+    "rest api",
+    "tdn"
+  ],
+  "author": "Stephen",
+  "license": "MIT",
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "files": [
+    "lib",
+    "nodes",
+    "examples",
+    "README.md",
+    "LICENSE"
+  ],
+  "node-red": {
+    "version": ">=3.0.0",
+    "nodes": {
+      "tdn-rest-server": "nodes/rest-server.js",
+      "tdn-rest-lists": "nodes/rest-lists.js",
+      "tdn-rest-item-status": "nodes/rest-item-status.js"
+    }
+  }
+}