roll: third_party/pigweed/src 4be0d00..78d65b0 (43 commits)

78d65b0:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/295453 roll: luci
5d879ed:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/295395 roll: ninja
ca8eaaa:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/295392 roll: fuchsia-infra-bazel-rules b63154e..c8e04ec (54 commits)
892af24:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/273456 third_party/freertos: Conditionally add new Cortex-M0 file
616ca38:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/293352 pw_kernel: Add memory protection to userspace processes
2ef103c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/291264 pw_multibuf: Add module config and version
0eb783c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/295274 pw_ide: Enforce clangd extension minimum version
ed2d0a8:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/295042 pw_allocator: Fix typo in deallocator.h
b5b26aa:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/293953 pw_kernel: Avoid `as` casts where possible
835e0d6:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/295113 pw_ide: Simplify vendoring bazel/buildifier
00fdb71:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/295173 pw_bluetooth_sapphire: Call StartAdvertising result cb on handle error
0f6b10f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/295273 pw_env_setup: PyPI version bump to 0.0.22
90662ec:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/293834 pw_bluetooth_sapphire: Use AdvertisingHandle in LowEnergyAdvertiser
0dbcaf8:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/294932 pw_kernel: Support in-library unit tests
e0c4b19:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/294801 pw_fuzzer: Remove "basic" domains
14c9b44:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/291512 pw_async2: Generic pendable wrapper
8bae44a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/294852 pw_kernel: Copy all sections into the merged elf file
f40c5bf:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/294092 pw_kernel: Panic detection tests for mps2_an505 and qemu_virt_riscv32
775e4ca:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/293835 pw_kernel: Refactor to remove panicky code
d79101e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/294974 pw_console: Mouse column resizing
4869e6f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/295073 pw_bluetooth: Fix bit ordering in android opus
ea85eb9:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/280333 pw_build: Minor docs tweak to required Bazel flags
bc6bc17:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/295112 docs: Make the changelog notice more prominent
6585387:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/295072 Revert "pw_rpc: Remove fake_channel_output.cc from pw_rpc_src_files"
496aa21:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/294805 .gitignore: Add aider files
6f8a537:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/294803 pw_assert: Add configurable debug_assertions feature
187dffc:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/294753 bluetooth: Add A2DP Android's OPUS codec parser
828a902:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/294837 pw_console: Search bugfix and selection UX improvement
fc779d9:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/294752 bluetooth: Add A2DP vendor codec parser
af2bc72:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/294412 pw_stream: Remove useless includes
cb72643:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/294912 pw_kernel: Add pw_assert::debug_panic! macro
630a1c6:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/294873 pw_kernel: Unit tests don't have kernel deps
ca5735a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/294892 pw_rpc: Remove fake_channel_output.cc from pw_rpc_src_files
666ff8e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/294626 pw_build: Fix mypy cache-dir location
0cbfc14:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/293774 pw_digital_io_linux: Reduce log noise
23bf2b9:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/294659 pw_presubmit: Use GnGenNinja class for Python
363c0e0:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/294615 pw_ide: Intercept bazel test invocations too
e8111d7:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/294633 pw_ide: Use getReliableBazelExecutable() everywhere
8b73d47:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/294613 pw_ide: Re-enable all unit tests
068cb5c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/294053 pw_build: Add zephyr RTOS variant in Bazel
fcc95d2:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/293952 pw_bluetooth_sapphire: Fix crash on DiscoverServicesInRange
a296079:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/294372 pw_package: Remove old Zephyr version comments
f69d775:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/294146 roll: zephyr

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: 4be0d002f0f5f1..78d65b06538ff6
Roll-Count: 1
Roller-URL: https://cr-buildbucket.appspot.com/build/8713218056807831761
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I020b5aacace1793a11fec9f7ee2ba8211c836362
Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/295457
Lint: Lint 🤖 <android-build-ayeaye@system.gserviceaccount.com>
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: 01e05a91af0f6da4b61f87c0c5f19cd58e6003aa
  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.