Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix typo, link to network stack example. #8

Merged
merged 1 commit into from
Oct 24, 2024
Merged

Fix typo, link to network stack example. #8

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ You can use this with queries that introspect a firmware image.
For example, if you wanted to see which compartments in the test suite can allocate memory, you might use this query:

```sh
$ cheriot-audit --board path/to/cheriot-rtos/sdk/boards/sail.json i\
$ cheriot-audit --board path/to/cheriot-rtos/sdk/boards/sail.json \
-j /path/to/cheriot-rtos/tests/build/cheriot/cheriot/release/test-suite.json \
-q '[ { "owner": owner, "capability": data.rtos.decode_allocator_capability(c) } | c = input.compartments[owner].imports[_] ; data.rtos.is_allocator_capability(c) ]'
[{"capability":{"quota":1024}, "owner":"allocator_test"}, {"capability":{"quota":1048576}, "owner":"allocator_test"}, {"capability":{"quota":4096}, "owner":"eventgroup_test"}, {"capability":{"quota":4096}, "owner":"locks_test"}, {"capability":{"quota":4096}, "owner":"multiwaiter_test"}, {"capability":{"quota":4096}, "owner":"queue_test"}, {"capability":{"quota":4096}, "owner":"thread_pool_test"}]
Expand Down Expand Up @@ -109,6 +109,10 @@ true

This includes checks that the interrupt controller is accessible only by the scheduler, that the hardware revoker (if one exists) is exclusive to the allocator, that all allocator capabilities are valid, and a few other things.

### Other Examples

- The network stack ships with a [module](https://github.com/CHERIoT-Platform/network-stack/blob/main/network_stack.rego) and a set of [additional examples](https://github.com/CHERIoT-Platform/network-stack?tab=readme-ov-file#auditing).

Built ins
---------

Expand Down
Loading