roll: third_party/pigweed/src cf08ca9..560f88e (59 commits)

560f88e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/348392 roll: luci
63143e4:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/348252 roll: fuchsia-infra-bazel-rules, MODULE.bazel.lock
defa390:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/348232 roll: python-wheel
6e6d544:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/348052 roll: cmake
a856838:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/347873 pw_bluetooth: Add AVDTP DELAY REPORT Command
033bac6:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/346593 pw_bluetooth_proxy: Allow modification + forwarding of L2CAP payloads
1e9e2fb:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/347237 pw_async2: Allow move-only types with BlockingReceive
0d72a11:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/347672 pw_async2: Refactor guides.rst
239a43d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/345013 pw_build: Add BuildRecipe dependencies
9beab24:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/347632 pw_async2: Use more lock annotations in channel.h
b04a327:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/340696 pw_bluetooth_proxy: Add GenericL2capChannel
1cf66b6:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/347236 pw_containers: Add Contains algorithm
039ffea:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/347234 pw_async2: Replace Dispatcher::State with bool
5e618d3:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/346332 pw_web: Fix npm tests after migration
461c729:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/347472 pw_string: Clarify example overloading operator<<
840c2f2:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/347233 pw_channel: Label module as deprecated
a33f5d8:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/342072 pw_ide: Introduce fixed compile command database generation
b3087c5:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/347232 pw_async2: Link to implementing futures guide from guides.rst
f0eb6ba:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/343754 pw_async2: Update the informed poll overview
5f2e38b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/347132 pw_rpc_transport: Replace std::vector with pw::DynamicVector in tests
879d211:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/346833 pw_async2: Merge pw_async2_epoll into pw_async2
152c3d7:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/296755 seed: Unify pw_build, pw_presubmit, and the pw tool
30aacd5:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/347032 pw: Correct bazelisk quiet flag
c478e4c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/346594 pw_build: Use tomllib if available
5dc1684:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/346832 pw_containers: Fix uninitialized member issue
f931a6f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/346632 pw_toolchain: Fix typo
067d2e2:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/346172 pw_async2: Update unit test example to use futures
611bb2d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/346532 pw: Fix paths with spaces
18bbb3c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/342332 build: Add `pw_emboss_build_dir_to_root` arg
f687901:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/346312 pw_kernel: Rename .tmpl files to .jinja
50616a9:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/340536 pw_kernel: Add Interrupt Object
df48374:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/346592 pw_ide: Minor stylistic correction
4b3992b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/344332 pw_async2: Create separate doc for channels content
292a206:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/341634 third_party/freertos: Remove unused BUILD file template
49634ff:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/346373 pw_kernel: Allow archs to manipulate system generator configs
577bd71:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/346392 pw_build: Fix workflows build directory handling
1543a73:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/346132 pw_async2: Update interrupt example to use futures
abf0521:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/346333 pw_kernel: Move arch-agnostic config into a non-generic struct
b29fe85:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/346214 pw_async2: Make the dispatcher lock constinit
a6c1ae1:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/346213 pw_async2: Make dispatcher_lock() internal
dda2b35:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/344734 pw_bluetooth_proxy: Create GattNotify(Rx,Tx)Engine
9ed30c7:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/337273 pw_web: Move root npm rules and ts directory to pw_web
bd8b656:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/344733 pw_bluetooth_proxy: Create CreditBasedFlowControl(Rx,Tx)Engine
94ba316:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/345072 pw_protobuf: Advertise support for edition 2024 in protoc plugin
867b674:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/345012 pw_build: Move pigweed_upstream_build to a separate package
9878485:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/344732 pw_bluetooth_proxy: Create BasicMode(Tx,Rx)Engine
32a3e69:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/345672 pw_async2: Temporarily disable sanitizers for channel_thread_test
3f6acaf:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/344312 pw_third_party: Fix pw_third_party.nanopb for Zephyr builds
fc4c230:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/336912 pw_async2: Support multiple Dispatcher implementations
376f8b7:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/342154 pw_presubmit: Reduce formatter CLI argument handling duplication
39e48a9:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/345572 pw_clock_tree: Remove deprecated ClockDivider::Set() shim
eacd5b0:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/345393 pw_containers: Make AATreeIterators default constructible
17038a7:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/344714 pw_build: Support other workflows file formats
f3ebe85:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/342814 pw_build_info: Read the linker script variable with the correct size
e09749f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/341672 pw_bluetooth_sapphire: Stop filtering from accidentally being enabled
0f717f2:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/345352 pw_clock_tree: Provide initializer for DeferredInit::storage_
5eeabcf:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/342813 freertos: Add support library in CMake
863515e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/345373 pw_assert_basic: Add missing include
e92eaf2:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/343292 pw_thread_zephyr: Fix example usage comment

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: cf08ca98ed990e..560f88ec3e7772
Roll-Count: 1
Roller-URL: https://cr-buildbucket.appspot.com/build/8697363586836935857
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I479be3cf898857a369133293da21a45704460c7a
Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/348572
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: 468788ffccda656e99ac34323fdeb6c4c6cbbb25
  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.