Dist state mgmt

.github/actions/cross-tests/action.yml

@@ -13,13 +13,11 @@ inputs:
 runs:
   using: "composite"
   steps:
-      - uses: actions/checkout@v2
-      - uses: actions-rs/toolchain@v1
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@v1
         with:
-          profile: minimal
           toolchain: ${{ inputs.rust }}
-          target: ${{ inputs.target }}
-          override: true
+          targets: ${{ inputs.target }}
       - uses: RustCrypto/actions/cross-install@master
       - run: |
           # cd ${{ inputs.package }} Not needed, as only a single crate is located in this repository

.github/workflows/lms.yml

@@ -4,7 +4,7 @@ on:
   pull_request:
     branches: [ master ]
   push:
-    branches: [ master ]
+    branches: [ master, dist_state_mgmt ]
 
 env:
   MSRV: 1.57.0
@@ -15,37 +15,33 @@ jobs:
   rustfmt:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - uses: RustCrypto/actions/cargo-cache@master
-      - uses: actions-rs/toolchain@v1
+      - uses: dtolnay/rust-toolchain@v1
         with:
           toolchain: stable
           components: rustfmt
-          profile: minimal
-          override: true
       - run: |
           cargo fmt --version
           cargo fmt --all -- --check
 
   clippy:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - uses: RustCrypto/actions/cargo-cache@master
-      - uses: actions-rs/toolchain@v1
+      - uses: dtolnay/rust-toolchain@v1
         with:
           toolchain: stable
           components: clippy
-          profile: minimal
-          override: true
       - run: |
           cargo clippy --version
           cargo clippy --lib --bins --tests --examples --all-features -- -D warnings
 
   check-for-todos:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - run: make check-for-todos
         continue-on-error: true
 
@@ -54,7 +50,7 @@ jobs:
     outputs:
       msrv: ${{ steps.msrv.outputs.msrv }}
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - uses: RustCrypto/actions/cargo-cache@master
       - name: Install msrv
         run: cargo install cargo-msrv
@@ -68,9 +64,9 @@ jobs:
     outputs:
       msrv: ${{ steps.msrv.outputs.msrv }}
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - id: msrv
-        run: echo "::set-output name=msrv::$(grep rust-version Cargo.toml | cut -d'"' -f2-2)"
+        run: echo "msrv=$(grep rust-version Cargo.toml | cut -d'"' -f2-2)" >> $GITHUB_OUTPUT
 
   build:
     needs: set-msrv
@@ -84,14 +80,12 @@ jobs:
           - thumbv7em-none-eabi
           - wasm32-unknown-unknown
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - uses: RustCrypto/actions/cargo-cache@master
-      - uses: actions-rs/toolchain@v1
+      - uses: dtolnay/rust-toolchain@v1
         with:
-          profile: minimal
           toolchain: ${{ matrix.rust }}
-          target: ${{ matrix.target }}
-          override: true
+          targets: ${{ matrix.target }}
       - run: cargo build --no-default-features --target ${{ matrix.target }}
 
   test:
@@ -103,13 +97,11 @@ jobs:
           - ${{needs.set-msrv.outputs.msrv}}
           - stable
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - uses: RustCrypto/actions/cargo-cache@master
-      - uses: actions-rs/toolchain@v1
+      - uses: dtolnay/rust-toolchain@v1
         with:
-          profile: minimal
           toolchain: ${{ matrix.rust }}
-          override: true
       - run: cargo test
       - run: cargo test -- --include-ignored
       - run: cargo test --features fast_verify
@@ -119,11 +111,10 @@ jobs:
     needs: set-msrv
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - uses: RustCrypto/actions/cargo-cache@master
-      - uses: actions-rs/toolchain@v1
+      - uses: dtolnay/rust-toolchain@v1
         with:
-          profile: minimal
           toolchain: nightly
       - run: rustup run nightly cargo bench
 
@@ -137,7 +128,6 @@ jobs:
           - stable
         target:
           - aarch64-unknown-linux-gnu
-          - mips-unknown-linux-gnu
         features:
           - default
 
