fix: audit and common fixes (#55)

* fix doctests

* task: pin differential tests to specific commit (#58)

* fix(F7): CBC encryption for ooba target (#56)

* add cbc encryption for ooba target

* use crate's inner trait method

* add security warning

* fix(F6): hint entropy leak (#57)

* add hint to integrity checks

* add integrity check for add hint

* verify policy integrity before hint checks

* fix(F3): derive internal key and external key for domain separation (#59)

clippy fixes

* fix(F4): add docs for integrity

Author: lonerapier

.github/workflows/bindings.yaml

@@ -94,25 +94,6 @@ jobs:
           name: mfkdf2-web-mochawesome-report
           path: mfkdf2-web/test-results/mochawesome/
 
-
-      - name: Generate TypeScript bindings for differential tests
-        working-directory: mfkdf2-web
-        run: npm run ubrn:web:differential:release
-
-      - name: Copy index.web.ts implementation
-        run: cp mfkdf2-web/src/index.ts mfkdf2-web/src/index.web.ts
-
-      - name: Run differential tests with reports
-        working-directory: mfkdf2-web
-        run: npm run test:differential:report
-
-      - name: Upload differential HTML test report
-        if: always()
-        uses: actions/upload-artifact@v4
-        with:
-          name: mfkdf2-web-differential-report
-          path: mfkdf2-web/test-results/mochawesome-differential/
-
       - name: Run TypeScript type checking
         working-directory: mfkdf2-web
         run: npm run typecheck

.github/workflows/differential.yaml

@@ -0,0 +1,82 @@
+name: Differential Tests
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+on:
+  workflow_dispatch:
+
+env:
+  CARGO_TERM_COLOR: always
+
+jobs:
+  differential-tests:
+    name: differential
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout pinned mfkdf2.rs commit
+        uses: actions/checkout@v4
+        with:
+          ref: 7c33c7164d6e40a26c0899f19b8f9ad9b9f0c029
+
+      - name: Install Rust
+        uses: dtolnay/rust-toolchain@master
+        with:
+          toolchain: stable
+          targets: wasm32-unknown-unknown
+
+      - name: Rust Cache
+        uses: Swatinem/rust-cache@v2
+        with:
+          key: typescript/differential
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+          cache: "npm"
+          cache-dependency-path: mfkdf2-web/package-lock.json
+
+      - name: Install wasm-bindgen-cli
+        uses: taiki-e/install-action@v2
+        with:
+          tool: wasm-bindgen-cli
+
+      - name: Cache node_modules
+        id: cache-node-modules
+        uses: actions/cache@v4
+        with:
+          path: mfkdf2-web/node_modules
+          key: ${{ runner.os }}-node-modules-${{ hashFiles('mfkdf2-web/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-modules-
+
+      - name: Install mfkdf2-web dependencies
+        if: steps.cache-node-modules.outputs.cache-hit != 'true'
+        working-directory: mfkdf2-web
+        run: npm ci
+
+      - name: Generate TypeScript bindings for differential tests
+        working-directory: mfkdf2-web
+        run: npm run ubrn:web:differential:release
+
+      - name: Copy index.web.ts implementation
+        run: cp mfkdf2-web/src/index.ts mfkdf2-web/src/index.web.ts
+
+      - name: Verify bindings were generated
+        run: |
+          if [ ! -d "mfkdf2-web/src/generated" ] || [ -z "$(ls -A mfkdf2-web/src/generated)" ]; then
+            echo "Error: mfkdf2-web/src/generated does not exist or is empty"
+            exit 1
+          fi
+          if [ ! -d "mfkdf2-web/rust_modules" ]; then
+            echo "Error: mfkdf2-web/rust_modules does not exist"
+            exit 1
+          fi
+          echo "✓ TypeScript bindings verified"
+
+      - name: Run differential tests
+        working-directory: mfkdf2-web
+        run: npm run test:differential
+
+

.github/workflows/rust.yaml

@@ -119,6 +119,9 @@ jobs:
 
       - name: Run tests (JUnit)
         run: cargo nextest run --release --profile ci
+      
+      - name: Run doctests
+        run: cargo test --release --doc
 
       - name: Publish JUnit test report
         if: always()
@@ -184,7 +187,7 @@ jobs:
         uses: taiki-e/install-action@cargo-llvm-cov
 
       - name: Run cargo-llvm-cov
-        run: cargo llvm-cov --all-features --workspace --html --output-dir target/coverage
+        run: cargo llvm-cov --workspace --html --output-dir target/coverage
 
       - name: Upload coverage to Artifacts
         uses: actions/upload-artifact@v4

Cargo.lock

@@ -12,6 +12,7 @@ Please check here before filing new reports.
 | Affected Version(s) | Description                                                            | Status       | CVE / Advisory |
 | ------------------- | ---------------------------------------------------------------------- | ------------ | -------------- |
 | 0.0.1               | RSA Marvin Attack: potential key recovery through timing sidechannels. | 🔴 Unresolved | 2023-49092     |
+| 0.0.1               | Generic-Array: v0.14.9 is deprecated but used by aes-v0.8.4            | 🔴 Unresolved | -              |
 
 Legend:
 - 🟢 Fixed

SECURITY.md

@@ -31,19 +31,26 @@ See: [multifactor/MFKDF#27](https://github.com/multifactor/MFKDF/pull/27)
 See: [multifactor/MFKDF2.rs#43](https://github.com/multifactor/MFKDF2.rs/pull/43)
 - Add a `differential-test` feature flag providing a global deterministic RNG equivalent to the reference.
 - Provide utility methods in the TypeScript bindings facade for nested parameter parsing and stringification (read/write inner params) to match reference structures.
+- Pin the versions used for differential testing to:
+  - `MFKDF2.rs` commit `7c33c7164d6e40a26c0899f19b8f9ad9b9f0c029`
+  - `MFKDF` commit `3d5bf73b4ce42b23da113b4be6d35e7d941fadf8`
 
 ## How to reproduce
 
-Run the differential tests using the bindings workflow. From the repository root:
+You can run the differential tests **locally** or via the **GitHub Actions workflow**.
+
+### Locally
+
+From the repository root:
 
 ```bash
 # Ensure the WASM target is present (one-time)
 rustup target add wasm32-unknown-unknown
 
-# Generate differential-release bindings (optimized)
+# Generate differential-release bindings (includes the `differential-test` feature)
 just gen-ts-bindings-differential
 
-# Run the TypeScript test suite (includes differential tests)
+# Run only the differential TypeScript test suite
 just test-bindings-differential
 ```
 

docs/src/differential-tests.md

@@ -61,6 +61,6 @@
     "tsconfig-paths": "^4.2.0",
     "tsx": "^4.19.0",
     "typescript": "^5.6.2",
-    "mfkdf": "github:multifactor/MFKDF#test/differential-testing"
+    "mfkdf": "github:multifactor/MFKDF#3d5bf7"
   }
 }

mfkdf2-web/package-lock.json

@@ -73,7 +73,7 @@ suite('factors/hmacsha1', () => {
     derive.key
       .toString('hex')
       .should.equal(
-        '2747ebf65219aee6630a758e40fd05ccbb39ab465745ea1c9a6c5adb6673d2d3'
+        'e1e67a0a2118867d8baf660d87500e650211855d2eff4c557ef2c8ae26ab5b6f'
       );
   });
 

mfkdf2-web/package.json

@@ -14,8 +14,11 @@ required-features = ["bindings"]
 [dependencies]
 # Cryptography
 aes = { version = "0.8", default-features = false }
+cbc = { version = "0.1.2", default-features = false }
 cipher = { version = "0.4", default-features = false, features = [
   "block-padding",
+  "rand_core",
+  "std",
 ] }
 ecb = { version = "0.1", default-features = false }
 hkdf = { version = "0.12", default-features = false }
@@ -84,6 +87,7 @@ data-encoding = { version = "2.9.0", default-features = false, features = [
 ] }
 regex = { version = "1.11.3", default-features = false }
 
+
 [target.'cfg(target_arch = "wasm32")'.dependencies]
 console_log = { version = "1.0", default-features = false }
 getrandom   = { version = "0.2", default-features = false, features = ["js"] }