Skip to content

[doc] update workshop exercises instructions for v1.1 branch #84

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

Merged
engdoreis merged 1 commit into from
Jan 23, 2026
Merged

[doc] update workshop exercises instructions for v1.1 branch #84

Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion doc/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ Nix can and will build everything from source if it can't find a cached version,
Clone the Sonata software repository, *making sure to recursively clone submodules as well*, then navigate into it.

```sh
git clone --branch v1.0 \
git clone --branch v1.1 \
--recurse-submodule \
https://github.com/lowRISC/sonata-software.git
cd sonata-software
Expand Down
6 changes: 3 additions & 3 deletions exercises/firmware_auditing/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ To convert the undefined value to a Boolean, we use the `default` keyword, which
We can run this policy on our example firmware using the following command:

```sh
cheriot-audit --board=cheriot-rtos/sdk/boards/sonata.json \
cheriot-audit --board=cheriot-rtos/sdk/boards/sonata-prerelease.json \
--firmware-report=build/cheriot/cheriot/release/firmware_auditing_part_1.json \
--module=exercises/firmware_auditing/part_1/no_sealed_capabilities.rego \
--query='data.no_seal.valid'
Expand Down Expand Up @@ -138,7 +138,7 @@ Finally, we create a simple Boolean `valid` rule which combines our two conditio

Now, we can audit the firmware for this exercise by using the following command:
```sh
cheriot-audit --board=cheriot-rtos/sdk/boards/sonata.json \
cheriot-audit --board=cheriot-rtos/sdk/boards/sonata-prerelease.json \
--firmware-report=build/cheriot/cheriot/release/firmware_auditing_part_2.json \
--module=exercises/firmware_auditing/part_2/interrupt_disables.rego \
--query='data.interrupts.valid'
Expand Down Expand Up @@ -203,7 +203,7 @@ For this exercise, we decide that all sealed allocator capabilities must be vali

We can audit our firmware using the following command:
```sh
cheriot-audit --board=cheriot-rtos/sdk/boards/sonata.json \
cheriot-audit --board=cheriot-rtos/sdk/boards/sonata-prerelease.json \
--firmware-report=build/cheriot/cheriot/release/firmware_auditing_part_3.json \
--module=exercises/firmware_auditing/part_3/malloc_check.rego \
--query='data.malloc_check.valid'
Expand Down
6 changes: 3 additions & 3 deletions exercises/hardware_access_control/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,13 +118,13 @@ However, when run against the part 1 firmware image's report it will return fals
```sh
# This should return true
cheriot-audit \
--board cheriot-rtos/sdk/boards/sonata-1.1.json \
--board cheriot-rtos/sdk/boards/sonata-prerelease.json \
--module exercises/hardware_access_control/part_3/gpio_access.rego \
--query "data.gpio_access.only_gpio_access_has_access" \
--firmware-report "build/cheriot/cheriot/release/hardware_access_part_2.json"
# This should return false
cheriot-audit \
--board cheriot-rtos/sdk/boards/sonata-1.1.json \
--board cheriot-rtos/sdk/boards/sonata-prerelease.json \
--module exercises/hardware_access_control/part_3/gpio_access.rego \
--query "data.gpio_access.only_gpio_access_has_access" \
--firmware-report "build/cheriot/cheriot/release/hardware_access_part_1.json"
Expand All @@ -135,7 +135,7 @@ We can use this to restrict which compartments have access to the GPIO via `gpio

```sh
cheriot-audit \
--board cheriot-rtos/sdk/boards/sonata-1.1.json \
--board cheriot-rtos/sdk/boards/sonata-prerelease.json \
--module exercises/hardware_access_control/part_3/gpio_access.rego \
--query "data.gpio_access.whitelisted_compartments_only" \
--firmware-report "build/cheriot/cheriot/release/hardware_access_part_2.json"
Expand Down