roll: third_party/pigweed/src 280017c..705a4a8 (51 commits)

705a4a8:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/320752 roll: luci
dfc48c9:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/320672 roll: fuchsia-infra-bazel-rules 27e1046..8c8da21 (60 commits)
9ab5264:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/320213 pw_async2: Have user manually pend coin slot first
be62dae:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/320412 pw_async2: Fix typos in codelab
bce242b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/320334 pw_async2: Update solution callouts
347d88e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/319633 pw_async2: Codelab step 5 updates and instructions
1c752dd:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/319821 pw_containers: Update docs for InlineAsyncQueue/Deque
66af741:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/304613 pw_async2: Add CancellableTask wrapper
2f79843:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/319826 pw_kernel: Consistenty use start_address and size in system_generator
6c729b0:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/320212 pw_ide: Increase max direct dependencies for provider collector
c3f3248:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/317396 pw_kernel: Update system_generator to use runtime templates
4574b1c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/319913 pw_kernel: Don't put RISC-V exceptions handlers in their own segment
0fcd975:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/319872 pw_build: Update symlink to be symbolic
f6e3cad:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/309893 pw_env_setup: Redirect pigweed_environment.gni to file in env dir
57f5fb8:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/319232 pw_async2: Introduce codelab step 5 solution
8df80e6:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/319992 pw_ide: Release v1.9.8
4394dbc:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/89941 pw_tokenizer: JNI-based Java detokenizer
5b32e18:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/295016 bazel: Add rules_jni
a60c290:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/319234 pw_ide: Clicking statusbar targets should always open target selection
338e961:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/319233 pw_ide: Don't parse compile commands for headers
6064e89:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/317252 pw_sync_zephyr: Add TimedMutex support
e1790a4:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/319632 sphinx: Remove Breathe
e8bd77b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/317454 doxygen: Migrate pw_unit_test
ab984b4:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/316216 pw_async2: Setup codelab step 4
ec6457c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/318972 pw_string: Fix public dependency
582b8de:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/316220 pw_ide: Handle changes to bazel-out path and rm arch arg
3024314:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/318532 pw_ide: Make python version of compile commands generator default
43af0b5:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/316694 pw_metric: Fix and refactor PwpbMetricWriter
cc564f6:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/317332 pw_ide: Rename Bazel aspect
0936e29:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/318834 pw_async2: Use PendableFor in the async queue coro example
a55756c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/317456 doxygen: Migrate pw_bytes
e706435:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/318215 doxygen: Migrate pw_protobuf
4d20164:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/319072 pw_build_info: Improve read_build_id_from_section()
2cc0981:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/315532 pw_kernel: Eliminate `PMP_CFG_ENTRIES`
85e5a3d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/318061 pw_presubmit: Reduce duplication between GN and Bazel presubmits
bedb130:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/318613 pw_kernel: Allow static_foreign_rc! to use non-const values
fcc7d7f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/318614 pw_format: Fix 64bit value printf encoding
866e5ca:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/317115 pw_kernel: Add syscall arg abstraction
d49a5fd:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/316692 doxygen: Migrate pw_trace_tokenized
152c87c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/318053 doxygen: Migrate pw_status
419f27e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/318070 doxygen: Migrate pw_log
52d018e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/318217 doxygen: Migrate pw_rpc
6added3:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/299699 pw_presubmit: Enable rustfmt in GN
fb326aa:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/317227 pw_build: Support argument forwarding
a0ce714:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/316355 pw_containers: Move deque wrap functions to wrap.h
b1eb8c3:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/316733 doxygen: Migrate pw_spi
4dc0794:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/318052 doxygen: Migrate pw_log_string and FreeRTOS
abbef27:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/317226 pw_build: Make Workflows output root configurable
f1a3462:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/317734 pw_hdlc: Fix public dependency
9c940d5:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/317225 pw_cli: Support custom MultitoolCli arguments
d176c5e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/316019 pw_bluetooth_sapphire: Avoid using 0 as an advertising handle

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: 280017c367552b..705a4a8e890874
Roll-Count: 1
Roller-URL: https://cr-buildbucket.appspot.com/build/8704339552199154929
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: If9424e6d32867e70e352ec1dd1b2be0770a323de
Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/320728
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: 8f7960b4843edbcf95e38ffb001cd76ad5027946
  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.