Merge pull request #2011 from bartvanandel/feat/1216-1531-upgrade-uuid

Author: a3957273

package-lock.json

@@ -182,6 +182,7 @@
     "ua-parser-js": "^1.0.38",
     "unorm": "^1.6.0",
     "utf8": "^3.0.0",
+    "uuid": "^11.1.0",
     "vkbeautify": "^0.99.3",
     "xpath": "0.0.34",
     "xregexp": "^5.1.1",

package.json

@@ -550,6 +550,7 @@
             "Pseudo-Random Number Generator",
             "Generate De Bruijn Sequence",
             "Generate UUID",
+            "Analyse UUID",
             "Generate TOTP",
             "Generate HOTP",
             "Generate QR Code",

src/core/config/Categories.json

@@ -0,0 +1,48 @@
+/**
+ * @author n1474335 [[email protected]]
+ * @copyright Crown Copyright 2023
+ * @license Apache-2.0
+ */
+
+import * as uuid from "uuid";
+
+import Operation from "../Operation.mjs";
+import OperationError from "../errors/OperationError.mjs";
+
+/**
+ * Analyse UUID operation
+ */
+class AnalyseUUID extends Operation {
+
+    /**
+     * AnalyseUUID constructor
+     */
+    constructor() {
+        super();
+
+        this.name = "Analyse UUID";
+        this.module = "Crypto";
+        this.description = "Tries to determine information about a given UUID and suggests which version may have been used to generate it";
+        this.infoURL = "https://wikipedia.org/wiki/Universally_unique_identifier";
+        this.inputType = "string";
+        this.outputType = "string";
+        this.args = [];
+    }
+
+    /**
+     * @param {string} input
+     * @param {Object[]} args
+     * @returns {string}
+     */
+    run(input, args) {
+        try {
+            const uuidVersion = uuid.version(input);
+            return "UUID version: " + uuidVersion;
+        } catch (error) {
+            throw new OperationError("Invalid UUID");
+        }
+    }
+
+}
+
+export default AnalyseUUID;

src/core/operations/AnalyseUUID.mjs

@@ -5,8 +5,8 @@
  */
 
 import Operation from "../Operation.mjs";
-import crypto from "crypto";
-
+import * as uuid from "uuid";
+import OperationError from "../errors/OperationError.mjs";
 /**
  * Generate UUID operation
  */
@@ -20,11 +20,38 @@ class GenerateUUID extends Operation {
 
         this.name = "Generate UUID";
         this.module = "Crypto";
-        this.description = "Generates an RFC 4122 version 4 compliant Universally Unique Identifier (UUID), also known as a Globally Unique Identifier (GUID).<br><br>A version 4 UUID relies on random numbers, in this case generated using <code>window.crypto</code> if available and falling back to <code>Math.random</code> if not.";
+        this.description =
+            "Generates an RFC 9562 (formerly RFC 4122) compliant Universally Unique Identifier (UUID), " +
+            "also known as a Globally Unique Identifier (GUID).<br>" +
+            "<br>" +
+            "We currently support generating the following UUID versions:<br>" +
+            "<ul>" +
+            "<li><strong>v1</strong>: Timestamp-based</li>" +
+            "<li><strong>v3</strong>: Namespace w/ MD5</li>" +
+            "<li><strong>v4</strong>: Random (default)</li>" +
+            "<li><strong>v5</strong>: Namespace w/ SHA-1</li>" +
+            "<li><strong>v6</strong>: Timestamp, reordered</li>" +
+            "<li><strong>v7</strong>: Unix Epoch time-based</li>" +
+            "</ul>" +
+            "UUIDs are generated using the <a href='https://npmjs.org/uuid/'><code>uuid</code><a> package.<br>";
         this.infoURL = "https://wikipedia.org/wiki/Universally_unique_identifier";
         this.inputType = "string";
         this.outputType = "string";
-        this.args = [];
+        this.args = [
+            {
+                name: "Version",
+                hint: "UUID version",
+                type: "option",
+                value: ["v1", "v3", "v4", "v5", "v6", "v7"],
+                defaultIndex: 2,
+            },
+            {
+                name: "Namespace",
+                hint: "UUID namespace (UUID; valid for v3 and v5)",
+                type: "string",
+                value: "1b671a64-40d5-491e-99b0-da01ff1f3341"
+            }
+        ];
     }
 
     /**
@@ -33,16 +60,17 @@ class GenerateUUID extends Operation {
      * @returns {string}
      */
     run(input, args) {
-        const buf = new Uint32Array(4).map(() => {
-            return crypto.randomBytes(4).readUInt32BE(0, true);
-        });
-        let i = 0;
-        return "xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx".replace(/[xy]/g, function(c) {
-            const r = (buf[i >> 3] >> ((i % 8) * 4)) & 0xf,
-                v = c === "x" ? r : (r & 0x3 | 0x8);
-            i++;
-            return v.toString(16);
-        });
+        const [version, namespace] = args;
+        const hasDesiredVersion = typeof uuid[version] === "function";
+        if (!hasDesiredVersion) throw new OperationError("Invalid UUID version");
+
+        const requiresNamespace = ["v3", "v5"].includes(version);
+        if (!requiresNamespace) return uuid[version]();
+
+        const hasValidNamespace = typeof namespace === "string" && uuid.validate(namespace);
+        if (!hasValidNamespace) throw new OperationError("Invalid UUID namespace");
+
+        return uuid[version](input, namespace);
     }
 
 }

src/core/operations/GenerateUUID.mjs

@@ -580,10 +580,25 @@ Password: 282760`;
         assert.strictEqual(result.toString().substr(0, 37), "-----BEGIN PGP PRIVATE KEY BLOCK-----");
     }),
 
-    it("Generate UUID", () => {
-        const result = chef.generateUUID();
-        assert.ok(result.toString());
-        assert.strictEqual(result.toString().length, 36);
+    ...[1, 3, 4, 5, 6, 7].map(version => it(`Generate UUID v${version}`, () => {
+        const result = chef.generateUUID("", { "version": `v${version}` }).toString();
+        assert.ok(result);
+        assert.strictEqual(result.length, 36);
+    })),
+
+    ...[1, 3, 4, 5, 6, 7].map(version => it(`Analyze UUID v${version}`, () => {
+        const uuid = chef.generateUUID("", { "version": `v${version}` }).toString();
+        const result = chef.analyseUUID(uuid).toString();
+        const expected = `UUID version: ${version}`;
+        assert.strictEqual(result, expected);
+    })),
+
+    it("Generate UUID using defaults", () => {
+        const uuid = chef.generateUUID();
+        assert.ok(uuid);
+
+        const analysis = chef.analyseUUID(uuid).toString();
+        assert.strictEqual(analysis, "UUID version: 4");
     }),
 
     it("Gzip, Gunzip", () => {