roll: third_party/pigweed/src c6751d6..4392e55 (48 commits)

4392e55:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/298172 pw_toolchain: Remove unneeded allowlist_include_directories
899c24a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/297173 pw_kernel: Add more early draft docs
3f4f714:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/297277 pw_kernel: Automated system generation
cbf3839:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/297741 third_party: Add hashlink crate
725cf2a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/297740 third_party: Add toml crate
bc77a6c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/297895 docs: Add note about Tests-Not-Needed
4377109:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/297793 pw_protobuf: Add `invalid` argument to generated *ToString() functions
cbbdff1:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/297739 third_party: Add askama crate
fb1869f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/297734 pw_kernel: In presubmits, run lints last
b85158a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/297274 pw_i2c_mcuxpresso: Acquire and Release underlying clock
c4afd9a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/297795 pw_rpc: Skip flaky ubsan findings
eac2db8:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/297232 python: Upgrade to mypy==1.16.0
df47878:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/297334 pw_kernel: Move thread/process macros to thread module
dc665f6:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/297732 roll: fuchsia-infra-bazel-rules c8e04ec..2231354 (90 commits)
47598c1:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/297333 pw_kernel: Standardize Rust formatting
fcf1264:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/297672 pw_allocator: Restore WrapUnique
6f696e1:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/297652 pw_env_setup: PyPI version bump to 0.0.24
70ff3da:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/297433 pw_tokenizer: Fix link in docs; add comment to example
a5c96f1:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/295994 pw_allocator: Add MakeUnique to Pool and TypedPool
67d2686:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/296156 pw_container: Add PendHasSpace, PendNotEmpty
fd291fe:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/296772 pw_build: Remove unused statement from Zephyr test template
6663122:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/284632 pw_async2: Add CallbackTasks
a747b55:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/296252 pw_containers: Add support for generic sized InlineAsyncQueue
fefe610:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/295906 pw_allocator: Add bounded array support for New, MakeUnique and Delete
97716ff:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/297372 pw_thread/id: Implement getter for native handles for threads
bae07df:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/297432 pw_kernel: Fix no panic tests
db350e8:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/289976 pw_thread_zephyr: Support generic thread creation
d7e4c82:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/296054 pw_bluetooth_sapphire: Fix advertising handle leak
e3f2e04:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/296065 pw_env_setup: Combine two SSL errors into one
4ef754f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/295905 pw_allocator: Make more UniquePtr ctors public
8a202ae:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/297172 bazel: Remove deprecated WORKSPACE helpers
c0d285b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/296972 pw_result: Add tests for `or_else` for pw::expected
a491292:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/297272 pw_cli_analytics: Make analytics work in Bazel-based projects
444ae70:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/294872 pw_thread_zephyr: Fix CONFIG_THREAD_NAME definition check
b316849:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/295904 pw_allocator: Make Counter a more generic test utility
602807a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/289636 pw_multibuf: Add byte iterator for multibuf_v2
40f6791:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/295332 pw_kernel: Deny more Clippy lints
c47ef79:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/297212 pw_ide: Ignore arguments after double dash
ad703c6:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/219172 pw_thread_freertos: Provide support libraries with thread backend
44f10b0:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/296692 pw_file: Implement NameOnlyFileEntry
51271c8:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/271092 third_party/tinyusb: Bazel build file
2128983:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/296892 pw_crypto: Implement ECDH for Mbed-TLS
da52e25:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/296832 pw_ide: Add manual testing guide
196813e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/295394 docs: Temporarily remove changelog from search results
67acdfa:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/296873 SEED-0134: Claim SEED number
c119adf:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/293592 pw_presubmit: Fix build_zephyr step
4d01a58:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/296753 roll: zephyr
5a70bcf:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/296732 .gitignore: Add .gemini

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: c6751d607bdaed..4392e55b890c2d
Roll-Count: 1
Roller-URL: https://cr-buildbucket.appspot.com/build/8712159865612733569
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: If0b57b18555b63fb20d5e4453b6739aa945d7667
Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/298135
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: 4e595371a304d02abbdf2330b8094167e4bca559
  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.