Merge pull request #1780 from jb30795/master

IPv6 Transition Operation
gchq · Feb 12, 2025 · 1b53b8d · 1b53b8d
2 parents 13f94a2 + b99a76f
commit 1b53b8d
Show file tree

Hide file tree

Showing 3 changed files with 273 additions and 0 deletions.
diff --git a/src/core/config/Categories.json b/src/core/config/Categories.json
@@ -234,6 +234,7 @@
             "Parse User Agent",
             "Parse IP range",
             "Parse IPv6 address",
+            "IPv6 Transition Addresses",
             "Parse IPv4 header",
             "Strip IPv4 header",
             "Parse TCP",

diff --git a/src/core/operations/IPv6TransitionAddresses.mjs b/src/core/operations/IPv6TransitionAddresses.mjs
@@ -0,0 +1,209 @@
+/**
+ * @author jb30795 [[email protected]]
+ * @copyright Crown Copyright 2024
+ * @license Apache-2.0
+ */
+
+import Operation from "../Operation.mjs";
+
+/**
+ * IPv6 Transition Addresses operation
+ */
+class IPv6TransitionAddresses extends Operation {
+
+    /**
+     * IPv6TransitionAddresses constructor
+     */
+    constructor() {
+        super();
+
+        this.name = "IPv6 Transition Addresses";
+        this.module = "Default";
+        this.description = "Converts IPv4 addresses to their IPv6 Transition addresses. IPv6 Transition addresses can also be converted back into their original IPv4 address. MAC addresses can also be converted into the EUI-64 format, this can them be appended to your IPv6 /64 range to obtain a full /128 address.<br><br>Transition technologies enable translation between IPv4 and IPv6 addresses or tunneling to allow traffic to pass through the incompatible network, allowing the two standards to coexist.<br><br>Only /24 ranges and currently handled. Remove headers to easily copy out results.";
+        this.infoURL = "https://wikipedia.org/wiki/IPv6_transition_mechanism";
+        this.inputType = "string";
+        this.outputType = "string";
+        this.args = [
+	    {
+                "name": "Ignore ranges",
+                "type": "boolean",
+	        "value": true
+	    },
+            {
+                "name": "Remove headers",
+                "type": "boolean",
+                "value": false
+            }
+        ];
+    }
+
+    /**
+     * @param {string} input
+     * @param {Object[]} args
+     * @returns {string}
+     */
+    run(input, args) {
+        const XOR = {"0": "2", "1": "3", "2": "0", "3": "1", "4": "6", "5": "7", "6": "4", "7": "5", "8": "a", "9": "b", "a": "8", "b": "9", "c": "e", "d": "f", "e": "c", "f": "d"};
+
+        /**
+	 * Function to convert to hex
+	 */
+        function hexify(octet) {
+            return Number(octet).toString(16).padStart(2, "0");
+        }
+
+        /**
+	 * Function to convert Hex to Int
+	 */
+        function intify(hex) {
+            return parseInt(hex, 16);
+        }
+
+        /**
+	 * Function converts IPv4 to IPv6 Transtion address
+	 */
+        function ipTransition(input, range) {
+            let output = "";
+            const HEXIP = input.split(".");
+
+            /**
+	     * 6to4
+	     */
+            if (!args[1]) {
+                output += "6to4: ";
+            }
+            output += "2002:" + hexify(HEXIP[0]) + hexify(HEXIP[1]) + ":" + hexify(HEXIP[2]);
+            if (range) {
+                output += "00::/40\n";
+            } else {
+                output += hexify(HEXIP[3]) + "::/48\n";
+            }
+
+            /**
+	     * Mapped
+	     */
+            if (!args[1]) {
+                output += "IPv4 Mapped: ";
+            }
+            output += "::ffff:" + hexify(HEXIP[0]) + hexify(HEXIP[1]) + ":" + hexify(HEXIP[2]);
+            if (range) {
+                output += "00/120\n";
+            } else {
+                output += hexify(HEXIP[3]) + "\n";
+            }
+
+            /**
+	     * Translated
+	     */
+            if (!args[1]) {
+                output += "IPv4 Translated: ";
+            }
+            output += "::ffff:0:" + hexify(HEXIP[0]) + hexify(HEXIP[1]) + ":" + hexify(HEXIP[2]);
+            if (range) {
+                output += "00/120\n";
+            } else {
+                output += hexify(HEXIP[3]) + "\n";
+            }
+
+            /**
+	     * Nat64
+	     */
+            if (!args[1]) {
+                output += "Nat 64: ";
+            }
+            output += "64:ff9b::" + hexify(HEXIP[0]) + hexify(HEXIP[1]) + ":" + hexify(HEXIP[2]);
+            if (range) {
+                output += "00/120\n";
+            } else {
+                output += hexify(HEXIP[3]) + "\n";
+            }
+
+            return output;
+        }
+
+        /**
+	 * Convert MAC to EUI-64
+	 */
+        function macTransition(input) {
+            let output = "";
+            const MACPARTS = input.split(":");
+            if (!args[1]) {
+                output += "EUI-64 Interface ID: ";
+            }
+            const MAC = MACPARTS[0] + MACPARTS[1] + ":" + MACPARTS[2] + "ff:fe" + MACPARTS[3] + ":" + MACPARTS[4] + MACPARTS[5];
+            output += MAC.slice(0, 1) + XOR[MAC.slice(1, 2)] + MAC.slice(2);
+
+            return output;
+        }
+
+
+        /**
+	 * Convert IPv6 address to its original IPv4 or MAC address
+	 */
+        function unTransition(input) {
+            let output = "";
+            let hextets = "";
+
+            /**
+	     * 6to4
+	     */
+            if (input.startsWith("2002:")) {
+                if (!args[1]) {
+                    output += "IPv4: ";
+                }
+                output += String(intify(input.slice(5, 7))) + "." + String(intify(input.slice(7, 9)))+ "." + String(intify(input.slice(10, 12)))+ "." + String(intify(input.slice(12, 14))) + "\n";
+            } else if (input.startsWith("::ffff:") || input.startsWith("0000:0000:0000:0000:0000:ffff:") || input.startsWith("::ffff:0000:") || input.startsWith("0000:0000:0000:0000:ffff:0000:") || input.startsWith("64:ff9b::") || input.startsWith("0064:ff9b:0000:0000:0000:0000:")) {
+		/**
+		 * Mapped/Translated/Nat64
+		 */
+                hextets = /:([0-9a-z]{1,4}):[0-9a-z]{1,4}$/.exec(input)[1].padStart(4, "0") + /:([0-9a-z]{1,4})$/.exec(input)[1].padStart(4, "0");
+                if (!args[1]) {
+                    output += "IPv4: ";
+                }
+                output += intify(hextets.slice(-8, -7) +  hextets.slice(-7, -6)) + "." +intify(hextets.slice(-6, -5) +  hextets.slice(-5, -4)) + "." +intify(hextets.slice(-4, -3) +  hextets.slice(-3, -2)) + "." +intify(hextets.slice(-2, -1) +  hextets.slice(-1,)) + "\n";
+            } else if (input.slice(-12, -7).toUpperCase() === "FF:FE") {
+		/**
+		 * EUI-64
+		 */
+                if (!args[1]) {
+                    output += "Mac Address: ";
+                }
+                const MAC = (input.slice(-19, -17) + ":" + input.slice(-17, -15) + ":" + input.slice(-14, -12) + ":" + input.slice(-7, -5) + ":" + input.slice(-4, -2) + ":" + input.slice(-2,)).toUpperCase();
+                output += MAC.slice(0, 1) + XOR[MAC.slice(1, 2)] + MAC.slice(2) + "\n";
+            }
+
+            return output;
+        }
+
+
+        /**
+	 * Main
+	 */
+        let output = "";
+        let inputs = input.split("\n");
+        // Remove blank rows
+        inputs = inputs.filter(Boolean);
+
+        for (let i = 0; i < inputs.length; i++) {
+            // if ignore ranges is checked and input is a range, skip
+            if ((args[0] && !inputs[i].includes("/")) || (!args[0])) {
+                if (/^[0-9]{1,3}(?:\.[0-9]{1,3}){3}$/.test(inputs[i])) {
+                    output += ipTransition(inputs[i], false);
+                } else if (/\/24$/.test(inputs[i])) {
+                    output += ipTransition(inputs[i], true);
+                } else if (/^([0-9a-fA-F]{2}:){5}[0-9a-fA-F]{2}$/.test(inputs[i])) {
+                    output += macTransition(inputs[i]);
+                } else if (/^((?:[0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|(?:[0-9a-fA-F]{1,4}:){1,7}:|(?:[0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|(?:[0-9a-fA-F]{1,4}:){1,5}(?::[0-9a-fA-F]{1,4}){1,2}|(?:[0-9a-fA-F]{1,4}:){1,4}(?::[0-9a-fA-F]{1,4}){1,3}|(?:[0-9a-fA-F]{1,4}:){1,3}(?::[0-9a-fA-F]{1,4}){1,4}|(?:[0-9a-fA-F]{1,4}:){1,2}(?::[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:(?:(?::[0-9a-fA-F]{1,4}){1,6})|:(?:(?::[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(?::[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(?:ffff(?::0{1,4}){0,1}:){0,1}(?:(?:25[0-5]|(?:2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(?:25[0-5]|(?:2[0-4]|1{0,1}[0-9]){0,1}[0-9])|(?:[0-9a-fA-F]{1,4}:){1,4}:(?:(?:25[0-5]|(?:2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(?:25[0-5]|(?:2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$/.test(inputs[i])) {
+                    output += unTransition(inputs[i]);
+                } else {
+                    output = "Enter compressed or expanded IPv6 address, IPv4 address or MAC Address.";
+                }
+            }
+        }
+
+        return output;
+    }
+
+}
+
+export default IPv6TransitionAddresses;
diff --git a/tests/operations/tests/IPv6Transition.mjs b/tests/operations/tests/IPv6Transition.mjs
@@ -0,0 +1,63 @@
+/**
+ * IPv6Transition tests.
+ *
+ * @author jb30795
+ *
+ * @copyright Crown Copyright 2024
+ * @license Apache-2.0
+ */
+import TestRegister from "../../lib/TestRegister.mjs";
+
+TestRegister.addTests([
+    {
+        name: "IPv6 Transition: IPv4 to IPv6",
+        input: "198.51.100.7",
+        expectedOutput: "6to4: 2002:c633:6407::/48\nIPv4 Mapped: ::ffff:c633:6407\nIPv4 Translated: ::ffff:0:c633:6407\nNat 64: 64:ff9b::c633:6407",
+        recipeConfig: [
+            {
+                op: "IPv6 Transition Addresses",
+                args: [true, false],
+            },
+        ],
+    }, {
+        name: "IPv6 Transition: IPv4 /24 Range to IPv6",
+        input: "198.51.100.0/24",
+        expectedOutput: "6to4: 2002:c633:6400::/40\nIPv4 Mapped: ::ffff:c633:6400/120\nIPv4 Translated: ::ffff:0:c633:6400/120\nNat 64: 64:ff9b::c633:6400/120",
+        recipeConfig: [
+            {
+                op: "IPv6 Transition Addresses",
+                args: [false, false],
+            },
+        ],
+    }, {
+        name: "IPv6 Transition: IPv4 to IPv6 Remove headers",
+        input: "198.51.100.7",
+        expectedOutput: "2002:c633:6407::/48\n::ffff:c633:6407\n::ffff:0:c633:6407\n64:ff9b::c633:6407",
+        recipeConfig: [
+            {
+                op: "IPv6 Transition Addresses",
+                args: [true, true],
+            },
+        ],
+    }, {
+        name: "IPv6 Transition: IPv6 to IPv4",
+        input: "64:ff9b::c633:6407",
+        expectedOutput: "IPv4: 198.51.100.7",
+        recipeConfig: [
+            {
+                op: "IPv6 Transition Addresses",
+                args: [true, false],
+            },
+        ],
+    }, {
+        name: "IPv6 Transition: MAC to EUI-64",
+        input: "a1:b2:c3:d4:e5:f6",
+        expectedOutput: "EUI-64 Interface ID: a3b2:c3ff:fed4:e5f6",
+        recipeConfig: [
+            {
+                op: "IPv6 Transition Addresses",
+                args: [true, false],
+            },
+        ],
+    },
+]);