brickproof-fw 0.1.0__tar.gz

brickproof_fw-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 reasonable and customary use in 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 Additional Liability. 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 additional liability.
+
+   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 [yyyy] [name of copyright owner]
+
+   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.

brickproof_fw-0.1.0/PKG-INFO

@@ -0,0 +1,249 @@
+Metadata-Version: 2.4
+Name: brickproof-fw
+Version: 0.1.0
+Summary: Power-fail testing for firmware updates: cut power at every flash operation in Renode and check the device recovers
+Author: Adham Ehab
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/AdhamEhab14/brickproof
+Project-URL: Issues, https://github.com/AdhamEhab14/brickproof/issues
+Project-URL: Changelog, https://github.com/AdhamEhab14/brickproof/blob/main/CHANGELOG.md
+Keywords: firmware,bootloader,ota,power-loss,fault-injection,renode,embedded,testing
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Embedded Systems
+Classifier: Topic :: Software Development :: Testing
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: PyYAML>=6
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == "dev"
+Requires-Dist: ruff>=0.6; extra == "dev"
+Dynamic: license-file
+
+# BrickProof
+
+Pull the plug on your firmware update, in an emulator, at every point where it matters, and
+check that the device still comes back.
+
+BrickProof runs your firmware in [Renode](https://renode.io), cuts power during an update,
+powers the device back up, and checks that it recovered: an approved image is installed, it is
+really running, the update was not lost, and an older image cannot sneak back in. It tells you
+which cuts brick the device, and how to reproduce each one.
+
+It came out of the power-cut tests of
+[Three-Tier-STM32-Secure-Bootloader](https://github.com/AdhamEhab14/Three-Tier-STM32-Secure-Bootloader),
+where it found three real bugs. That bootloader's fixed release has since been cut at every one
+of the 12,109 distinct flash states of its self-update, with no failure. Supported chips: STM32F1 and STM32F4 (F411).
+
+## Quick start
+
+You need Python 3.10+ and [Renode 1.17](https://github.com/renode/renode/releases) (put
+`renode` on PATH or set `RENODE_PATH`). No toolchain, no board, no firmware of your own: a demo
+comes with the package.
+
+```bash
+git clone https://github.com/AdhamEhab14/brickproof
+cd brickproof
+pip install .
+brickproof demo
+```
+
+The demo is a small A/B bootloader updating its app from v1 to v2. BrickProof first checks
+that the update works when nothing interrupts it, then cuts power at every flash state the
+update goes through, one per line:
+
+```
+PASS baseline (no cut)   168 ops                       2.2s  runs v2
+PASS op-0                op 0     erase 0x0801E400     1.8s  runs v2
+PASS op-1                op 1     program 0x0801E400   1.7s  runs v2
+...
+167/167 cuts recovered
+coverage: 167 cut(s) over 167 distinct flash states (168 operations): every state is cut
+```
+
+Now run a build with a known bug. BrickProof should catch it:
+
+```bash
+brickproof demo self_lock --fail-fast
+```
+
+`brickproof demo --list` shows all of them:
+
+| Build | The mistake | What happens |
+|---|---|---|
+| `consume_first` | marks the staged image used before copying it | a cut leaves no valid image: bricked |
+| `trust_header` | copies the header first and trusts it without a CRC | boots a half-copied image |
+| `naive_floor` | rewrites the anti-rollback floor in place, after the install | an older image can be installed again |
+| `pop_after_switch` | pops saved registers after switching to the app's stack | reads past the end of RAM: bus fault on every boot |
+| `no_erase` | copies the new image over the old one without erasing | the chip refuses to program cells that are not erased |
+| `no_unlock` | never unlocks the flash controller | the chip ignores every write: the update silently does nothing |
+| `early_unpg` | stores every second cell after programming mode is off again | the chip ignores those stores: half the image is never written |
+| `protected_slot` | (a device setting) the app slot is write-protected | the chip refuses every erase and program there |
+| `resume_copy` | after an interrupted install, skips the erase and writes only what is missing | survives every clean cut; a torn write leaves a cell the chip will not program again |
+| `retry_limit` | gives up on an update after two interrupted attempts | survives any single cut; two cuts in a row lose the update |
+| `self_lock` | write-protects its own flash from the bootloader, in the field | a cut while the option bytes are erased, and the retry mass-erases the flash |
+
+The first three are the bugs BrickProof found in the Three-Tier bootloader. `pop_after_switch`
+was found by a real board after an emulator had passed it. The rest are mistakes a plain
+emulator lets through and a chip does not.
+
+The demo also builds for an **STM32F411**, a chip that differs from the F103 in everything a
+power cut touches: an erase wipes a whole sector of 16 to 128 KB, a program writes a word and
+is never refused (the cell ends up as old AND new), and the chip rewrites its own option
+bytes. `brickproof demo f411` runs the correct build, and `brickproof demo f411-bug-no_erase`
+and the other `f411-bug-*` builds have the same mistakes. `resume_copy` is missing there on
+purpose: an F4 does let a half-written cell be programmed again, so it is not a bug on that chip.
+It has one of its own instead, `f411-bug-watchdog`: on a device with a hardware watchdog, a
+sector erase that takes a second gets the chip reset half way through, on every attempt.
+`watchdog` and `f411-watchdog` are the correct build on such a device, and `hold_pg` and
+`f411-hold_pg` are the correct build writing flash the other common way, with programming
+mode left on over a whole run of cells.
+
+## What a run covers
+
+**Clean cuts.** A golden run traces every flash operation of the update. After a power loss
+only flash is left, so two cuts that leave the same flash are the same test: BrickProof cuts
+only at distinct flash states and tells you how many there are and how many it covered.
+`plan: every` cuts all of them. `plan: phases` cuts all of them in short phases and samples
+long ones, and the report says which phases were sampled.
+
+**Torn operations** (`--torn`). Power can fail inside an erase or a program. BrickProof also
+boots the device from those states: an erase with only some bits flipped, a cell with only
+some bits written. The shapes follow what flash cells do, but they are a model until compared
+with real hardware, so they are counted on their own line.
+
+**Cuts during recovery** (`--depth 2`). Recovery writes flash too. BrickProof traces it and
+cuts again. A flash state already tested is skipped.
+
+**The chip's rules.** A plain emulator is more forgiving than silicon. BrickProof gives the
+emulated chip its real RAM and flash sizes, faults on memory that is not there, refuses to
+program a cell that is not erased or a store of the wrong width, ignores a store made while
+programming mode is off, enforces write protection, and models the option bytes.
+Erases and programs take the time the datasheet gives them (a 128 KB sector erase is a second
+during which the CPU stands still), so watchdogs and timeouts behave as on the board.
+`flash.timing: max` in the adapter uses the slowest figures the datasheet allows. A reset
+the firmware or a watchdog causes reboots the device as on the chip, and a hardware watchdog
+set in the option bytes runs from reset.
+
+**What the update costs the flash.** Each run reports how long the chip spends erasing and
+programming, and which page or sector is erased most often per update, set against the
+endurance the datasheet promises.
+
+**An outside judge.** The verdict does not rest on what the firmware says about itself. An
+oracle checks that the bytes installed are exactly an approved image and that the CPU is
+running inside it, not in a fault handler. `runs v2` at the end of a line is its finding.
+
+**A check on itself.** After every cut, the emulated flash is compared byte for byte with
+what the golden run predicts for that point. If they differ, the run stops.
+
+To see what an update does to flash, and what a run would cut, without cutting anything:
+
+```bash
+brickproof trace examples/demo_ab_bootloader/adapter.yaml
+```
+
+```
+op 0          erase         1 ops    1 states  cut all   0x0801E400                 spare rollback-floor page
+ops 1-6       program       6 ops    5 states  cut all   0x0801E400 .. 0x0801E40A   new floor record
+op 7          erase         1 ops    1 states  cut all   0x08002000                 Slot A
+ops 8-157     program     150 ops  150 states  cut all   0x08002200 .. 0x0800232A   app body
+ops 158-165   program       8 ops    8 states  cut all   0x08002000 .. 0x0800200E   header, last
+ops 166-167   program       2 ops    2 states  cut all   0x08010000 .. 0x08010002   mark the staged image used
+plan (every): 167 cut(s) over 167 distinct flash states (168 operations): every state is cut
+```
+
+(The notes on the right are added here; the tool prints the rest.)
+
+## Options
+
+| Option | What it does |
+|---|---|
+| `--plan every` / `--plan phases` | cut every distinct flash state, or sample long phases |
+| `--torn` | also boot from torn erases and programs |
+| `--depth 2` | also cut during the recovery from each first cut |
+| `-j N` / `-j auto` | run N emulators side by side; the results do not depend on N |
+| `--real-every N` | on a long update, make every Nth cut in the emulator and compute the rest |
+| `--shard K/N` | run every Nth cut, starting with the Kth: splits a long campaign over N machines |
+| `--cut N` | run one operation alone, to reproduce a result |
+| `--fail-fast` | stop at the first failure |
+| `--json`, `--junit`, `--html FILE` | reports |
+
+The HTML report is one self-contained page: the verdict, what was covered and what was
+sampled, each failure with a command that reproduces it, the SHA-256 of every firmware file
+tested, and where the evidence fits in UN R156 and the EU Cyber Resilience Act
+([how that map is made](docs/regulations.md)).
+
+Exit codes: `0` every cut recovered, `1` at least one failed, `2` adapter error, `3` BrickProof
+itself failed (including its own flash self-check).
+
+## Testing your own firmware
+
+Write an adapter: one YAML file that says what to load, the real flash and RAM sizes of the
+chip, what is write-protected, which images are approved (the `oracle` section), and how to
+plan the cuts.
+
+If your bootloader applies an image waiting in a staging slot on the next boot (MCUboot's
+overwrite mode, most OTA designs), the built-in `staged_slot` driver does the rest, and the
+demo's [adapter.yaml](examples/demo_ab_bootloader/adapter.yaml) is the template. If the update
+is started over a protocol (UART, CAN, UDS), add a small `driver.py`, like the one for the
+Three-Tier bootloader in [adapters/three_tier_f103](adapters/three_tier_f103). Every key is explained in
+[docs/adapter.md](docs/adapter.md).
+
+```bash
+brickproof run my_adapter.yaml --torn --depth 2 -j auto --html report.html
+```
+
+## In CI
+
+```yaml
+- uses: AdhamEhab14/brickproof@v0.1.0
+  with:
+    adapter: test/brickproof.yaml
+    args: --torn --depth 2 -j 3
+```
+
+The job fails if any cut does not recover, and the JSON, JUnit and HTML reports are uploaded
+as an artifact.
+
+## Docker
+
+```bash
+docker run --rm ghcr.io/adhamehab14/brickproof              # the demo
+docker run --rm -v "$PWD:/work" ghcr.io/adhamehab14/brickproof run adapter.yaml --html report.html
+```
+
+## Layout
+
+| Path | What |
+|---|---|
+| `src/brickproof/engine/` | Renode driver in lock-step virtual time, work-folder setup |
+| `src/brickproof/models/` | The flash controller model (operation counting, cuts, the chip's rules, option bytes) and the memory guard |
+| `src/brickproof/platforms/` | Base Renode platforms the models plug into |
+| `src/brickproof/trace.py` | The golden-run trace: phases, replay to any operation |
+| `src/brickproof/plan.py` | The cut planner: distinct flash states, exhaustive or sampled |
+| `src/brickproof/torn.py` | Torn states: an erase or a program left half done |
+| `src/brickproof/oracle.py` | The outside judge: approved image installed, and really running |
+| `src/brickproof/runner.py`, `pool.py` | A campaign: baseline, cuts, torn states, depth, over one or many emulators |
+| `src/brickproof/report.py`, `regulations.py` | JUnit and HTML reports, and the regulation map |
+| `src/brickproof/drivers/` | Built-in drivers (`staged_slot`) |
+| `examples/demo_ab_bootloader/` | The demo firmware, its source, prebuilt files and adapters |
+| `adapters/` | Adapters for real projects (Three-Tier bootloader) |
+| `docs/decisions.md` | Why things are the way they are, with the measurements behind them |
+
+## Limits
+
+- The device is emulated. Torn-operation shapes are a model until compared with hardware.
+- Flash is modelled for STM32F1 (pages, halfword programming) and STM32F411 (sectors, byte
+  to double-word programming). Another family needs a model of its flash controller in
+  `src/brickproof/models/`; the engine itself no longer assumes either chip.
+- Flash timing uses datasheet figures (typical or slowest), not measurements, and does not
+  vary with temperature, voltage or age. Wear is counted per update, not simulated.
+- Not modelled: low-power modes, so the two option bits that decide whether entering one
+  resets the chip have no effect.
+
+## Licence
+
+Apache-2.0, see [LICENSE](LICENSE).