roll: third_party/pigweed/src 5421a43..39dbc59 (70 commits)

39dbc59:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/248016 roll: bazelisk-as-bazel
3604197:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/248015 roll: fuchsia-infra-bazel-rules 622e42b..c97cd7f (24 commits)
43f914d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/247193 pw_rpc: Enable echo_service_test in Bazel
efc9bf6:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/246432 pw_bluetooth: Add L2cap connection request/response definitions
9f29cab:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/237262 pw_bluetooth: Add L2cap signaling packets
cdc401f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/247312 pw_bluetooth_sapphire: Remove Adapter::LowEnergy::StopAdvertising
a150a8d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/247773 pw_bluetooth_sapphire: Configure interrupt spin lock backend for Fuchsia
dbc5ec0:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/247704 pw_bluetooth: Add L2cap fixed CID definitions
781c125:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/247053 pw_bluetooth_proxy: Fix connection cleanup logic on ACL disconnect
fb5a738:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/247812 pw_bluetooth_proxy: Fix Android.bp
932b260:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/247632 pw_bluetooth_proxy: Add check for max connections
be57717:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/246873 pw_i2c: Remove parameter from WriteFor reference
18d5fbf:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/247194 pw_rpc_transport: Track number of RPC packets received
d0532a7:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/245112 docs: Migrate docs toolchain from GCC to Clang
c6028ac:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/247613 pw_bluetooth: Remove unused MakeEmboss
d60a7ce:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/247612 pw_bluetooth_proxy: Migrate tests off of unchecked MakeEmboss helper
5acfafd:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/247592 pw_bluetooth_proxy: Use error checking MakeEmboss* helpers
b572584:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/247793 pw_bluetooth: Add emboss_util rule to Android.bp
facd24c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/247433 pw_build: Add CMake target for must_place linker utility
52aa0a9:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/247515 pw_bluetooth: Provide generic validating emboss View/Writer creators
b35502c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/247455 pw_preprocessor: Remove extra semicolon in test
99dfc64:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/247713 pw_bluetooth_sapphire: Remove remaining HCI packed structs
17f8803:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/247532 pw_bluetooth: Add variants of MakeEmboss* util that return a Result
5f9d087:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/247712 pw_bluetooth: Add uint versions of command opcode fields
5740ed0:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/247772 docs: Fix shortlinks
b2288d8:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/247633 Revert "pw_bluetooth_proxy: Use std::lock_guard"
d197999:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/247454 docs: Update shortlinks
fd6d1e6:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/247254 pw_bluetooth_sapphire: Remove emboss CallbackVariant types
b2c1616:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/243552 pw_stream: Add ReadExact() wrapper
cd0b4fb:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/247472 pw_protobuf_compiler: Don't rely on options file ordering
e35f4d4:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/247354 docs: Build //docs/* with Bazel
8e21d97:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/247253 pw_bluetooth_sapphire: Remove CommandCompleteCallbackVariant
05c13c4:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/247252 pw_bluetooth_sapphire: Remove more legacy event handling
6aeaef1:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/247232 pw_bluetooth_sapphire: Remove more legacy event infrastructure
45ed65c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/246193 pw_bluetooth_sapphire: Advertising RSI and Broadcast Name
79c3430:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/246552 pw_build: Support specify rust macro toolchain
98aec6f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/247353 pw_channel: Add guidance about when to implement Channel
b15aa11:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/246892 pw_channel: Add a note about reading and writing from different tasks
4e78f90:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/246972 docs: Fix in-site search
8441834:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/246496 bazel: Move emboss dep to MODULE.bazel
0c5f766:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/247352 build: Update emboss to v2024.1017.203246
9a02d21:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/245118 pw_web: Add log-viewer dependencies in root package.json
fc03520:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/246734 pw_web: Run eslint fix on all .ts files
a6ff2cb:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/246737 pw_log: Update includes for tokenized arguments
0a4e6db:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/246239 pw_channel: Move to PendAllocateWriteBuffer
f335a36:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/246352 pw_bluetooth_sapphire: Remove instances of CommandCompleteEventParams
7f97693:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/245312 pw_build: Fix GN rust debug opt level
322cd39:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/247172 pw_bluetooth_sapphire: Embossify command status events
31d6d4f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/246792 pw_bluetooth_sapphire: Embossify callbacks used with SendCommand
811a594:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/246632 pw_bluetooth_sapphire: Replace instances of CommandCompleteEventParams
70d3941:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/246932 pw_*: Fix typo messsage->message
c638d7a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/246712 pw_bluetooth: Move emboss_util from pw_bluetooth_proxy/internal
3cb8dc4:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/246874 pw_unit_test: Separate target for status macros
e3bbf58:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/246992 pw_bluetooth: Define a subset of commonly used PSM/SPSM fixed values
16b4bf5:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/246572 pw_proto_compiler: GN Per-target oneof API switch
4f3b911:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/246653 pw_docgen: Add 2025 PW Live dates
c3b1d34:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/246714 pw_bluetooth_proxy: Add pw_result to Android.bp
d7d4134:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/245152 pw_async2: Add waker guidance
618f47e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/245117 pw_web: Simplify proto compiler script for JS
4fbb15f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/246735 pw_{async2,channel}: Start FAQ sections
1c6d9e8:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/246733 pw_docgen: Remove 11/18/2024 PW Live
2fd2d13:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/246498 pw_log_basic: Add pw_log_string handler backend
6a16fab:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/246692 pw_protobuf: Allow unset oneof callbacks
1dcac6a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/246412 pw_allocator: Separate PMR from Allocator
54ca0db:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/241192 pw_bluetooth_proxy: Use std::lock_guard
29771c1:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/230832 pw_bluetooth_proxy: L2CAP CoC & GATT Notify channels
6329e8d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/246092 pw_bytes: Restore byte_builder.cc in Android.bp
30519ca:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/246353 pw_bluetooth_sapphire: Remove another packed struct
d557e7f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/246313 pw_bluetooth_sapphire: Remove another packed struct
0634370:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/246497 roll: fuchsia-infra-bazel-rules 986ed50..622e42b (50 commits)

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: 5421a431f4bdd4..39dbc59552835f
Roll-Count: 1
Roller-URL: https://cr-buildbucket.appspot.com/build/8731609240519216865
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: Ibc36cc3752c024eddad498655f53457a186eecd8
Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/248020
Bot-Commit: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>
Commit-Queue: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>
Lint: Lint 🤖 <android-build-ayeaye@system.gserviceaccount.com>
1 file changed
tree: 851d4b361c31af66d0f77bf4b651cc8204b33857
  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
$ 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.