[third_party/pigweed/src] Roll 51 commits

d365083b1f6176f roll: clang
b5394433e33073a roll: 310, 311, 38, 39
672680871220815 targets/stm32f429i_disc1: Fix test runner
a29fdb8419329c2 pw_bluetooth: Use unit test framework
705e27d3c5a4497 pw_emu: Link all the docs to each other
728cae2995c2f83 pw_allocator: Add support for fuzzing Allocator im
9fbb6e3b715cdea pw_fuzzer: Fix ambiguous reference to ContainerOf
1c48652525ab25e pw_toolchain_bazel: Remove legacy tool API
37f7f02f6a245af pw_containers: Add missing dep for IntrusiveList t
4c9e4e44db5b48e pw_env_setup: Roll cipd client
b9f453ade17d1cd pw_transfer: Allow setting different timeouts for
b9ad908f421276d pw_emu: Update docs to follow new guidelines
14a998f1cb3f0d7 pw_unit_test: Fix building fuzztests with cmake
1490d9bc0e4e244 targets: Point deprecated flag to new backend
33111eb30bcf0e9 SEED-0121: Claim SEED number
cd306e909eaca80 pw_symbolizer: Fix symbolizer_test
a9219c14811c0c5 pw_string: Fix string_test build error under new c
cf66b43b371d9bd pw_web: Add support for call_id in RPC calls
b67cd436314184b zephyr: Remove unecessary toolchain downloads & fi
f5387e64b519f2b docs: Add sort by alignment to size optimizations
303f354624ee666 docs: Fix build command typo
b582d48bcdb6928 pw_trace: Use unit test framework
bfa9f248eba0b1d pw_{bytes,varint}: Use unit test framework
bdbad9cc5e918a3 pw_unit_test: Use unit test framework
a425af30b054abc pw_{thread,tls_client}: Use unit test framework
ab2aa2d26954924 pw_snapshot: Use unit test framework
d173a4e9ac16a30 pw_{random,result}: Use unit test framework
a2d8b43a331b194 pw_{perf_test}: Use unit test framework
855dfd6d1eb8d03 pw_{malloc,metric}: Use unit test framework
2430362ed54963d pw_{kvs,libc,log}: Use unit test framework
9586deb24b1f3f2 pw_{hdlc,hex_dump,i2c}: Use unit test framework
c51a9bc8a8a139d SEED-0001: Update number selection guidance
7953c9df29abda9 pw_{digital_io,file}: Use unit test framework
2b7c5107304c148 pw_docgen: Add new docs server
e07df935bae480f pw_{checksum,chrono}: Use unit test framework
c75a06be1f6326d pw_{base64,blob_store}: Use unit test framework
7db269ec0ad29cd pw_{allocator,analog}: Use unit test framework
17e3417a74749bc pw_unit_test: Create facade's header
70b05788999ebb5 pw_web: Add Mocha and Jest global vars to ESLint
65e429cf96e79e1 pw_build: Fix use of TARGET_COMPATIBLE_WITH_HOST_S
4f809be10d9f000 pw_web: Switch to pre-made subset of icon fonts
f25590ccd6f2053 pw_tokenizer: Mark `pw_tokenizer_core` as `no_std`
692407c186591b0 pw_bluetooth_sapphire: Update name of ISO host sup
a096b2129236808 pw_bluetooth: Fix LEExtendedCreateConnectionComman
7dba768bf61a4b0 pw_presubmit: Better support downstream GnGenNinja
4425936519af4ec pw_bluetooth: Fix ExtendedCreateConnectionV1
a9c7bc1ca476c30 pw_env_setup: Bump executing Python package
62bf533508b772f build: Set Zephyr toolchain to llvm in presubmit
cba8918fe60cd67 pw_bluetooth: Add new HCI definition
aaf73fe286b7858 pw_bluetooth: Re-format emboss files
7d77fbfb9f6ad82 SEED: Always use build metadata titles in index ta

https://pigweed.googlesource.com/pigweed/pigweed
third_party/pigweed/src Rolled-Commits: e35aa3aecf78ae4..d365083b1f6176f
Roller-URL: https://ci.chromium.org/b/8762049822559585313
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I8470e02732d5c8edf356e7e766d39afb4637c7ce
Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/184532
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: 9793cda356ededa151e3592c578de876eebe04ee
  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.