roll: third_party/pigweed/src aeecb42..22c0113 (30 commits)

22c0113:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/249716 pw_bluetooth_proxy: Remove unnecessary writer for disconnect event
8a31009:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/249712 pw_bluetooth: Add DISCONNECTION_REQ to l2cap definitions
2944c9a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/250512 pw_module: Update SEED filename in creation command
620d2ad:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/250452 pw_bluetooth_proxy: Fix Android.bp
acd4c15:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/250432 pw_presubmit: Check that files appear in bp files
f776679:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/249072 pw_protobuf: Expand message structure limitations docs section
f4e18d1:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/248452 docs: Normalize SEED filenames
55f09ff:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/250332 pw_allocator: Fix Android.bp
8a568e4:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/250353 pw_multisink: Ignore unsigned negation sanitizer warnings
a2a859e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/250352 pw_cli: Suppress analytics exceptions
eec163b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/250153 pw_malloc: Tag tests as manual in bazel
9fb399c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/241113 pw_toolchain: Move arm_gcc to rule_cc toolchains
c409392:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/235493 pw_bluetooth_sapphire: Fix unused parameter warnings
758d608:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/249972 pw_protobuf: Respect max_count when computing kMaxEncodedSizeBytes
c389296:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/248152 bazel: Minor WORKSPACE cleanup
76f7aa2:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/246654 pw_bluetooth_proxy: Add ACL-U signaling channel
4834a70:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/246952 pw_async2: Add task lifecycle diagram
1c771e0:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/249912 pw_transfer: Log when streams close unexpectedly
67bef9a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/249592 pw_bluetooth_proxy: Use std::lock_guard
0942b69:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/234817 pw_allocator: Refactor best- and worst-fit allocators to use buckets
0766dba:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/234816 pw_allocator: Refactor first fit allocators
3bfdac7:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/234815 pw_allocator: Refactor Bucket
f84afe1:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/234812 pw_allocator: Parameterize BlockAllocator on blocks
8cc8495:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/234814 pw_malloc: Additional checks when testing
65b5e33:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/249372 pw_allocator: Fix metrics for blocks that shift bytes
33d00a7:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/234811 pw_allocator: Use BlockResult in BlockAllocator
f43ca4f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/242633 pw_allocator: Use move-semantics for Block API
6417a52:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/232214 pw_allocator: Add static polymorphism to Block
a287811:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/248192 pw_bytes: Add utility for checking alignment
48712ad:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/249532 pw_transfer: Shrink window size on retried data

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: aeecb42c9905da..22c0113f9cdb0b
Roll-Count: 1
Roller-URL: https://cr-buildbucket.appspot.com/build/8730340882973380113
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I7989adf8bfcfb8b3d4fe0732827bd361952b0ef6
Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/250752
Lint: Lint 🤖 <android-build-ayeaye@system.gserviceaccount.com>
Bot-Commit: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>
Commit-Queue: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>
1 file changed
tree: 65da72b680dc5b51e104da5d8fd84d5d6f3ba9c6
  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.