roll: third_party/pigweed/src 2fb733c..8257af2 (55 commits)

8257af2:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/326772 roll: luci
1a4c64b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/326692 roll: fuchsia-infra-bazel-rules 226a7f3..00003cc (51 commits)
e8d1563:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/326652 roll: python-wheel
5787bac:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/325501 pw_kvs: Rework documentation structure & content
5bdabe5:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/326472 roll: cmake
f24c9a1:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/324892 pw_build_info: Add "-dirty" suffix to kGitCommit
8ddcffa:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/325952 pw_build_info: Change kGitCommit to InlineBasicString
cfe6a32:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/323992 pw_digital_io_mcuxpresso: One handler per pin
aedabd6:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/326092 pw_package: Use flatbuffers mirror
b1130af:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/325572 pw_digital_io_mcuxpresso: Support SDK 25.06.00
fdd52b3:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/325853 pw_ide: Debounce restarting clangd on compile commands change
709c984:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/325512 pw_async2: Read waker name from derived futures
d9810f7:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/323892 pw_async2: Update codelab
7f28175:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/325832 pw_unit_test: Restore lost docs for PW_CONSTEXPR_TEST
f0881b8:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/325373 pw_async2: Experimental SingleFutureProvider
cae0245:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/325852 pw_package: Use FreeRTOS mirror
0de05c5:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/323872 pw_digital_io_mcuxpresso: Check interrupts cleared
15af03a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/323817 pw_kernel: Refactor common logging backend code out of console
a5c3e1b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/323816 pw_kernel: Un-fork pw_status
ef047b4:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/323815 pw_kernel: Remove embedded-io deps from all but rp2350 support
cf9e8b8:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/323814 pw_tokenizer: Refactor new() out of MessageWriter trait
812c717:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/325594 pw_build_info: Remove :git_build_info_lib alias
4f146c7:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/325693 pw_ide: Remove unused nodejs version of compile commands generator
7a79b5e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/325532 pw_bluetooth_proxy: Delete ProxyHost::SendAdditionalRxCredits
0dd6fdc:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/325593 pw_build_info: Change :git_build_info to cc_library
ec5ef46:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/325712 pw_ide: Reduce cpu cores taken by clangd process for indexing
ee79430:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/318493 freertos: Support swapping pw_third_party.freertos implementation
e4be1a0:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/325713 docs: Update Pigweed Live calendar data
db3a128:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/325592 pw_build_info: Introduce :git_build_info_lib
c4353db:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/325496 pw_tokenizer: Provide cc_library for Java's native .so dep
92e738c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/325432 rust: Enforce lower case hex literals in rustfmt
506d7f3:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/324913 pw_kernel: Add cortex-m CPUID register
f2883cb:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/325372 pw_compilation_testing: Cap max parallelism
77bd96c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/324778 pw_ide: Avoid crash when pigweed project root is not found
0d0bbba:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/324732 pw_bluetooth_sapphire: Don't filter out unconnectable peers
90c692e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/324052 pw_log_string: Switch assert.h to cassert
afda10d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/324511 pw_ide: Make target selection dropdown variable width
666bd39:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/324813 pw_build: Make workflows set --symlink_prefix
d35044a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/324912 pw_compilation_testing: Disable unsupported features
7aae54c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/324452 pw_metric: Add generic pwpb and nanopb metric writers
036f3b3:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/321872 pw_kernel: Add interrupt controller support
2e30708:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/324872 Revert "pw_assert: Remove old backend label_flags"
ec2a66f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/324812 pw_compilation_testing: Remove unneded references
5b81c5e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/324553 pw_presubmit: Use prettier to format css files
bcc86ca:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/323893 pw_bluetooth_sapphire: Implement Central.SyncToPeriodicAdvertising
c57f0e8:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/324492 pw_async2: Derive TimeFuture from Future
6ad7940:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/320819 pw_assert: Remove old backend label_flags
be94bbb:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/323912 pw_watch: ./pw watch workflow; better message if no commands
6fd39ed:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/306078 pw_compilation_testing: Implement PW_NC_TEST in Bazel
148f0d0:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/324532 pw_grpc: Account for gRPC header in flow control window
440ea6d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/322432 pw_ide: Add Help section along with a welcome header
c376a00:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/324495 pw_ide: Add flag to avoid creation of bazel symlinks in aspect wrapper
62f2b6e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/323794 pw_metric: Promote metric_walker.h to public API
12ecc7a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/317152 pw_ide: Remap virtual includes
3959870:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/321172 pw_async2: Experimental Future type

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: 2fb733cb5103f9..8257af2f61c7cf
Roll-Count: 1
Roller-URL: https://cr-buildbucket.appspot.com/build/8702437018152662897
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I0873265fccc5668f218c796310004218d51e385a
Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/326798
Lint: Lint 🤖 <android-build-ayeaye@system.gserviceaccount.com>
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: d2e10a0fc40f59f02961e67f687eab546080e51c
  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.