roll: third_party/pigweed/src de5b668..86f3575 (47 commits)

86f3575:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/408832 roll: luci
48a54b6:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/408792 roll: fuchsia-infra-bazel-rules c5c868a..0d4e8c2 (53 commits)
dee4edd:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/395792 pw_bluetooth_proxy: Add clock facade
87fd1d9:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/408516 pw_bluetooth_sapphire: Fix time duration log formatting
295455b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/408652 pw_kernel: Update process_exit() and thread_exit() to return -> !
4b30674:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/406820 pw_status: Add Rust status_to_result helper function
9905a39:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/406819 pw_status: Add TryFrom<32> to Rust Error type
8de9277:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/406818 crates_io: Add zerocopy
4b4e1a4:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/408053 pw_kernel: Add process wrapper and update entry signature
931328b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/407852 pw_libcxx: Pass verbose abort message to PW_CRASH
01d2a5c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/408392 pw_bluetooth_proxy: Remove unused include
814beef:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/407454 pw_toolchain: Add host_clang llvm-symbolizer to path
b65d64c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/406814 pw_kernel: Handle USER signal across process termination
4a7c1a5:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/405172 pw_presubmit: Code format presubmit step
082334f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/408072 pw_async2: Hold lock in ValueFuture<void> operations
210b2c7:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/387312 pw_thread_freertos: Support initializing TLS pointers in Options
a6e88ed:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/407913 Revert "pw_thread_freertos: Use FunctionRef in ForEachThread"
53b2209:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/407832 pw_presubmit: Make pigweed_local_presubmit a standalone script
3db1a17:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/406592 pw_bluetooth_proxy: Refactor Gatt::CreateServer with DynamicMap::merge
eaa3349:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/403353 pw_bluetooth_proxy: Refactor RFCOMM manager to use DynamicMap
5004650:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/403352 pw_bluetooth_proxy: Refactor RFCOMM channel to use DynamicMap
74936ff:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/379493 pw_console: Add window display option yaml loading
de872e3:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/407034 pw_kernel: Disable a lint warning in pw_gdb_protocol
d43acc2:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/406280 pw_toolchain: Add deprecation warnings to build targets; update deps
1af0a6f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/407032 pw_toolchain: Use unmangled-names for rust compiler_builtins
d509f03:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/406817 pw_metric: Make constructor constexpr
ea1a493:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/406892 pw_tokenizer: Fix linker scripts to unblock toolchain roll
f308809:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/406815 pw_build: Use ctx.attr.copts in pw_linker_script
7aba3ab:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/404652 pw_bluetooth_sapphire: Add pseudo-states for preconditions
e61480d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/400812 pw_bluetooth_proxy: Refactor sniff offload manager to use DynamicMap
c760ee9:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/401172 pw_bluetooth_sapphire: Improve offloaded packet filtering slightly
58213f7:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/406792 pw_i2c_mcuxpresso: Add treat_arb_loss_on_full_read_as_ok flag
e8ff050:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/406813 bazel: Roll rules_rust to 0.70.0
a20565c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/406652 workflows.json: Add "sandbox" program
751ecf1:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/401992 pw_ide: Stop filtering headers in .clangd file
9aae51b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/406274 pw_kernel: Add interrupt tests to rp2350 target
535fb4d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/403833 pw_containers: Optimize DynamicMap::merge via direct node transfer
129815c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/403832 pw_containers: Add node taking and insertion support to DynamicMap
139a7da:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/402512 pw_kernel: Add reset() to kernel objects
e458f2a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/405652 pw_kernel: Add device option to cortex-m-rt crate
1638a74:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/403420 pw_presubmit: Migrate Checks to pw_presubmit.v2.Steps
41029dd:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/405732 pw_cli: Handle string args to FileFilter consistently
26c1d9e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/405292 pw_presubmit: Have Step.fix() fail the same way as Step.run()
c6ccb1f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/396312 pw_ide: Stream Bazel progress updates to terminal
c78f940:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/404332 pw_presubmit: Automatically apply fixes to a stack of commits
5ca5a43:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/405852 pw_rpc: Clear sent packet count when clearing fake channel output
fc7bf7d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/400192 pw_bluetooth_sapphire: Add stats for command reply

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: de5b6680c288f2..86f3575467c77d
Roll-Count: 1
Roller-URL: https://cr-buildbucket.appspot.com/build/8682143297642749921
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I861b777d7efaeaeccdd10ec2e92bf07874dbc3f8
Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/409012
1 file changed
tree: d018207198d792b4696e68c39fd4e5f96ebed533
  1. build_overrides/
  2. docs/
  3. dpe-rs/
  4. images/
  5. include/
  6. src/
  7. third_party/
  8. toolchains/
  9. tools/
  10. .clang-format
  11. .gitignore
  12. .gitmodules
  13. .gn
  14. banner.txt
  15. bootstrap.sh
  16. BUILD.gn
  17. BUILDCONFIG.gn
  18. generate_test_values.py
  19. LICENSE
  20. navbar.md
  21. OWNERS
  22. pigweed.json
  23. pyproject.toml
  24. README.md
  25. run_fuzzer.sh
  26. rustfmt.toml
README.md

Open Profile for DICE

