[third_party/pigweed/src] Roll 61 commits

9269d8b8178f716 roll: gn
ebb23ae202abf06 roll: clang-next
61eafe32b059946 pw_multibuf: Pass reference instead of pointer
13ebfcbcdbe52cf pw_presubmit: Begin formatter modularization
e2e0b793d02ca00 pw_sys_io_rp2040: Use callbacks to block on input
ed54939324e82a5 pw_{bluetooth_sapphire, env_setup, presubmit}: Fuc
dd01216fe0c4cc4 pw_rpc: Move some headers from srcs to hdrs
94b1e27729f2b64 pw_digital_io_linux: Add Android.bp
c29c6a0f7bc8c58 pw_containers: Add move constructors to queues
9d19990b7c45db9 pw_sync_stl: Android.bp: Add missing dependency on
c385a8af8335709 pw_presubmit: Switch default formatter to black
97f2d044c356664 pw_unit_test: Localize the label flags
ad9855ce2a6b9ef pw_log_android: Add pw_log_android_stderr
6484e183fe1afbe pw_log_android: Add module documentation
71ad8f01f5735ae zephyr: Add action for installing Zephyr SDK
67c84946526726e pw_digital_io_linux: Add test CLI
1db68c304885566 pw_unit_test: Add test record event handler
a40cea068aab447 pw_docgen: Single-source the module metadata
25731b152a43843 bazel: Treat Rust warnings as errors
ae355bd50d8342b pw_{malloc, sys_io}: Add backend label flags
a3980ea97818f25 pw_log: Introduce localized backend label flags
781ca39bf1aec12 pw_assert: Introduce :backend, :backend_impl
588f7e3139c425c pw_format: Enhance Rust tests to check for argumen
c48913eb9e0bc8d docs: Fix some incorrect target names
88fe42a81eb8d01 pw_checksum: Add missing #include <array>
7d55609f2ff182a pw_assert_basic: Fix BUILD.bazel file
6ac2d4b370be1ee pw_format: Add initial support for untyped specifi
04b24a89a24be81 bazel: Localize backend label flags
130004ab3b161b9 pw_libc: Define LIBC_FAST_MATH for the faster inte
e58a9ad72c86c4c pw_build_android: Add new utils module
64c48347cf7ccbd pw_polyfill: Update __cplusplus macro for C++23; s
a230ae449576bc3 pw_channel: Support datagram-to-byte conversions
22961f56a2bdc98 pw_allocator: Various API modifications
96c4cc2fc472b57 bazel: Use pw_facade
2f7282802bce209 pw_polyfill: Remove PW_INLINE_VARIABLE
3c48164394446e5 bazel: Introduce pw_facade
7995a693b330d2c pw_web: NPM version bump to 0.0.15
3e997d8134d55e7 pw_libc: Add uksqrtui to stdfix
60c4cef991b451c pw_channel: Handle closed channels in base
caac07d3a5c440b pw_transfer: Add abort() and terminate() apis
f9f0a915fed0c59 pw_{assert, thread_zephyr}: Apply formatting fixes
4f404e5d0cbcf95 pw_transfer: Update the proxy to only consider tra
0c001652b86381f pw_allocator: Add IsEqual
8c3aef92d3b774f docs: Fix mentions of sample_project
db089088b951fdc pw_allocator: Soft-deprecate heap_viewer.py
c8a45fd5afa72a9 pw_bluetooth: Add command complete event
84e0776bdfd8cb1 pw_bluetooth: Add command complete event
8160a4da123eb03 pw_allocator: Move code snippets from docs to exam
c66b857f68439ac roll: clang
543f721f41dee53 docs: TOC entry for API documentation from source
e4881d6811941cb pw_allocator: Clean up sources files
4bfff95481ee895 pw_log: Run bpfmt on all Android.bp
1a4757dd7737821 bazel: Fix bazel query
efd9953c94acd1a roll: clang
c382dcf1602b355 pw_rpc: Add TryFinish API for pw_rpc stream
7df8e94ec97536e pw_rpc: Remove deprecated functions from Java clie
b95cc02594b74ea pw_sys_io_stm32cube: Fix build for f0xx, f1xx and
a6b8457ccb7422c pw_json: Move examples outside of the pw namespace
9e6bf8bf6a16fca third_party/stm32cube: Fix bazel hal driver build
b087cdb31f8d85b pw_unit_test: Adding googletest_handler_adapter to
f7c7c823a49dba8 roll: go

https://pigweed.googlesource.com/pigweed/pigweed
third_party/pigweed/src Rolled-Commits: 1f12d06f5133a9a..9269d8b8178f716
Roller-URL: https://ci.chromium.org/b/8753171321966605185
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I4e539ad1f42130287a21b828c3f59996d88ea460
Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/197154
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: 5deaa39b671e6e9464c2d269996566b29f617833
  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.