[third_party/pigweed/src] Roll 63 commits

c6c4a5bbeef2f11 roll: gn
dabe438c436d688 roll: 310, 311
bb8031432ff42f7 pw_i2c_rp2040: Initiator implementation
a4bba78b1e9a492 third_party/emboss: Assume newer emboss version 2/
910df6e3f5bcf8d pw_bluetooth_proxy: Bluetooth proxy module and ini
57ed394d46cf9c3 pw_channel: Introduce forwarding channels
59f919a2d3be9d9 pw_unit_test: Add failing results test record
9504f97a66a10b8 docs: Update changelog
48fe6ee0922e732 pw_polyfill: Simplify backported features table
b919fb4ac9a67ea pw_router: Add Android common backends as dep
ce3e3629ef32d03 Soong: Remove _headers from lib names
e6409a838bd0e6f pw_sync: Follow Soong guidelines
b0d763d4d17841a pw_chrono: Follow Soong guidelines
8c8494548f28209 pw_{assert_log,log}: Follow Soong guidelines
02d3e4353cf8864 pw_stream_shmem_mcuxpresso: Fix interrupt pending
a73e5df5219dd32 pw_transfer: Inline TRANSFER_CLIENT_DEPS
2018db0bc261192 docs: Add CLI style guide
a6d09d4aec4b9b0 pw_hex_dump: Add CMake support
3a4a66a91eab6ee python: Use future annotations
9109c0d8630a578 pw_log: Add rate limit log statements
f39e03d8ec13490 pw_channel: Enable GetWriteAllocator function
0002cea68b95854 pw_web: NPM version bump to 0.0.16
ca0edf4ec6724a1 python: Use future annotations
78bf0ebd45afff7 pw_web: Update createLogViewer to use union types
00411468dd71e45 pw_channel: Require explicit datagram-to-byte conv
16ff09038907a69 pw_byte: Add ExtractBits template
8233856d51b6a0d pw_sensor: Add configuration SEED
5aac11549981fda pw_allocator: Improve size report accuracy
c04c34a53bd20f2 pw_unit_test: Flag to disable cmake pw_add_test ca
4a174fc4c97911e pw_build: Option to not transitively run py .tests
42616d83123f217 pw_presubmit: Suppress stdout option for rst_forma
e97b4de5f89d8c8 pw_{bluetooth_sapphire, env_setup}: Use amd64 SDK
3d1184ac3b600ba docs: Move TODO style guide
3f04730295c131b pw_chre: Remove unused files
14ea5c1bad262d1 docs: Fix redirect paths
01b2dfb3828bc32 pw_log_android: Fix Soong build
5e764ba471878e7 pw_hdlc: Expose Encoder
ac995d465310e6c docs: Fix code-block indentation
48804a4d98d85b1 python: Remove PathOrStr variables
578c3aa99962d9d third_party/emboss: Assume newer emboss version 1/
583f98c6a639ad0 third_party: Minor build file formatting fixes
e31c0f38ba59286 pw_{rpc,transfer}: Support full java protos
bce7ebb1cb9638e pw_allocator: Add buffer utilities
d2e8ec33012a882 pw_allocator: Improve UniquePtr ergonomics
2f9dd9339f474a9 pw_{assert,log}: Add keep_dep tags to backend_impl
9fce2807fecf6d1 python: Switch from typing.Optional[...] to "... |
a7ae303c326f03b python: Switch from typing.Union to "|"
cccf6991fb2ac81 python: Use argparse.BooleanOptionalAction
29145e1bad586aa python: Use pathlib.Path.is_relative_to()
5ae66deb4c7d159 python: Switch from typing.Dict to dict
29485980c72340b docs: Add redirects infrastructure and docs contri
139448a532041f5 python: Switch from typing.Tuple to tuple
fd2ad3a688da8f0 python: Switch from typing.List to list
a9f055a32cc1ac0 pw_package: Match Emboss version used by Bazel
fa8e6c497fa2268 pw_multibuf: Add stream implementation
5c8a3f79b83ef56 pw_channel: Remove max_bytes argument from ReadPol
c3965666758921d pw_multibuf: Add empty() function
4fb184103c05d01 pw_env_setup: Update min Python version to 3.10
b2a514a4ae0d2c5 bazel: Remove the deprecated pw_cc_facade macro
2d735c7ce46d1c0 pw_spi: Update Android.bp to conform with new styl
1f4a92c0cf89704 pw_unit_test: Add duplicate test case
088229ce2d5325e pw_web: Include file information in browser logs
afbcd94d50e0f72 pw_containers: ConstexprSort in FlatMap takes an i

https://pigweed.googlesource.com/pigweed/pigweed
third_party/pigweed/src Rolled-Commits: 9269d8b8178f716..c6c4a5bbeef2f11
Roller-URL: https://ci.chromium.org/b/8752537138926221137
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I0d9db4af29a1d4d59b1b7d3afba63049468d4b14
Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/199430
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: e7d2cb492d48039c9cbc69007ae8955c3cd16af5
  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.