roll: third_party/pigweed/src 51bee4d..f7c9b66 (39 commits)

f7c9b66:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/362932 roll: luci
db2d6d5:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/362912 roll: fuchsia-infra-bazel-rules d7b815e..a8e54c0 (61 commits)
d6bb77d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/361232 pw_transfer: Defensively coerce 64-bit int proto fields to number
a84bf01:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/361412 pw_malloc: Add missing CMake support
35662ad:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/362276 pw_build: Remove unrecognized compiler option
a3ddf26:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/362197 pw_channel: Move BaseChannelFuture above BaseChannel
0db0781:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/355853 pw_bluetooth_sapphire: Track scan ids in only a single place
ca40879:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/355852 pw_bluetooth_sapphire: Track filtering state via enum instead of a bool
21b0144:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/358554 pw_tokenizer: Refactor tokenization to optimize stack size
c53304c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/358553 pw_toolchain: Enable stack size annotation in Rust toolchains
48bbd4e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/361776 pw_async2: Allow custom future type in FutureList::Push functions
6640ca6:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/361772 roll: toolchain-integration
f48a74e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/360555 pw_bluetooth_proxy: Add missing include
a96c2c6:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/360032 roll: toolchain-integration
f2e9519:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/360833 pw_async2: FutureCore and ValueFuture updates
97ebf57:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/350193 pw_env_setup: Remove old script
2b1210f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/358552 pw_build: Support CMake sandboxing for absolute include directories
2d3070a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/354113 pw_containers: pw::DynamicPtrVector
45a782b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/361293 pw_multisink: Check backwards iterator status
7f0c0c7:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/361052 pw_kernel: Fix direct cast
7cd3bdb:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/361032 pw_grpc: Add logging to diagnose possible flow control bug
982d592:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/328196 pw_async2: Use the websocket protocol in the codelab
cf568ba:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/360557 pw_multibuf: Use BasicDispatcher for examples
21e681a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/359932 pw_multibuf: Remove unneeded BUILD.gn
cb53389:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/332093 pw_multibuf: Store per-chunk memory context
34a27fb:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/360795 pw_async2: Use correct domain when logging task names
fcbd482:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/360512 pw_sync_stl: Explicitly include missing library
5146c83:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/359332 pw_bluetooth_proxy: Create GATT integration test
497ce0d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/332092 pw_multibuf: Encapsulate Entry details
b4b5d73:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/358992 pw_bluetooth_proxy: Create test_utils target
fa7e587:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/354257 pw_multibuf: Allow iterating all v2 chunks
0cb639e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/360393 pw_allocator: Fix standalone ControlBlock deallocation
4a071dd:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/358972 pw_async2: Remove pendable Join
deb1b75:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/359652 pw_bluetooth_proxy: Conditionally include headers
9639a66:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/360392 pw_allocator: Add missing CMake block targets
1d8a395:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/359632 pw_bluetooth_proxy: Disable gatt_test on platforms without threads
5bafe6f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/350693 pw_async2: Prototype Future without list
7d6c793:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/356814 pw_bluetooth_proxy: Implement L2capChannelManagerInterface
c9e0c40:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/360352 pw_memory: New module; ContainerOf utility

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: 51bee4d0efc40d..f7c9b663ca63fb
Roll-Count: 1
Roller-URL: https://cr-buildbucket.appspot.com/build/8692924337212635201
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: Ic1432abf361fb3df738b5e3a25a9743fe4dbad3c
Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/363013
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: 0ddc2bf7b78fbd1d6a327c033bc9ba4d334582ac
  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.