roll: third_party/pigweed/src f7c9b66..295a19c (45 commits)

295a19c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/365512 roll: luci
2fa2760:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/365452 roll: fuchsia-infra-bazel-rules a8e54c0..235caa4 (57 commits)
abe4030:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/363912 pw_bluetooth: Add sniff offload vendor commands
068e226:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/364217 pw_grpc: Remove deprecated methods
6eacf28:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/364552 Revert "pw_stream_uart_mcuxpresso: Acquire / release clock element dynamically"
aa3d5b4:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/361816 pw_toolchain: Add extension to manage toolchain binaries
42f3161:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/364432 pw_async2: Split FutureState from FutureCore
9fc5bc1:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/357232 pw_bluetooth_sapphire: Use IgnoreError with SendCommand
a3b3073:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/363992 pw_bluetooth_proxy: Update Android.bp
78737b3:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/358512 pw_snapshot: Android.bp missing generated headers
b842a16:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/363052 pw_allocator: Add generic fragmentation metrics support
eed7451:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/363812 pw_allocator: Delegate Reallocate in TrackingAllocator
11aeb54:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/363152 pw_containers: DynamicPtrVector swap functions
5536158:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/362393 pw_containers: Support inserting UniquePtrs for DynamicPtrVector
8ebb180:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/363692 pw_ide: Resolve symlinks when generating compile commands
0727154:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/364395 pw_async2: Make SelectFuture operations constexpr
3a66b5c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/364094 pw_async2: Update SelectFuture to new model
9e6c394:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/363672 pw_ide: Fix project root inference to not look in subdir
55ce0a1:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/363092 pw_presubmit: Minor fix for Python 3.13 compatibility
e0d90ba:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/363154 pw_async2: Define Future as a concept
d4b4132:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/364112 pw_stream: Ignore peek() result to silence [[nodiscard]] warnings
1892944:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/362057 pw_hdlc: Fix missing dependencies in router_test
15a1ccb:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/363973 workflows: Split up "default" (2/2)
1a7c46c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/363972 workflows: Split up "default" (1/2)
15d3358:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/363612 pw_build: Remove workflows ConfigLoaderOptions
7f4d75c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/363872 pw_memory: Add Android.bp
ddb74d1:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/363613 pw_libcxx: Provide common libcxx hooks
62be723:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/356812 pw_sync: Remove pw_sync/yield_core.h
b199cd1:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/361312 third_party/smartfusion_mss: Update GN and Bazel build targets
0fc1b13:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/363473 pw_libc: LLVM libc default hooks
3490c8b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/363455 perfetto: Update copybara job to point to new primary repo
099a694:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/363453 third_party/perfetto: Copybara import
0fc191f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/363178 pw_grpc: Refactor SendQueue to an abstract interface
5daee40:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/363076 pw_bluetooth_proxy: Add gatt::Server::RemoveCharacteristic
45b4833:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/362278 pw_bluetooth_proxy: Add gatt::Server::AddCharacteristic
ce3721d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/362212 pw_async2: Migrate pw_async2 Channels to FutureCore
987d92c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/361775 pw_bluetooth_proxy: Support Write Without Response (Server)
0714533:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/363474 pw_container: Avoid unsigned integer overflow
740f988:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/363153 pw_async2: Store waker in test task to avoid flakes
5f58577:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/363252 pw_containers: Add NO_SANITIZE to container
53c714a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/354135 pw_toolchain: Default Bazel upstream builds to C++20
5881ac9:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/361777 pw_async2: Remove ListableFutureWithWaker; start FutureCore docs
0f4cf19:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/361272 pw_libc: Add missing dependency on pw_preprocessor
baf7896:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/360912 pw_bluetooth_proxy: Implement gatt::Server::SendNotification
158e332:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/361792 pw_i2c_mcuxpresso: Skip aborting transfer when auto restarting interface

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: f7c9b663ca63fb..295a19c74aa881
Roll-Count: 1
Roller-URL: https://cr-buildbucket.appspot.com/build/8692290157260339153
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I0d66da328970b339f84b4d777b5d29625fcc518d
Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/365652
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: 88d048db299aad979109df657babfebd7aa61333
  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.