@@ -147,7 +137,7 @@ jobs:
       # Cross mounts only current package, i.e. by default it ignores workspace's Cargo.toml
         working-directory: .
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - uses: ./.github/actions/cross-tests
         with:
           rust: ${{ matrix.rust }}

.github/workflows/security-audit.yml

@@ -13,7 +13,7 @@ jobs:
     name: Security Audit
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v4
       - name: Cache cargo bin
         uses: actions/cache@v1
         with:

README.md

@@ -16,22 +16,32 @@ A demo application is located in the `examples` folder to demonstrate the use of
 This demo application can be used in the console as follows:
 
 ```
-# Key generation
-# Generates `mykey.priv`, `mykey.pub` with merkle tree height 10 and winternitz parameter 2
-cargo run --release --example lms-demo -- genkey mykey 10/2 --seed 0123456701234567012345670123456701234567012345670123456701234567
+# Key generation: prepare
+# Generates intermediate node, generates or reads the tree identifier (init_tree_ident 1/0), and uses "mykey" as filename base.
+# One dedicated signing entity has to create the common L-0 tree identifier (--init_tree_ident=1) before other signing entities
+# can generate their subtrees.
+#
+# The following example uses two HSS levels, first with tree height = 10 / Winternitz = 8, second with 5 / 2.
+# First, a signing entity (here: 1 of 8) creates the tree identifier
+cargo run --release --example sst_demo -- prepare_keygen mykey 10/8,5/2 --ssts=1/8 --auxsize=2048 \
+  --seed=c912a74bc8c5fc1b2a73b96e6ce1eb2317dc9aa49806b30e578436d0f659b1f5 --init_tree_ident=1
+# The signing instance index is 3 of total 8, and this signing entity will use the tree identifier and use another secret seed.
+# This will use "mykey.5.prv" and "mykey.5.aux" for private key and aux data, and "mykey_treeident.bin" to write the tree identifier
+cargo run --release --example sst_demo -- prepare_keygen mykey 10/8,5/2 --ssts=3/8 --auxsize=2048 \
+  --seed=1eb2317dc9aa49806b30e578436d0f659b1f5c912a74bc8c5fc1b2a73b96e6ce --init_tree_ident=0
+
+# Key generation: finalize
+# After all signing entities have created their intermediate node values, the public key can be generated.
+# This will use mykey.5.pub to write the public key for signing entity index 3.
+cargo run --release --example sst_demo -- finalize_keygen mykey 3
 
 # Signing
-# Generates `message.txt.sig`
-cargo run --release --example lms-demo -- sign mykey message.txt
-
-# Signing (fast_verification)
-# Generates `message.txt_mut`, `message.txt_mut.sig`
-HBS_LMS_MAX_HASH_OPTIMIZATIONS=1000 HBS_LMS_THREADS=2 cargo run --release --example lms-demo \
-    --features fast_verify -- sign_mut mykey message.txt
+# Generates `message.txt.sig` using mykey.5.prv
+cargo run --release --example sst_demo -- sign mykey 5 message.txt
 
 # Verification
-# Verifies `message.txt` with `message.txt.sig` against `mykey.pub`
-cargo run --release --example lms-demo -- verify mykey message.txt
+# Verifies `message.txt` with `message.txt.sig` against `mykey.5.pub`
+cargo run --release --example sst_demo -- verify mykey.5 message.txt
 ```
 
 ## Naming conventions wrt to the IETF RFC

benches/mod.rs

