diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..384750d --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,161 @@ +name: CI + +on: + pull_request: + push: + branches: [main] + +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true + +env: + CARGO_TERM_COLOR: always + RUST_BACKTRACE: 1 + +jobs: + lint: + name: fmt + clippy + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + with: + path: wohl + - uses: actions/checkout@v4 + with: + repository: pulseengine/relay + path: relay + - uses: dtolnay/rust-toolchain@master + with: + toolchain: "1.85.0" + components: rustfmt, clippy + - uses: Swatinem/rust-cache@v2 + with: + workspaces: wohl + - name: cargo fmt --check (per workspace member) + working-directory: wohl + # `cargo fmt --all` reaches into local path-dependencies and would + # fail on unrelated drift in sibling repos (relay/, rivet/). Run + # per-package so the gate stays scoped to this workspace's members. + run: | + for c in wohl-leak wohl-temp wohl-air wohl-door wohl-power wohl-alert wohl-hub wohl-integration; do + echo "::group::cargo fmt -p $c" + cargo fmt -p "$c" --check + echo "::endgroup::" + done + - name: cargo clippy + working-directory: wohl + run: cargo clippy --workspace --all-targets -- -D warnings + + test: + name: cargo test (workspace, incl. proptest) + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + with: + path: wohl + - uses: actions/checkout@v4 + with: + repository: pulseengine/relay + path: relay + - uses: dtolnay/rust-toolchain@master + with: + toolchain: "1.85.0" + - uses: Swatinem/rust-cache@v2 + with: + workspaces: wohl + - name: cargo test + working-directory: wohl + run: cargo test --workspace --all-features + + kani: + name: Kani BMC (all 6 components) + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + with: + path: wohl + - uses: actions/checkout@v4 + with: + repository: pulseengine/relay + path: relay + - uses: dtolnay/rust-toolchain@master + with: + toolchain: "1.85.0" + - uses: Swatinem/rust-cache@v2 + with: + workspaces: wohl + key: kani + - name: Cache Kani install + uses: actions/cache@v4 + with: + path: | + ~/.cargo/bin/cargo-kani + ~/.cargo/bin/kani + ~/.kani + key: kani-${{ runner.os }}-v1 + - name: Install Kani + run: | + if ! command -v cargo-kani >/dev/null 2>&1; then + cargo install --locked kani-verifier + fi + cargo kani setup + - name: Run Kani on all components + working-directory: wohl + run: | + for c in wohl-leak wohl-temp wohl-air wohl-door wohl-power wohl-alert; do + echo "::group::Kani $c" + cargo kani -p "$c" + echo "::endgroup::" + done + + fuzz-smoke: + name: cargo-fuzz smoke (60s/target) + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + with: + path: wohl + - uses: actions/checkout@v4 + with: + repository: pulseengine/relay + path: relay + - uses: dtolnay/rust-toolchain@master + with: + toolchain: nightly + - uses: Swatinem/rust-cache@v2 + with: + workspaces: wohl + key: fuzz + - name: Install cargo-fuzz + run: cargo install --locked cargo-fuzz + - name: Fuzz fuzz_leak + working-directory: wohl + run: cargo fuzz run fuzz_leak -- -max_total_time=60 + - name: Fuzz fuzz_temp + working-directory: wohl + run: cargo fuzz run fuzz_temp -- -max_total_time=60 + + rivet-validate: + name: rivet validate (ASPICE artifacts) + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + with: + path: wohl + - uses: actions/checkout@v4 + with: + repository: pulseengine/rivet + path: rivet + - uses: dtolnay/rust-toolchain@master + with: + toolchain: "1.85.0" + - uses: Swatinem/rust-cache@v2 + with: + workspaces: rivet + key: rivet-cli + - name: Install rivet-cli + run: cargo install --locked --path rivet/rivet-cli + - name: rivet validate + working-directory: wohl + run: rivet validate diff --git a/CLAUDE.md b/CLAUDE.md index b0e6ad6..bff6eae 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -26,14 +26,16 @@ Each monitor is a stream transformer: `stream → stream`. ### Build ```bash -cargo test # Plain Rust tests -bazel test //:verus # Verus verification (when available) +cargo test --workspace # Plain Rust tests + proptest +cargo kani -p # Kani BMC, e.g. cargo kani -p wohl-leak +cargo fuzz run -- -max_total_time=60 +rivet validate # ASPICE artifact traceability ``` ### Rules - All components are no_std, no alloc -- Verified core logic in `src/core.rs` (Verus-annotated) -- Plain Rust in `plain/src/core.rs` (verus-strip output) -- Follow [Verification Guide](https://pulseengine.eu/guides/VERIFICATION-GUIDE.md) +- Verified core logic in `crates/wohl-*/plain/src/lib.rs` (Kani BMC harnesses on `engine.rs`) +- Verification floor: Kani BMC + proptest + cargo-fuzz on all 6 components +- Verus deductive proofs planned for `wohl-alert` dispatcher dedup invariant — see [#7](https://github.com/pulseengine/wohl/issues/7) - Use `rivet validate` for artifact YAML files diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..2345875 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for describing the origin of the Work and + reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Support. While redistributing the Work or + Derivative Works thereof, You may choose to offer, and charge a + fee for, acceptance of support, warranty, indemnity, or other + liability obligations and/or rights consistent with this License. + However, in accepting such obligations, You may act only on Your + own behalf and on Your sole responsibility, not on behalf of any + other Contributor, and only if You agree to indemnify, defend, + and hold each Contributor harmless for any liability incurred by, + or claims asserted against, such Contributor by reason of your + accepting any such warranty or support. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2026 pulseengine contributors + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied. See the License for the specific language governing + permissions and limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..7358a2f --- /dev/null +++ b/README.md @@ -0,0 +1,74 @@ +# Wohl — Home Supervision System + +*Wohl wahrt.* — Maintains the well-being of your home. + +[![CI](https://github.com/pulseengine/wohl/actions/workflows/ci.yml/badge.svg)](https://github.com/pulseengine/wohl/actions/workflows/ci.yml) + +Verified embedded sensor monitoring on the [PulseEngine](https://github.com/pulseengine) toolchain. Built on [Relay](https://github.com/pulseengine/relay) stream transformers. Sensor nodes publish typed streams over CCSDS; a hub routes them through six verified monitor components and dispatches alerts. + +Verified. Always on. + +## Components + +| Component | Input | Output | Safety | +|---|---|---|---| +| Water Leak | stream\ | stream\ | CRITICAL — immediate, no delay | +| Temperature | stream\ | stream\ | Freeze/overheat protection | +| Air Quality | stream\ | stream\ | CO2/PM2.5/VOC monitoring | +| Door Watch | stream\ | stream\ | Open door/window detection | +| Power Meter | stream\ | stream\ | Usage + anomaly detection | +| Alert Dispatcher | stream\ | notifications | Dedup, rate-limit, deliver | + +All component cores are `no_std`, `no_alloc`, and verified by Kani bounded model checking. + +## Architecture + +- **Sensor nodes** — ESP32-C3 / STM32G0 firmware, CCSDS-framed streams +- **Hub** — Raspberry Pi or STM32H7, runs the six monitors as Relay stream transformers +- **System model** — AADL specification in `spar/` (firmware threads, hardware nodes, deployed home topology) +- **Traceability** — ASPICE artifacts in `artifacts/{sysreq,swreq,swarch,swdd,verification}/`, validated by [Rivet](https://github.com/pulseengine/rivet) + +## Build + +```bash +# Workspace tests + proptest +cargo test --workspace + +# Kani bounded model checking (per component) +for c in wohl-leak wohl-temp wohl-air wohl-door wohl-power wohl-alert; do + cargo kani -p "$c" +done + +# Cargo-fuzz smoke (60s per target — coverage currently `fuzz_leak`, `fuzz_temp`) +cargo fuzz run fuzz_leak -- -max_total_time=60 +cargo fuzz run fuzz_temp -- -max_total_time=60 + +# ASPICE artifact traceability +rivet validate +``` + +Toolchain: see `rust-version` in workspace `Cargo.toml`. + +The `relay` and `rivet` repositories must be cloned as siblings of `wohl/` for path-dependencies to resolve. + +## Verification + +| Track | Status | +|---|---| +| Kani BMC (all components) | gated by CI | +| proptest suites | gated by CI | +| cargo-fuzz | smoke gated by CI; coverage expansion tracked via issues | +| Verus deductive proofs | planned for `wohl-alert` dispatcher dedup invariant | +| AADL system model | active in `spar/` | +| Rivet ASPICE validation | gated by CI | + +## License + +Licensed under the Apache License, Version 2.0. See [LICENSE](LICENSE) for the full text. + +## Links + +- [PulseEngine](https://github.com/pulseengine) — umbrella project +- [Relay](https://github.com/pulseengine/relay) — stream transformers +- [Rivet](https://github.com/pulseengine/rivet) — ASPICE traceability +- Issue [#1](https://github.com/pulseengine/wohl/issues/1) — CI initiative