roll: third_party/pigweed/src 22c0113..5172ccd (34 commits)

5172ccd:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/251433 pw_bluetooth: Add avdtp parser fundation
e431fab:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/251332 pw_bluetooth_sapphire: Queue ISO frames in stream as needed
683ebcf:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/251132 pw_bluetooth_proxy: Rename ACL data channel mutex
027897c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/251112 pw_bluetooth_proxy: Clarify naming on L2capReadChannel payload functions
91d9808:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/251053 pw_bluetooth_proxy: Add automatic LE connection tracking
6ab78b0:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/249717 pw_bluetooth_proxy: Automatically track BR/EDR ACL connections
acad654:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/250995 pw_bluetooth_proxy: Fix up checks in RfcommChannel
21e7118:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/250994 pw_bluetooth_proxy: Rename AclTransport to AclTransportType
8f822ad:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/249753 pw_bluetooth_proxy: Add host packet processing for signaling channel
e278ead:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/251172 pw_presubmit: Add check for cc_library includes
d276762:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/251012 pw_bluetooth: Return OnceReceivers & pass by rvalue where appropriate
47b42e6:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/250993 pw_bluetooth_proxy: Add max directions constant for acl connections
a07f5d9:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/251054 pw_presubmit: Support query in build.bazel
c4d59ce:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/248693 pw_unit_test: Stop stringifying successful expectations
8b4ba86:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/251052 Revert "docs: Build module docs with Bazel"
a21f796:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/250575 pw_bluetooth_proxy: Expose BasicL2capChannel acquisition in ProxyHost
96cc516:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/250574 pw_bluetooth_proxy: Provide OnFragmentedPduReceived() default impl
d64fd1f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/250573 pw_bluetooth_proxy: Add AreValidParameters() to L2capReadChannel
5477cb2:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/250533 pw_env_setup: Update clang next version
79f3d71:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/249752 pw_bluetooth_proxy: Factor out fragmented ACL checks and add direction
011b16b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/249715 pw_bluetooth_proxy: Prepare for ACL layer event handling API
9271d13:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/249714 pw_bluetooth_proxy: Add missing error check on basic l2cap channel
c790911:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/250692 docs: Fix kconfig extension
4df7828:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/250992 pw_bluetooth_proxy: Add missing state_ set to rfcomm channel move const
5436d10:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/248014 docs: Build module docs with Bazel
3a2ef99:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/250932 pw_bluetooth_proxy: Resolve outstanding comments on rfcomm channel
36e4b7e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/249713 pw_bluetooth_proxy: Support BR/EDR credits
e4ec19f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/248132 pw_bluetooth_proxy: Add RfcommChannel
9eac938:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/250632 docs: Create Bazel filegroups for Doxygen inputs
5a94d1f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/250672 pw_bluetooth_sapphire: DeviceClass for incoming connections
568adcf:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/248078 docs: Refactor SEED index autogen
126e36c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/250852 pw_cli_analytics: Do not run test on device
1dece8e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/250812 pw_malloc: Prevent optimizer from eliding allocations
d94a24a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/250532 SEED-0001: Update filenames in SEED instructions

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: 22c0113f9cdb0b..5172ccdf4a1bad
Roll-Count: 1
Roller-URL: https://cr-buildbucket.appspot.com/build/8729706705163456993
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I7b455a070796f026c901966a15873d2b02ffdb12
Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/251674
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: 4697bfbca8858113b7fa6f51461ae821246ff9bd
  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.