This repository contains the specification for the Open Profile for DICE along with production-quality code. This profile is a specialization of the Hardware Requirements for a Device Identifier Composition Engine and DICE Layering Architecture specifications published by the Trusted Computing Group (TCG). For readers already familiar with those specs, notable distinctives of this profile include:

  • Separate CDIs for attestation and sealing use cases
  • Categorized inputs, including values related to verified boot
  • Certified UDS values
  • X.509 or CBOR certificates

Mailing List

You can find us (and join us!) at https://groups.google.com/g/open-profile-for-dice. We're happy to answer questions and discuss proposed changes or features.

Specification

The specification can be found here. It is versioned using a major.minor scheme. Compatibility is maintained across minor versions but not necessarily across major versions.

Code

Production quality, portable C code is included. The main code is in dice.h and dice.c. Cryptographic and certificate generation operations are injected via a set of callbacks. Multiple implementations of these operations are provided, all equally acceptable. Integrators should choose just one of these, or write their own.

Tests are included for all code and the build files in this repository can be used to build and run these tests.

Disclaimer: This is not an officially supported Google product.

Thirdparty Dependencies

Different implementations use different third party libraries. The third_party directory contains build files and git submodules for each of these. The submodules must be initialized once after cloning the repo, using git submodule update --init, and updated after pulling commits that roll the submodules using git submodule update.

Building and Running Tests

Quick setup

To setup the build environment the first time:

$ git submodule update --init --recursive
$ source bootstrap.sh
$ gn gen out

To build and run tests:

$ ninja -C out

More details

The easiest way, and currently the only supported way, to build and run tests is from a Pigweed environment on Linux. Pigweed does support other host platforms so it shouldn't be too hard to get this running on Windows for example, but we use Linux.

There are two scripts to help set this up:

  • bootstrap.sh will initialize submodules, bootstrap a Pigweed environment, and generate build files. This can take some time and may download on the order of 1GB of dependencies so the normal workflow is to just do this once.

  • activate.sh quickly reactivates an environment that has been previously bootstrapped.

These scripts must be sourced into the current session: source activate.sh.

In the environment, from the base directory of the dice-profile checkout, run ninja -C out to build everything and run all tests. You can also run pw watch which will build, run tests, and continue to watch for changes.

This will build and run tests on the host using the clang toolchain. Pigweed makes it easy to configure other targets and toolchains. See toolchains/BUILD.gn and the Pigweed documentation.

Porting

The code is designed to be portable and should work with a variety of modern toolchains and in a variety of environments. The main code in dice.h and dice.c is C99; it uses uint8_t, size_t, and memcpy from the C standard library. The various ops implementations are as portable as their dependencies (often not C99 but still very portable). Notably, this code uses designated initializers for readability. This is a feature available in C since C99 but missing from C++ until C++20 where it appears in a stricter form.

Style

The Google C++ Style Guide is used. A .clang-format file is provided for convenience.

Incorporating

To incorporate the code into another project, there are a few options:

  • Copy only the necessary code. For example:

    1. Take the main code as is: include/dice/dice.h, src/dice.c

    2. Choose an implementation for crypto and certificate generation or choose to write your own. If you choose the boringssl implementation, for example, take include/dice/utils.h, include/dice/boringssl_ops.h, src/utils.c, and src/boringssl_ops.c. Taking a look at the library targets in BUILD.gn may be helpful.

  • Add this repository as a git submodule and integrate into the project build, optionally using the gn library targets provided.

  • Integrate into a project already using Pigweed using the gn build files provided.

Size Reports

The build reports code size using Bloaty McBloatface via the pw_bloat Pigweed module. There are two reports generated:

  • Library sizes - This report includes just the library code in this repository. It shows the baseline DICE code with no ops selected, and it shows the delta introduced by choosing various ops implementations. This report does not include the size of the third party dependencies.

  • Executable sizes - This report includes sizes for the library code in this repository plus all dependencies linked into a simple main function which makes a single DICE call with all-zero input. It shows the baseline DICE code with no ops (and therefore no dependencies other than libc), and it shows the delta introduced by choosing various ops implementations. This report does include the size of the third party dependencies. Note that rows specialized from ‘Boringssl Ops’ use that as a baseline for sizing.

The reports will be in the build output, but you can also find the reports in .txt files in the build output. For example, cat out/host_optimized/gen/*.txt | less will display all reports.

Thread Safety

This code does not itself use mutable global variables, or any other type of shared data structure so there is no thread-safety concerns. However, additional care is needed to ensure dependencies are configured to be thread-safe. For example, the current boringssl configuration defines OPENSSL_NO_THREADS_CORRUPT_MEMORY_AND_LEAK_SECRETS_IF_THREADED, and that would need to be changed before running in a threaded environment.

Clearing Sensitive Data

This code makes a reasonable effort to clear memory holding sensitive data. This may help with a broader strategy to clear sensitive data but it is not sufficient on its own. Here are a few things to consider.

  • The caller of this code is responsible for buffers they own (of course).
  • The ops implementations need to clear any copies they make of sensitive data. Both boringssl and mbedtls attempt to zeroize but this may need additional care to integrate correctly. For example, boringssl skips optimization prevention when OPENSSL_NO_ASM is defined (and it is currently defined).
  • Sensitive data may remain in cache.
  • Sensitive data may have been swapped out.
  • Sensitive data may be included in a crash dump.