Add operaton HKDF

src/core/config/Categories.json

@@ -137,7 +137,8 @@
             "Typex",
             "Lorenz",
             "Colossus",
-            "SIGABA"
+            "SIGABA",
+            "HKDF"
         ]
     },
     {

src/core/operations/HKDF.mjs

@@ -0,0 +1,137 @@
+/**
+ * @author mikecat
+ * @copyright Crown Copyright 2023
+ * @license Apache-2.0
+ */
+
+import Operation from "../Operation.mjs";
+import Utils from "../Utils.mjs";
+import OperationError from "../errors/OperationError.mjs";
+import CryptoApi from "crypto-api/src/crypto-api.mjs";
+
+/**
+ * HKDF operation
+ */
+class HKDF extends Operation {
+
+    /**
+     * HKDF constructor
+     */
+    constructor() {
+        super();
+
+        this.name = "HKDF";
+        this.module = "Crypto";
+        this.description = "A simple Hashed Message Authenticaton Code (HMAC)-based key derivation function (HKDF), defined in RFC5869.";
+        this.infoURL = "https://wikipedia.org/wiki/HKDF";
+        this.inputType = "ArrayBuffer";
+        this.outputType = "string";
+        this.args = [
+            {
+                "name": "salt",
+                "type": "toggleString",
+                "value": "",
+                "toggleValues": ["Hex", "Decimal", "Base64", "UTF8", "Latin1"]
+            },
+            {
+                "name": "info",
+                "type": "toggleString",
+                "value": "",
+                "toggleValues": ["Hex", "Decimal", "Base64", "UTF8", "Latin1"]
+            },
+            {
+                "name": "Hashing function",
+                "type": "option",
+                "value": [
+                    "MD2",
+                    "MD4",
+                    "MD5",
+                    "SHA0",
+                    "SHA1",
+                    "SHA224",
+                    "SHA256",
+                    "SHA384",
+                    "SHA512",
+                    "SHA512/224",
+                    "SHA512/256",
+                    "RIPEMD128",
+                    "RIPEMD160",
+                    "RIPEMD256",
+                    "RIPEMD320",
+                    "HAS160",
+                    "Whirlpool",
+                    "Whirlpool-0",
+                    "Whirlpool-T",
+                    "Snefru"
+                ]
+            },
+            {
+                "name": "extract mode",
+                "type": "argSelector",
+                "value": [
+                    {
+                        "name": "with salt",
+                        "on": [0]
+                    },
+                    {
+                        "name": "no salt",
+                        "off": [0]
+                    },
+                    {
+                        "name": "skip",
+                        "off": [0]
+                    }
+                ]
+            },
+            {
+                "name": "L (number of output octets)",
+                "type": "number",
+                "value": 16,
+                "min": 0
+            },
+        ];
+    }
+
+    /**
+     * @param {ArrayBuffer} input
+     * @param {Object[]} args
+     * @returns {ArrayBuffer}
+     */
+    run(input, args) {
+        const argSalt = Utils.convertToByteString(args[0].string || "", args[0].option),
+            info = Utils.convertToByteString(args[1].string || "", args[1].option),
+            hashFunc = args[2].toLowerCase(),
+            extractMode = args[3],
+            L = args[4],
+            IKM = Utils.arrayBufferToStr(input, false),
+            hasher = CryptoApi.getHasher(hashFunc),
+            HashLen = hasher.finalize().length;
+
+        if (L < 0) {
+            throw new OperationError("L must be non-negative");
+        }
+        if (L > 255 * HashLen) {
+            throw new OperationError("L too large (maximum length for " + args[2] + " is " + (255 * HashLen) + ")");
+        }
+
+        const hmacHash = function(key, data) {
+            hasher.reset();
+            const mac = CryptoApi.getHmac(key, hasher);
+            mac.update(data);
+            return mac.finalize();
+        };
+        const salt = extractMode === "with salt" ? argSalt : "\0".repeat(HashLen);
+        const PRK = extractMode === "skip" ? IKM : hmacHash(salt, IKM);
+        let T = "";
+        let result = "";
+        for (let i = 1; i <= 255 && result.length < L; i++) {
+            const TNext = hmacHash(PRK, T + info + String.fromCharCode(i));
+            result += TNext;
+            T = TNext;
+        }
+        return CryptoApi.encoder.toHex(result.substring(0, L));
+    }
+
+}
+
+export default HKDF;

tests/operations/index.mjs

@@ -130,6 +130,7 @@ import "./tests/FletcherChecksum.mjs";
 import "./tests/CMAC.mjs";
 import "./tests/AESKeyWrap.mjs";
 import "./tests/Rabbit.mjs";
+import "./tests/HKDF.mjs";
 
 // Cannot test operations that use the File type yet
 // import "./tests/SplitColourChannels.mjs";

tests/operations/tests/HKDF.mjs

@@ -0,0 +1,180 @@
+/**
+ * @author mikecat
+ * @copyright Crown Copyright 2023
+ * @license Apache-2.0
+ */
+import TestRegister from "../../lib/TestRegister.mjs";
+
+TestRegister.addTests([
+    {
+        "name": "HKDF: RFC5869 Test Case 1",
+        "input": "0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b",
+        "expectedOutput": "3cb25f25faacd57a90434f64d0362f2a2d2d0a90cf1a5a4c5db02d56ecc4c5bf34007208d5b887185865",
+        "recipeConfig": [
+            {
+                "op": "From Hex",
+                "args": ["None"],
+            },
+            {
+                "op": "HKDF",
+                "args": [
+                    {"option": "Hex", "string": "000102030405060708090a0b0c"},
+                    {"option": "Hex", "string": "f0f1f2f3f4f5f6f7f8f9"},
+                    "SHA256", "with salt", 42,
+                ],
+            },
+        ],
+    },
+    {
+        "name": "HKDF: RFC5869 Test Case 2",
+        "input": "000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f202122232425262728292a2b2c2d2e2f303132333435363738393a3b3c3d3e3f404142434445464748494a4b4c4d4e4f",
+        "expectedOutput": "b11e398dc80327a1c8e7f78c596a49344f012eda2d4efad8a050cc4c19afa97c59045a99cac7827271cb41c65e590e09da3275600c2f09b8367793a9aca3db71cc30c58179ec3e87c14c01d5c1f3434f1d87",
+        "recipeConfig": [
+            {
+                "op": "From Hex",
+                "args": ["None"],
+            },
+            {
+                "op": "HKDF",
+                "args": [
+                    {"option": "Hex", "string": "606162636465666768696a6b6c6d6e6f707172737475767778797a7b7c7d7e7f808182838485868788898a8b8c8d8e8f909192939495969798999a9b9c9d9e9fa0a1a2a3a4a5a6a7a8a9aaabacadaeaf"},
+                    {"option": "Hex", "string": "b0b1b2b3b4b5b6b7b8b9babbbcbdbebfc0c1c2c3c4c5c6c7c8c9cacbcccdcecfd0d1d2d3d4d5d6d7d8d9dadbdcdddedfe0e1e2e3e4e5e6e7e8e9eaebecedeeeff0f1f2f3f4f5f6f7f8f9fafbfcfdfeff"},
+                    "SHA256", "with salt", 82,
+                ],
+            },
+        ],
+    },
+    {
+        "name": "HKDF: RFC5869 Test Case 3",
+        "input": "0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b",
+        "expectedOutput": "8da4e775a563c18f715f802a063c5a31b8a11f5c5ee1879ec3454e5f3c738d2d9d201395faa4b61a96c8",
+        "recipeConfig": [
+            {
+                "op": "From Hex",
+                "args": ["None"],
+            },
+            {
+                "op": "HKDF",
+                "args": [
+                    {"option": "Hex", "string": ""},
+                    {"option": "Hex", "string": ""},
+                    "SHA256", "with salt", 42,
+                ],
+            },
+        ],
+    },
+    {
+        "name": "HKDF: RFC5869 Test Case 4",
+        "input": "0b0b0b0b0b0b0b0b0b0b0b",
+        "expectedOutput": "085a01ea1b10f36933068b56efa5ad81a4f14b822f5b091568a9cdd4f155fda2c22e422478d305f3f896",
+        "recipeConfig": [
+            {
+                "op": "From Hex",
+                "args": ["None"],
+            },
+            {
+                "op": "HKDF",
+                "args": [
+                    {"option": "Hex", "string": "000102030405060708090a0b0c"},
+                    {"option": "Hex", "string": "f0f1f2f3f4f5f6f7f8f9"},
+                    "SHA1", "with salt", 42,
+                ],
+            },
+        ],
+    },
+    {
+        "name": "HKDF: RFC5869 Test Case 5",
+        "input": "000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f202122232425262728292a2b2c2d2e2f303132333435363738393a3b3c3d3e3f404142434445464748494a4b4c4d4e4f",
+        "expectedOutput": "0bd770a74d1160f7c9f12cd5912a06ebff6adcae899d92191fe4305673ba2ffe8fa3f1a4e5ad79f3f334b3b202b2173c486ea37ce3d397ed034c7f9dfeb15c5e927336d0441f4c4300e2cff0d0900b52d3b4",
+        "recipeConfig": [
+            {
+                "op": "From Hex",
+                "args": ["None"],
+            },
+            {
+                "op": "HKDF",
+                "args": [
+                    {"option": "Hex", "string": "606162636465666768696a6b6c6d6e6f707172737475767778797a7b7c7d7e7f808182838485868788898a8b8c8d8e8f909192939495969798999a9b9c9d9e9fa0a1a2a3a4a5a6a7a8a9aaabacadaeaf"},
+                    {"option": "Hex", "string": "b0b1b2b3b4b5b6b7b8b9babbbcbdbebfc0c1c2c3c4c5c6c7c8c9cacbcccdcecfd0d1d2d3d4d5d6d7d8d9dadbdcdddedfe0e1e2e3e4e5e6e7e8e9eaebecedeeeff0f1f2f3f4f5f6f7f8f9fafbfcfdfeff"},
+                    "SHA1", "with salt", 82,
+                ],
+            },
+        ],
+    },
+    {
+        "name": "HKDF: RFC5869 Test Case 6",
+        "input": "0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b",
+        "expectedOutput": "0ac1af7002b3d761d1e55298da9d0506b9ae52057220a306e07b6b87e8df21d0ea00033de03984d34918",
+        "recipeConfig": [
+            {
+                "op": "From Hex",
+                "args": ["None"],
+            },
+            {
+                "op": "HKDF",
+                "args": [
+                    {"option": "Hex", "string": ""},
+                    {"option": "Hex", "string": ""},
+                    "SHA1", "with salt", 42,
+                ],
+            },
+        ],
+    },
+    {
+        "name": "HKDF: RFC5869 Test Case 7",
+        "input": "0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c0c",
+        "expectedOutput": "2c91117204d745f3500d636a62f64f0ab3bae548aa53d423b0d1f27ebba6f5e5673a081d70cce7acfc48",
+        "recipeConfig": [
+            {
+                "op": "From Hex",
+                "args": ["None"],
+            },
+            {
+                "op": "HKDF",
+                "args": [
+                    {"option": "Hex", "string": ""},
+                    {"option": "Hex", "string": ""},
+                    "SHA1", "no salt", 42,
+                ],
+            },
+        ],
+    },
+    {
+        "name": "HKDF: RFC5869 Test Case 1 with skip extract",
+        "input": "077709362c2e32df0ddc3f0dc47bba6390b6c73bb50f9c3122ec844ad7c2b3e5",
+        "expectedOutput": "3cb25f25faacd57a90434f64d0362f2a2d2d0a90cf1a5a4c5db02d56ecc4c5bf34007208d5b887185865",
+        "recipeConfig": [
+            {
+                "op": "From Hex",
+                "args": ["None"],
+            },
+            {
+                "op": "HKDF",
+                "args": [
+                    {"option": "Hex", "string": ""},
+                    {"option": "Hex", "string": "f0f1f2f3f4f5f6f7f8f9"},
+                    "SHA256", "skip", 42,
+                ],
+            },
+        ],
+    },
+    {
+        "name": "HKDF: too large L",
+        "input": "0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b0b",
+        "expectedOutput": "L too large (maximum length for SHA256 is 8160)",
+        "recipeConfig": [
+            {
+                "op": "From Hex",
+                "args": ["None"],
+            },
+            {
+                "op": "HKDF",
+                "args": [
+                    {"option": "Hex", "string": "000102030405060708090a0b0c"},
+                    {"option": "Hex", "string": "f0f1f2f3f4f5f6f7f8f9"},
+                    "SHA256", "with salt", 8161,
+                ],
+            },
+        ],
+    },
+]);