roll: third_party/pigweed/src 6985a85..0c348e1 (45 commits)

0c348e1:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/281552 roll: luci
90d1391:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/281383 mbedtls: Remove `-fno-lto` from config
284af91:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/281278 pw_kernel: Support Rust ABI thread entry points
d780738:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/280836 pw_bluetooth_sapphire: Acquire wake leases in CommandChannel
5e3fd74:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/278013 pw_bluetooth_sapphire: Acquire wake leases in l2cap::ChannelImpl
d91e37c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/277233 pw_kernel: Implement syscalls
143289f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/281452 pw_tokenizer: Move test out of pw::tokenizer to reflect real use
7ce7812:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/281279 bazel: Explicitly specify platforms for crates_std
7a7e380:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/281374 pw_kernel: Thread entrypoints are `extern "C" fn`s
0478608:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/280977 pw_kernel: Add optional Mutex debug logging
26e657b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/269613 LTO: Retain symbols that were discarded by LTO
58e290a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/245173 pw_tokenizer: Clarify tokenization in headers
b6ba89f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/281392 bazel: Update libusb source hash
f59444c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/253913 pw_unit_test: Run RPC-based tests on dedicated thread
74fc655:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/281256 Revert "pw_env_setup: Add some Rosetta logging"
665725c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/275672 pw_bluetooth: Fix docs.rst section ordering and nesting
7fcc58e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/279852 build: Upgrade rules_rust to 0.59.2
3a27d96:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/279493 bazel: Rename Python pip hub
f69b7e7:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/279992 pw_bluetooth_sapphire: Populate advertising fields in peer
cef99cf:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/278712 bazel: Update to latest rules_cc
96f1e37:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/277752 pw_env_setup: Add some Rosetta logging
e63f000:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/280976 pw_kernel: Remove nomem and nostack on interrupt guards
b78d7e2:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/280975 pw_kernel: Support usize registers
a1f21a8:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/278012 pw_bluetooth_sapphire: Acquire wake leases in AclDataChannel
7beeec2:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/280662 pw_ring_buffer: Implement PopBack
c02f54a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/274334 pw_toolchain: Remove WORKSPACE toolchain helper
de2fc41:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/280661 pw_ring_buffer: Make iterator entry mutable
cc646fb:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/280847 pw_build: Use __COUNTER__ instead of __LINE__ for unique marker
4a1180f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/280834 pw_toolchain: Friend NoDestructor for class with private destructor
e07806d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/280934 pw_tokenizer: Avoid std::byte cast from char
3583585:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/280312 pw_tokenizer: Add support for detokenizing custom domains in C++
231ff06:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/279912 pw_bluetooth_sapphire: Handle inbound L2CAP Flow Control Credit Ind
6b17f4e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/280752 pw_kernel: Fix log message encoding
ea3cdbd:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/280732 pw_kernel: Change k_host to use basic logging
212e8a0:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/280502 pw_format: Fix cast detection in some rust-analyzer cases
bc7c0a1:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/280292 pw_bluetooth: Address TODO to clean the interface
0512437:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/280594 pw_kernel: Refactor thread initialization
b800743:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/280560 pw_kernel: Refactor unittest to reduce duplication
5ad36c0:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/280557 pw_kernel: Use in-tree list library for unittest
4a1dfeb:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/280593 pw_kernel: Provide macro for defining list links
2dad233:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/280592 pw_bluetooth_sapphire: Fix GN sapphire presubmit step
58a409b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/280395 bazel: Allow use of Python 3.10 in Bazel
97a53b1:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/279415 pw_interrupt_xtensa: Remove module
b423fb8:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/280432 Revert "pw_build: Use --output_base for build_dir"
90e30c5:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/280332 pw_console: Remove SO_REUSEPORT from SocketClient

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: 6985a85e5cc6b0..0c348e1c1632b3
Roll-Count: 1
Roller-URL: https://cr-buildbucket.appspot.com/build/8718291484810596129
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I1b55c82a5da5cc448b738cfd92e1b5ad218a1698
Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/281594
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: 2ba93216bb3fe4beb91c09c95fa509877a2cad53
  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.