@@ -5,7 +5,9 @@ extern crate test;
 mod tests {
     use rand::{rngs::OsRng, RngCore};
     use test::Bencher;
+    use tinyvec::ArrayVec;
 
+    use hbs_lms::SstsParameter;
     use hbs_lms::{keygen, HssParameter, LmotsAlgorithm, LmsAlgorithm, Seed, Sha256_256};
     use hbs_lms::{
         signature::{SignerMut, Verifier},
@@ -23,23 +25,33 @@ mod tests {
         let mut seed = Seed::default();
         OsRng.fill_bytes(seed.as_mut_slice());
 
-        let (signing_key, _) = keygen::<Sha256_256>(hss_parameter, &seed, aux_data).unwrap();
+        let mut vec_hss_params: ArrayVec<[_; hbs_lms::REF_IMPL_MAX_ALLOWED_HSS_LEVELS]> =
+            Default::default();
+        for i in 0..hss_parameter.len() {
+            vec_hss_params.push(hss_parameter[i]);
+        }
+
+        let sst_param = SstsParameter::<Sha256_256>::new(vec_hss_params, 0, 0);
+
+        let (signing_key, _) = keygen::<Sha256_256>(&sst_param, &seed, aux_data).unwrap();
 
         signing_key
     }
 
     fn generate_verifying_key_and_signature() -> (VerifyingKey<Sha256_256>, Signature) {
         let mut seed = Seed::default();
         OsRng.fill_bytes(seed.as_mut_slice());
-        let (mut signing_key, verifying_key) = keygen::<Sha256_256>(
-            &[HssParameter::new(
-                LmotsAlgorithm::LmotsW2,
-                LmsAlgorithm::LmsH5,
-            )],
-            &seed,
-            None,
-        )
-        .unwrap();
+
+        let mut vec_hss_params: ArrayVec<[_; hbs_lms::REF_IMPL_MAX_ALLOWED_HSS_LEVELS]> =
+            Default::default();
+        vec_hss_params.push(HssParameter::new(
+            LmotsAlgorithm::LmotsW2,
+            LmsAlgorithm::LmsH5,
+        ));
+        let sst_param = SstsParameter::<Sha256_256>::new(vec_hss_params, 0, 0);
+
+        let (mut signing_key, verifying_key) =
+            keygen::<Sha256_256>(&sst_param, &seed, None).unwrap();
 
         let signature = signing_key.try_sign(&MESSAGE).unwrap();
 
@@ -50,61 +62,84 @@ mod tests {
     fn keygen_h5w2(b: &mut Bencher) {
         let mut seed = Seed::default();
         OsRng.fill_bytes(seed.as_mut_slice());
-        let hss_parameter = [HssParameter::new(
+        let mut vec_hss_params: ArrayVec<[_; hbs_lms::REF_IMPL_MAX_ALLOWED_HSS_LEVELS]> =
+            Default::default();
+        vec_hss_params.push(HssParameter::new(
             LmotsAlgorithm::LmotsW2,
             LmsAlgorithm::LmsH5,
-        )];
+        ));
+        let sst_param = SstsParameter::<Sha256_256>::new(vec_hss_params, 0, 0);
 
         b.iter(|| {
-            let _ = keygen::<Sha256_256>(&hss_parameter, &seed, None);
+            let _ = keygen::<Sha256_256>(&sst_param, &seed, None);
         });
     }
 
     #[bench]
     fn keygen_with_aux_h5w2(b: &mut Bencher) {
         let mut seed = Seed::default();
         OsRng.fill_bytes(seed.as_mut_slice());
-        let hss_parameter = [HssParameter::new(
+
+        let mut vec_hss_params: ArrayVec<[_; hbs_lms::REF_IMPL_MAX_ALLOWED_HSS_LEVELS]> =
+            Default::default();
+        vec_hss_params.push(HssParameter::new(
             LmotsAlgorithm::LmotsW2,
             LmsAlgorithm::LmsH5,
-        )];
+        ));
+        let sst_param = SstsParameter::<Sha256_256>::new(vec_hss_params, 0, 0);
 
         b.iter(|| {
             let mut aux_data = vec![0u8; 100_000];
             let aux_slice: &mut &mut [u8] = &mut &mut aux_data[..];
 
-            let _ = keygen::<Sha256_256>(&hss_parameter, &seed, Some(aux_slice));
+            let _ = keygen::<Sha256_256>(&sst_param, &seed, Some(aux_slice));
         });
     }
 
     #[bench]
     fn keygen_h5w2_h5w2(b: &mut Bencher) {
         let mut seed = Seed::default();
         OsRng.fill_bytes(seed.as_mut_slice());
-        let hss_parameter = [
-            HssParameter::new(LmotsAlgorithm::LmotsW2, LmsAlgorithm::LmsH5),
-            HssParameter::new(LmotsAlgorithm::LmotsW2, LmsAlgorithm::LmsH5),
-        ];
+
+        let mut vec_hss_params: ArrayVec<[_; hbs_lms::REF_IMPL_MAX_ALLOWED_HSS_LEVELS]> =
+            Default::default();
+        vec_hss_params.push(HssParameter::new(
+            LmotsAlgorithm::LmotsW2,
+            LmsAlgorithm::LmsH5,
+        ));
+        vec_hss_params.push(HssParameter::new(
+            LmotsAlgorithm::LmotsW2,
+            LmsAlgorithm::LmsH5,
+        ));
+        let sst_param = SstsParameter::<Sha256_256>::new(vec_hss_params, 0, 0);
 
         b.iter(|| {
-            let _ = keygen::<Sha256_256>(&hss_parameter, &seed, None);
+            let _ = keygen::<Sha256_256>(&sst_param, &seed, None);
         });
     }
 
     #[bench]
     fn keygen_with_aux_h5w2_h5w2(b: &mut Bencher) {
         let mut seed = Seed::default();
         OsRng.fill_bytes(seed.as_mut_slice());
-        let hss_parameter = [
-            HssParameter::new(LmotsAlgorithm::LmotsW2, LmsAlgorithm::LmsH5),
-            HssParameter::new(LmotsAlgorithm::LmotsW2, LmsAlgorithm::LmsH5),
-        ];
+
+        let mut vec_hss_params: ArrayVec<[_; hbs_lms::REF_IMPL_MAX_ALLOWED_HSS_LEVELS]> =
+            Default::default();
+        vec_hss_params.push(HssParameter::new(
+            LmotsAlgorithm::LmotsW2,
+            LmsAlgorithm::LmsH5,
+        ));
+        vec_hss_params.push(HssParameter::new(
+            LmotsAlgorithm::LmotsW2,
+            LmsAlgorithm::LmsH5,
+        ));
+        let sst_param = SstsParameter::<Sha256_256>::new(vec_hss_params, 0, 0);
 
         b.iter(|| {
             let mut aux_data = vec![0u8; 100_000];
             let aux_slice: &mut &mut [u8] = &mut &mut aux_data[..];
 
-            let _ = keygen::<Sha256_256>(&hss_parameter, &seed, Some(aux_slice));
+            let _ = keygen::<Sha256_256>(&sst_param, &seed, Some(aux_slice));
         });
     }
 
@@ -135,7 +170,7 @@ mod tests {
         b.iter(|| {
             let mut signing_key = signing_key.clone();
             signing_key
-                .try_sign_with_aux(&MESSAGE, Some(aux_slice))
+                .try_sign_with_aux(&MESSAGE, Some(aux_slice), None)
                 .unwrap()
         });
     }
@@ -153,7 +188,7 @@ mod tests {
         b.iter(|| {
             let mut signing_key = signing_key.clone();
             signing_key
-                .try_sign_with_aux(&MESSAGE, Some(aux_slice))
+                .try_sign_with_aux(&MESSAGE, Some(aux_slice), None)
                 .unwrap()
         });
     }
@@ -171,7 +206,7 @@ mod tests {
         b.iter(|| {
             let mut signing_key = signing_key.clone();
             signing_key
-                .try_sign_with_aux(&MESSAGE, Some(aux_slice))
+                .try_sign_with_aux(&MESSAGE, Some(aux_slice), None)
                 .unwrap()
         });
     }
@@ -203,7 +238,7 @@ mod tests {
         b.iter(|| {
             let mut signing_key = signing_key.clone();
             signing_key
-                .try_sign_with_aux(&MESSAGE, Some(aux_slice))
+                .try_sign_with_aux(&MESSAGE, Some(aux_slice), None)
                 .unwrap()
         });
     }