roll: third_party/pigweed/src 7269078..baa7b86 (50 commits)

baa7b86:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/391512 roll: luci
417a947:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/391432 roll: fuchsia-infra-bazel-rules 61fee4a..68e4ab3 (46 commits)
63bd2a2:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/391372 roll: rust-analyzer
f572d35:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/382992 pw_kernel: Add process and thread objects
2adda78:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/352813 gemini.md: Remove unnecessary agent instructions
6ced3f8:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/378576 pw_bluetooth_proxy: Increase l2cap channel allocator size of multibuf v1
9e1809c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/390832 bazel: Use Bazel 8.6.0 with other required updates
e863ea7:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/390475 pw_env_setup: Fetch doxylink repository with Bazel
ecdd75e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/390473 pw_rpc: Fix implicit conversion warnings
f7cae80:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/295773 pw_persistent_ram: Rework docs, add diagram
368c08f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/389754 pw_string: Small docs fixes
1bed093:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/389753 pw_allocator: Small docs fixes
f5d65bf:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/387057 pw_build: Avoid running pw through bazel unless stale
9d20141:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/390092 agents: Add kernel testing skill
da331a4:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/388092 pw_rpc_transport: Fix implicit conversion warnings
e6a6bcc:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/374432 pw_kernel: Add ARMv7-M architecture support
b91d195:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/389833 pw_async2: Update vending machine codelab to crash
d0bfd93:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/389832 pw_asnyc2: Add context to FutureCore class comment
0badaee:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/389977 pw_async2: Add missing await.h include in codelab
d350a51:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/384113 build: Allow zephyr-bazel to be used by Pigweed
37c1975:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/389933 pw_toolchain: Add cortex-m4 conditions to arm_clang toolchain
49b439d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/389932 pw_kernel: Add iter() to intrusive lists
db4e3c4:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/389974 pw_toolchain: Use flag based toolchains for all cortex-m cpus
2db2039:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/389854 pw_build: Add add_prefix to workflows outputs
1b70cb7:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/385012 pw_metric: Remove support for direct metric list iteration
c51468f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/389752 pw_async2: Fix occasional timeouts in task tests
ccbb96c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/383192 pw_log_tokenized: Log backend without payload argument
9faf566:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/389412 pw_async2: Merge context.h into task.h
19971b7:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/388432 pw_sync_zephyr: Inline the ISL implementation
19dfb8d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/389572 pw_kvs: Clarify ability to change alignment
1a02120:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/389232 pw_async2: Make Context a private base of Task
22784f0:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/389533 pw_rpc: Switch the call list to IntrusiveForwardList
f4ed9c5:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/387652 pw_log: Fix implicit conversion warnings
dde945b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/388955 pw_async2: Context and Waker cleanup
343834b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/388213 pw_metric: MetricList/GroupList for_each and find
35ec0ca:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/389036 pw_channel: Run tests in a Task
c1c2670:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/389472 pw_build: Fix typo
bc4ec6c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/388935 pw_kernel: Small cortex-m priority constants cleanup
4a2b721:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/389072 pw_channel: Remove deprecated Channel classes
7bd4758:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/389252 pw_string: Support ToString for long double
02a4c92:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/389432 pw_kernel: Fix RISCV panic handling loops
b00bc98:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/388294 pw_rpc_transport: IntrusiveQueue for O(1) instead of O(n) push_back()
1a893e5:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/388293 pw_async2: Use IntrusiveQueue for task lists
8fa442e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/388292 pw_containers: Introduce IntrusiveQueue
a2dae8f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/388932 pw_sync_freertos: Isolate backend header include paths
d7a8902:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/388960 pw_ide: Fix compile commands generation in external workspaces
7cecd19:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/388492 pw_async2: Remove dispatcher() from Context
f73851c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/388132 pw_transfer: Terminate transfers on RPC error
4b4b5ab:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/387693 pw_bluetooth_proxy: Make acl credit completion more fair
5bffa5f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/388812 roll: fuchsia-infra-bazel-rules e128163..61fee4a (47 commits)

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: 72690785a236a4..baa7b869f5bbb8
Roll-Count: 1
Roller-URL: https://cr-buildbucket.appspot.com/build/8685948229523298001
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I0ba70e6296579b0369c98d774974e8173ad66f44
Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/391712
1 file changed
tree: c1ad0c48a2fdf40ce4d91d024cedcb6c0b3a5a81
  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.