Package cleanup (#97)

* Remove WASM support

* Copyedit crate description

* Clean up macro export/import

* Switch to dtolnay/rust-toolchain

* Replace two more actions-rs reusable workflows

* Check for rustdoc warnings

* Replace deprecated command line flag

* Fix test compilation when serde feature is enabled

* Disable everything if no features are enabled

If no KEM, KDF, or AEAD is enabled, we get compilation errors because
an empty enum cannot have #[repr(u16)] applied to it. Additionally, if
neither base-mode-open or base-mode-seal is enabled, the library can do
no useful work.

* Fix conditional compilation issues with open/seal

* Add configuration for cargo-all-features

* Test/check additional feature combinations in CI

Author: divergentdave

.cargo/config.toml

@@ -15,84 +15,40 @@ jobs:
         os: [ubuntu-latest, macOS-latest, windows-latest]
         rust: [stable, nightly]
     env:
-      # This environment variable would override the RUSTFLAGS value set in .config/cargo.toml when
-      # building for WASM. Thus, we only use it on host builds.
       RUSTFLAGS: -Dwarnings
     steps:
     - uses: actions/checkout@v6
     - name: Install ${{ matrix.rust }}
-      uses: actions-rs/toolchain@v1
+      uses: dtolnay/rust-toolchain@master
       with:
         toolchain: ${{ matrix.rust }}
-        override: true
 
     - name: Rust Cache
       uses: Swatinem/[email protected]
 
     - name: Run tests
-      uses: actions-rs/cargo@v1
-      with:
-        command: test
-        args: --all --no-fail-fast
+      run: cargo test --workspace --no-fail-fast
+    - name: Run tests (all features)
+      run: cargo test --workspace --no-fail-fast --all-features
 
   check_fmt_and_docs:
     name: Lints and Docs
     runs-on: ubuntu-latest
     env:
-      # This environment variable would override the RUSTFLAGS value set in .config/cargo.toml when
-      # building for WASM. Thus, we only use it on host builds.
       RUSTFLAGS: -Dwarnings
+      RUSTDOCFLAGS: -Dwarnings
     steps:
     - uses: actions/checkout@v6
-    - uses: actions-rs/toolchain@v1
+    - uses: dtolnay/rust-toolchain@stable
       with:
-        toolchain: stable
         components: rustfmt, clippy
-        override: true
 
-    - uses: actions-rs/clippy-check@v1
-      with:
-        token: ${{ secrets.GITHUB_TOKEN }}
-        
+    # Check using Clippy with the feature combinations listed in the README.
+    - run: cargo clippy
+    - run: cargo clippy --no-default-features --features algo-all,base-mode-open,serde
+
     - name: Format
       run: cargo fmt --all -- --check
 
     - name: Docs
       run: cargo doc --no-deps
-
-
-
-  wasm-pack:
-    name: Wasm stuff
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v6
-    - uses: actions-rs/toolchain@v1
-      with:
-        toolchain: nightly
-        override: true
-        target: wasm32-unknown-unknown
-    - uses: actions/setup-node@v6
-      with:
-        node-version: "22"
-    - name: install cargo-binstall
-      uses: cargo-bins/[email protected]
-    - name: install wasm-pack
-      run: cargo binstall wasm-pack --version 0.13.1
-    - name: build with default features
-      run: wasm-pack build
-    - name: node test
-      run: wasm-pack test --node
-  js:
-    name: TS tests
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v6
-    - uses: actions/setup-node@v6
-      with:
-        node-version: "22"
-    - run: npm ci
-    - run: npm run build
-    - run: npm run test
-
-

.eslintrc.json

@@ -10,14 +10,12 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v6
-    - uses: actions-rs/toolchain@v1
+    - uses: dtolnay/rust-toolchain@stable
       with:
-        toolchain: stable
         components: rustfmt, clippy
-        override: true
 
     - name: Build Documentation
-      run: cargo doc --all
+      run: cargo doc --workspace
 
     - name: Deploy Docs
       uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e

.github/workflows/ci.yaml

@@ -1,4 +1,2 @@
 /target
 /Cargo.lock
-.log
-/node_modules

.github/workflows/docs.yml

@@ -2,15 +2,14 @@
 name = "hpke-dispatch"
 version = "0.8.0"
 edition = "2021"
-description = "runtime algorithmic selection for hybrid public key encryption"
+description = "Runtime algorithm selection for hybrid public key encryption"
 license = "MPL-2.0"
 repository = "https://github.com/divviup/hpke-dispatch"
 readme = "./README.md"
 keywords = ["hpke", "encryption"]
 categories = ["cryptography"]
 
 [features]
-cfg_eval = []
 base-mode-open = []
 base-mode-seal = []
 serde = ["serde_crate"]
@@ -43,19 +42,17 @@ features = ["derive"]
 optional = true
 package = "serde"
 
-[target.wasm32-unknown-unknown.dependencies]
-wasm-bindgen = "0.2.87"
-getrandom_2 = { package = "getrandom", version = "0.2.16", features = ["js", "js-sys"] } # for getrandom 0.2
-getrandom_3 = { package = "getrandom", version = "0.3.3", features = ["wasm_js"] }       # for getrandom 0.3
-
-[lib]
-crate-type = ["cdylib", "rlib"]
-
-[profile.release]
-lto = true
-
 [dev-dependencies]
 hex = { version = "0.4.3", features = ["serde"] }
-serde = { version = "1.0.185", features = ["derive"] }
+serde_crate = { package = "serde", version = "1.0.185", features = ["derive"] }
 serde_json = "1.0.105"
-wasm-bindgen-test = "0.3.37"
+
+[package.metadata.cargo-all-features]
+# These features are redundant, as they only enable other features.
+denylist = ["algo-all", "aead-all", "kdf-all", "kem-all"]
+# We don't use the implicit "serde_crate" feature, only our explicitly defined
+# "serde" feature.
+skip_optional_dependencies = true
+# Allow for one of base-mode-open/base-mode-seal, one KEM, one KDF, one AEAD,
+# plus serde or another feature
+max_combination_size = 5

.gitignore

@@ -13,35 +13,8 @@ single-shot message encryption/decryption, as defined in [RFC9180§6][section-6]
 [hpke]: https://github.com/rozbb/rust-hpke
 [section-6]: https://www.rfc-editor.org/rfc/rfc9180.html#section-6
 
-## WebAssembly ready
-
-This crate is also published to npm as [`hpke`][npm] as a
-typescript/javascript package, and can also be custom built for
-specific wasm use cases (omitting unused algorithms) with
-[`wasm-pack`][wasm-pack]. For an example of using the library from
-node, see [examples/example.ts][example-ts]
-
-[npm]: https://www.npmjs.com/package/hpke
-[wasm-pack]: https://github.com/rustwasm/wasm-pack
-[example-ts]: https://github.com/jbr/hpke-dispatch/blob/main/examples/example.ts
-
-## Nightly-only feature to work around a wasm-bindgen bug: `cfg_eval`
-
-In order to opt out of `algo-all` for a wasm build, you must use
-nightly and enable the `cfg_eval` cargo feature. This is due to
-[wasm-bindgen#2058][wasm-bindgen-2058]. This is not necessary for use
-from rust, even when opting out of `algo-all`.
-
-[hpke]: https://docs.rs/hpke/latest/hpke/
-[wasm-bindgen-2058]: https://github.com/rustwasm/wasm-bindgen/issues/2058
-
 ## Available cargo features:
 
-* *`cfg_eval`*: allows this crate to be built on nightly rust for wasm
-  without `algo-all`. Note that `algo-all` (all
-  algorithms) will build for wasm on any channel without this feature.
-  disabled by default. Attempting to build for wasm with a subset.
-
 * *base-mode-open*: Enables hpke base-mode one-shot open behavior
   (receiver functionality). Enabled by default.
 
@@ -66,19 +39,9 @@ from rust, even when opting out of `algo-all`.
 
 ## Example feature usage:
 
-To depend on this crate from rust with all algorithms,
+To depend on this crate with all algorithms,
 `base-mode-open`, and `base-mode-seal`, use default features.
 
-To depend on this crate from rust with all algorithms and serde
+To depend on this crate with all algorithms and serde
 enabled, but without `base-mode-seal`: `default-features = false,
 features = ["algo-all", "base-mode-open", "serde"]`
-
-To build for wasm without `kem-x25519-hkdf-sha256` or
-`base-mode-open`: `wasm-pack build --no-default-features --features
-aead-all,kdf-all,kem-dh-p256-hkdf-sha256,base-mode-seal,cfg_eval`
-
-To build for wasm with all algorithms but without base-mode-open:
-`wasm-pack build --no-default-features --features
-algo-all,base-mode-seal`
-
-