roll: third_party/pigweed/src 7f189f2..01465b9 (46 commits)

01465b9:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/426172 roll: luci
eb49bda:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/426132 roll: fuchsia-infra-bazel-rules 1281548..7e0784c (49 commits)
26e4d31:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/424212 pw_rp2350: Add experimental pw_kernel target
20639e3:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/421833 bazel: Mark more targets as incompatible_with_mcu()
e7d13cc:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/425412 pw_grpc: Require external synchronization on allocator
b77dda7:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/424616 doxygen: Do not generate verbatim headers
d13b8a7:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/421832 bazel: Bazel 9 toolchains and execution platforms
ff2c4f1:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/424133 pw_bluetooth_proxy: Fix MSan violations in L2CAP and tests
f3bd526:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/415618 pw_bluetooth_sapphire: Suppress LE auto-connect on request timeout
6bf2c64:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/424040 pw_chre: Implement CHRE_HANDLE_FATAL_ERROR
7a09e5a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/420792 pw_bluetooth_sapphire: Remove PW_CRASH from device_address.cc
1207515:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/418132 pw_env_setup: Include pigweed.json in runfiles and default to empty
3ec21c1:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/425012 pw_build: Add protobuf dependency to workflows
c0336fb:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/410873 pw_protobuf: Add occurrence option to Find APIs
b5432ee:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/423812 pw_trace_tokenized: Fix clock tick underflow
0b1623f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/415652 pw_rpc: Use counting StreamEncoder and remove scratch buffer
f582ea6:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/411312 pw_protobuf: Add counting mode to StreamEncoder
17529b3:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/424617 pw_presubmit: Disable CMake sandboxing
8038b50:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/423452 pw_presubmit: Support --fix alias for --mode fix
c720a6e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/418432 pw_chrono_zephyr: Resolve multiple issues SystemTimerZephyr
05e43b7:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/423432 rust: Enable additional clippy lints
d955d73:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/412852 pw_kernel: Update docs
ae82201:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/424312 docs: Update sphinxcontrib-mermaid to v2.0.2
aa2f2d7:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/422352 pw_bluetooth_proxy: Reset rx engine on socket close
530488b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/411772 docs: Update OS docs and add toctree extension
a564897:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/424052 pw_async2: Avoid static_assert(false)
370ab3e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/420512 pw_build_android: Upgrade to C++23
930ea07:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/410454 pw_rpc: Add SendPacket API
2b2653c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/420873 pw_kvs: Detect checksum errors on partial reads
527b443:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/416972 pw_varint: Make an inline friendly small varint helper
2b97a2c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/423532 OWNERS: Separate core and extended owners
57eb382:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/424039 pw_presubmit: Remove per-file/include check
8ad5f33:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/421592 rust: Update Pigweed root clippy config
05e8635:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/420932 pw_metric: Remove context struct in writer
8a67275:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/421555 pw_time: Add initial Rust time module
f2c72b4:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/423892 pw_bluetooth: Add LE Subrate Change subevent code
89c6002:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/423912 hci_android.emb: sniff subrating max latency of 0
61b2abe:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/423995 pw_bluetooth_sapphire: Removing using statements from bind
d0b4ab9:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/423994 pw_bluetooth_sapphire: Migrate to fdf::DriverBase2
bf1cf08:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/423993 pw_bluetooth_sapphire: Update Fuchsia SDK
5701d88:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/423593 docs: Use upstream search-as-you-type feature
5408f53:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/423592 docs: Update deps
c4bf834:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/423413 pw_kernel: correct sleep bug in the interrupts_test
e5d1883:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/420872 pw_kvs: Check that entries fit within a sector
7539f96:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/423433 pw_rpc: use atomic<uint32_t> in test harness
0519526:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/420292 pw_bluetooth_sapphire: Validate entire HCI event view

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: 7f189f25227743..01465b97384a68
Roll-Count: 1
Roller-URL: https://cr-buildbucket.appspot.com/build/8678338224344783825
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I86113df33d735d75d4cfe96c1cab861f03219602
Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/426332
1 file changed
tree: 25867b2eb3402faaa42d495f0d4c63d675287484
  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.