Skip to content

Commit 7c780e3

Browse files
committed
Document different clear defaults between seal and encrypt
Also fix seal documentation, as it doesn't sign the binary by default
1 parent b785168 commit 7c780e3

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -607,7 +607,7 @@ OPTIONS:
607607

608608
`seal` allows you to sign and/or hash a binary to run on RP2350.
609609

610-
By default, it will just sign the binary, but this can be configured with the `--hash` and `--no-sign` arguments.
610+
By default, it will just add an embedded block to the end containing a relative load map, thus sealing the binary. The `--hash` and `--sign` arguments can be passed to include an hash and a signature; `--major`, `--minor` and `--rollback` can be passed to include a version; and `--clear` or `--pin-xip-sram` can be passed to add load map items.
611611

612612
Your signing key must be for the _secp256k1_ curve, in PEM format. You can create a .PEM file with:
613613

@@ -667,7 +667,7 @@ OPTIONS:
667667

668668
## encrypt
669669

670-
`encrypt` allows you to encrypt and sign a binary for use on the RP2350. By default, it will sign the encrypted binary, but that can be configured similarly to `picotool seal`. You can either provide your own bootloader to decrypt the binary (see pico-examples/bootloaders/encrypted), or embed a decrypting bootloader into the binary with the `--embed` argument, to create a self-decrypting binary.
670+
`encrypt` allows you to encrypt and sign a binary for use on the RP2350. By default, it will sign the encrypted binary, but that can be configured similarly to `picotool seal`. You can either provide your own bootloader to decrypt the binary (see pico-examples/bootloaders/encrypted), or embed a decrypting bootloader into the binary with the `--embed` argument, to create a self-decrypting binary. When embedding a bootloader, by default it will add a load map item to clear SRAM on load like the `picotool seal --clear` option - this can be disabled by passing `--no-clear`.
671671

672672
The encrypted binary will have the following structure:
673673

0 commit comments

Comments
 (0)