[third_party/pigweed/src] Roll 68 commits

a2b21f201273691 pw_toolchain: Rename `action_config_flag_sets` to
6532d77de01bf38 roll: gn
4b5dc0535d75ca1 roll: clang-next
3ba7cdc20535ec0 roll: 310, 311, 38, 39
16af162c6245405 pw_spi: Add Android.bp
a41e6b8905827ef targets/rp2040: Replace rp2040 target with rp2040_
72840bdfdc5b67d pw_spi_rp2040: Initiator implementation
d994a31af28c435 pw_rpc: Support legacy unsolicited responses
0d6b7c351f9baf5 pw_spi: DigitalOutChipSelector
52cc1a61e82e15d rp2040_utils: Custom libusb backend
6495a6ee1295c2f pw_toolchain: Simplify macOS -nostdlib++ usage
8a74b5a34b6efc5 pw_stream: Fix Pigweed build after sync
f54dc07d78bccaf pigweed.json: Disallow Rosetta
320427e20c5756f pw_fuzzer: Fix Bazel example, add presubmit test
33cd552638c42ec build: Fix docs build on mac-arm64
0d0b9919b7c38f6 pw_{cli,module,watch}: Add exit codes
c050599082a7277 pw_transfer: Add GetResourceStatus method
a27434745dc5cfd pw_toolchain: Remove unnecessary toolchain argumen
e8de610d576dd4a pw_chrono_rp2040: Minor tweaks to documentation an
e982c93aba2cc25 pw_multibuf: Fix soong support
8b408829fcd8b9d pw_assert_log: Fix Soong rules
bb1870ce1c8d99a many: Disable tests incompatible with rp2040
0d0c7118316bb53 many: Fix uses of std::chrono literals
8581d429e8d5a10 pw_env_setup: Use amd64 host tools on arm64
db2ee8c42fe993f pw_containers: Add default move operator for Filte
63903b4f24e9122 pw_spi: Correct full-duplex behavior of linux_spi
ff7e7a78ce968db build: Use correct host_cpu when disabling docs on
987b0a0f0f8f0d7 pw_string: Add ToString for std::optional
e7814b76f3ebcc3 build: Remove docs from default build on Arm Macs
47fb4b3f1fd0a60 zephyr: Change the pinned Zephyr commit
f61fec222738a06 pw_tokenizer: Fix link breakage on linux
9ba0e2a6c10e318 docs: Fix typo in facades documentation
e3ac615f170f5ec pw_i2c: Doxygenify RegisterDevice
568e66fab31cc7c renode: Update renode to latest daily build
6376d6fcb42a4e3 pw_metric: Fix Bazel build
ed16e1d4486b6da pw_sync: Add missing lib in soong rule
23a8972de0e8d5f pw_assert_log: Fix missing lib in soong rule
43061b6fc2229a2 pw_package: Remove capture_output=True
9b570a89ff09b0e pw_allocator: Expose TrackingAllocator's initializ
b9fcf40514d4a78 pw_log_android: Fix missing libs in soong rule
93e3ec3e23c2ad7 pw_bytes: Add missing export in soong rule
8634c8ccc66205c zephyr: Add zephyr's west CLI
6396cb44478f5b2 pw_tokenizer: Proto migration stage 5/5
95732fb2b233539 pw_containers: Add move constructor to FiltertedVi
25319124e0d486e pw_transfer: Limit test to sending a single chunk
b482f964bd56b7f pw_presubmit: Allow markdown style TODOs and adjus
ed9667511654c9f pw_transfer: Remove/hide deprecated handle interfa
83e3901fd302aa4 pw_presubmit: Log format --fix output
7a40804002b6802 pw_presubmit: Fix formatting of typescript code
a10cefdae71c520 docs: Fix 404s
f5dd358055f255f pw_bluetooth: Update emboss imports to match Bazel
8ed38666b8b7fdd pw_tokenizer: Proto migration stage 3/5
77cba4c16866ec4 pw_presubmit: Disallow FIXME and recommend TODO
b3903d8ab6c36b8 bazel: Upgrade protobuf to 4.24.4
0a3b9f8a003fd96 pw_function: //third_party/fuchsia:fit label_flag
4fcf7de601fb074 seed: Mark legacy Sensor SEED as Rejected
a77cfeaf9c50ed0 pw_toolchain: Add missing macOS cxx_builtin_includ
d0e52407fa34561 pw_tokenizer: Proto migration stage 1.5/5
e4a04ae23ee51c1 pw_config_loader: Allow skipping files
75b9e7ccc26b9f4 SEED-0125: Claim SEED number
133e57d2ea02a85 pw_tokenizer: Proto migration stage 1/5
6d845436cea4a45 build: Build for Java 11
6ed0c3ade7a7e00 pw_presubmit: Allow pwbug.dev in TODOs
768c441e6ea4b13 pw_build: Silence warnings from linker script test
9909bd414680756 pw_toolchain_bazel: Use llvm-libtool-darwin on mac
6b4f24a21d5f59f pw_grpc: Fix some minor bugs
460f429b01882c8 pw_toolchain_bazel: Explicitly depend on rules_cc
efa7618928c91da roll: go

https://pigweed.googlesource.com/pigweed/pigweed
third_party/pigweed/src Rolled-Commits: 9b1e38c0b5cbefc..a2b21f201273691
Roller-URL: https://ci.chromium.org/b/8755708034767708673
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I2a5b3c0b6e0f284e7a15001e5925be4bb21e2cf0
Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/193191
Commit-Queue: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>
Bot-Commit: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>
1 file changed
tree: c144e4ba437d350677650a7bf7964ffeed7c880f
  1. build_overrides/
  2. docs/
  3. images/
  4. include/
  5. src/
  6. third_party/
  7. toolchains/
  8. tools/
  9. .clang-format
  10. .gitignore
  11. .gitmodules
  12. .gn
  13. banner.txt
  14. bootstrap.sh
  15. BUILD.gn
  16. BUILDCONFIG.gn
  17. generate_test_values.py
  18. LICENSE
  19. navbar.md
  20. OWNERS
  21. pigweed.json
  22. pyproject.toml
  23. README.md
  24. run_fuzzer.sh
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.