hiss 0.1.0

Static, type-level Noise Protocol Framework with pluggable hardware-backed crypto.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92

name: Check

# Stage 1 of the pipeline: the static gate. Formatting, lints, intra-doc
# links, MSRV and the supply-chain audit. The `Test` and `Coverage`
# workflows trigger on this workflow's completion (via `workflow_run`) and
# only run their jobs when this one concluded successfully.

on:
  push:
    branches: [main]
  pull_request:

permissions:
  contents: read

concurrency:
  group: check-${{ github.ref }}
  cancel-in-progress: true

env:
  CARGO_TERM_COLOR: always

jobs:
  fmt:
    name: rustfmt
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: dtolnay/rust-toolchain@stable
        with:
          components: rustfmt
      - run: cargo fmt --all --check

  clippy-doc:
    name: clippy + doc-links (${{ matrix.os }})
    runs-on: ${{ matrix.os }}
    strategy:
      fail-fast: false
      matrix:
        # macOS compiles the Apple Secure Enclave backend (target-gated);
        # ubuntu does not. Lint and doc both so neither path rots.
        os: [ubuntu-latest, macos-latest]
    steps:
      - uses: actions/checkout@v4
      - uses: dtolnay/rust-toolchain@stable
        with:
          components: clippy
      - uses: Swatinem/rust-cache@v2
      - name: clippy (all features, all targets)
        run: cargo clippy --all-features --all-targets -- -D warnings
      # `--all-features` lints the cryptoxide X25519 backend (a default
      # feature); eccoxide's `mod backend` impl is cfg'd out there, so lint
      # the `--no-default-features` build explicitly to keep it from rotting.
      - name: clippy (no default features — eccoxide X25519 backend)
        run: cargo clippy --no-default-features --all-targets -- -D warnings
      # `cargo doc` caches, and items behind `async-io` only break the
      # default build (the 0005 lesson) — so clean and check BOTH feature
      # sets with warnings-as-errors to catch broken intra-doc links.
      - name: doc intra-links (default features)
        run: cargo clean --doc && cargo doc --no-deps
        env:
          RUSTDOCFLAGS: -D warnings
      - name: doc intra-links (all features)
        run: cargo clean --doc && cargo doc --no-deps --all-features
        env:
          RUSTDOCFLAGS: -D warnings

  msrv:
    # Pinned to the declared MSRV (Cargo.toml `rust-version`). Policy:
    # a recent stable, floored at `stable - 3`; bump both in lockstep.
    name: MSRV (1.96)
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: dtolnay/rust-toolchain@master
        with:
          toolchain: "1.96"
      - uses: Swatinem/rust-cache@v2
      - name: cargo check on the declared MSRV (all features)
        run: cargo check --all-features --all-targets
      # eccoxide X25519 backend — cfg'd out under `--all-features`.
      - name: cargo check on the declared MSRV (no default features)
        run: cargo check --no-default-features --all-targets

  deny:
    name: cargo-deny (advisories · licenses · bans · sources)
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: EmbarkStudios/cargo-deny-action@v2
        with:
          command: check