roll: third_party/pigweed/src 97dc276..7940ef2 (36 commits)

7940ef2:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/258172 pw_bluetooth_proxy: Fix H4PacketWithH4 doc string typo
9337bf2:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/247593 docs: Add toolchain homepage
79b08cb:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/258192 roll: fuchsia-infra-bazel-rules e8a4e9f..32b5945 (41 commits)
717e4f5:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/257913 pw_thread: Simplify disabling join() function when not supported
0891a72:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/256878 docs: Remove local images
ab8ffe3:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/257792 pw_bluetooth_proxy: Common formatting in logs
dc898a5:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/257732 pw_bluetooth_proxy: Add missing period in log message
a74450b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/256844 pw_bluetooth_proxy: Check AclConnection is in correct state
2bfed7f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/257452 pw_bluetooth_proxy: Unregister channels when they are closed
52507bf:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/257116 pw_bluetooth_proxy: Additional logging
83e02f4:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/257115 pw_bluetooth_proxy: Fix log fields order in SendEvent
031bf13:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/257072 pw_span: Recommend passing pw::span objects by value
b8ef392:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/257332 pw_bluetooth_sapphire: Fix function sharing in gap
3d4cd64:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/256652 docs: Fix sitemap generator
eda3c11:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/257313 BUILD.gn: Use module vars intead of absolute // paths
f2c318e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/256842 docs: Fix location of layout file in Bazel build
5237640:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/256092 pw_bluetooth_proxy: Provide IsWriteAvailable function
ae9750e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/256841 pw_bluetooth_proxy: Don't log dtor of moved-from channel objects
7cac792:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/256840 pw_bluetooth_proxy: Remove extra space from some logs
58e24d6:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/256839 pw_bluetooth_proxy: Log if disconnect with unknown connection
953f10a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/257232 pw_multibuf: Fix Android.bp
645d820:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/256837 pw_bluetooth_proxy: Rename FindAclConnection to FindOpenAclConnection
d4d56ca:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/257074 pw_thread_freertos: Assert PW_THREAD_FREERTOS_CONFIG_* are valid
1140dc2:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/256836 pw_bluetooth_proxy: Add logging for events
2f2d633:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/257073 pw_bluetooth_proxy: Add logging for setup and teardown
babdb2a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/257112 pw_protobuf: Initialize variables in docs example
6582c5e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/256874 pw_transfer: Handle continue chunks with earlier window end offsets
912c1b5:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/255292 pw_toolchain: Add path parameter for gcc binary location
68e18ed:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/255894 pw_containers: Support moving intrusive lists
5fa6e32:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/256732 pw_protobuf_compiler: New library-include-format
4afcce7:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/256876 fuchsia: Bump Fuchsia SDK version to 26.20241230.5.1
e851b2c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/256834 bazel: Load from @rules_android//android:rules.bzl
bc6e04c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/256833 bazel: Clean up empty globs
256d1ec:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/256832 bazel: Load android_library from rules_android
9a839e8:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/256793 pw_sync_freertos: Fix regression in TimedThreadNotification
52e4852:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/256752 roll: fuchsia-infra-bazel-rules a6893c6..e8a4e9f (46 commits)

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: 97dc276f6942c0..7940ef25e097da
Roll-Count: 1
Roller-URL: https://cr-buildbucket.appspot.com/build/8726535810779634657
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I28250ec094cdd82569cbb5ba6c1ea2de1fc09e65
Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/258214
Bot-Commit: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>
Lint: Lint 🤖 <android-build-ayeaye@system.gserviceaccount.com>
Commit-Queue: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>
1 file changed
tree: 5e0b431b7b7ab61ceab69eb606b867d2710fe44e
  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.