roll: third_party/pigweed/src 9927c81..de5b668 (49 commits)

de5b668:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/405992 roll: luci
1bc6ba5:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/405893 roll: fuchsia-infra-bazel-rules 41d9d71..c5c868a (53 commits)
5b53e5c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/405892 roll: rust-analyzer
43d5764:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/405592 third_party/chre: Gate tests on ISL backend
43c89c5:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/404153 agents: Refactor docs skills
c98647d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/405174 bazel: Roll picotool, emboss for Bazel 9 compat
7fbe3d9:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/402253 pw_bluetooth_proxy: Refactor AclDataChannel to use DynamicMap
77d770b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/396772 pw_env_setup: Switch MODULE.bazel to cipd_ext
1007790:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/404433 bazel: Declare that Bazel must be at least 8.0.0
988ab02:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/405092 pw_kernel: Remove kernel process_termination test
0a8b05a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/404774 pw_kernel: Terminate a process on unhandled user exceptions
168d104:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/404432 bazel: Improve compatibility with 8.0.0
132e00b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/403419 pw_presubmit: New presubmit system with support for automatic fixes
964e907:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/399574 pw_kernel: Add support for thread/process exit status
101f17c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/395912 pw_async2: Move motivation into separate doc
06429de:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/188096 docs: Clearly state limits of third-party support
504d4c4:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/403892 pw_async2: Fix missing build deps and inconsistent enum naming
4a6290c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/404795 pw_cli: GitRepo functions for rebase and commit information
7f94025:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/404292 pw_kernel: Ensure kernel objects signals consistently initialized
a874df1:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/404796 pw_allocator: Add missing include
6632900:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/404793 Revert "pw_rpc: Use local encoding buffers when dynamic allocation is enabled"
05d593f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/402252 pw_bluetooth_proxy: Refactor L2capChannelManager to use DynamicMap
b735f62:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/390613 pw_allocator_zephyr: Add initial module
5413a69:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/399092 pw_kernel: Allow syscall handler to return Result<()>
ee7fc86:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/401112 pw_rpc: Use local encoding buffers when dynamic allocation is enabled
b45b588:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/404272 pw_allocator: Add AbstractAllocator
3160ac1:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/404012 bazelrc: Add airlock config
e9118e3:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/280837 pw_toolchain: Enable sandboxing for upstream CMake builds
e1191a2:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/404152 pw_multibuf: Improve v1_adapter implicit conversion
d99ea6b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/403652 bazelrc: Move user.bazelrc import to end
c4480d5:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/399632 bazel: Inhibit rules_rust from registering any default toolchains
d28bd71:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/302194 pw_chrono: Ensure timers do not overflow
f902025:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/381037 pw_allocator: Make additive NVI methods protected
6cac589:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/391812 pw_bluetooth_proxy: Refactor CommandMultiplexer to use DynamicHashMap
a2c1266:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/392872 zephyr: Setup for unit tests and smoke tests
8420c77:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/392452 pw_bluetooth_proxy: Add dynamic credit sharing mode
bc0bafb:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/381036 pw_allocator: Add Fragmentation operators
6c91fb9:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/403418 pw_cli: GitRepo commands that modify the repo
c7f6e3e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/403417 pw_cli: collect_files, file_filter improvements; deps cleanups
a0ba6b7:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/400908 pw_protobuf: Use FunctionRef in StreamEncoder
95b1af8:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/400907 pw_thread_freertos: Use FunctionRef in ForEachThread
6337535:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/400906 pw_function: Add FunctionRef
df53071:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/371772 pw_async2: Prototype future chaining
9046519:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/402172 pw_ide: Fix missing module map in integration test
1b97885:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/392113 pw_multibuf: Use a facade for version configuration
28d35a4:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/381035 pw_allocator: Separate template method declarations and implementations
527fc48:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/403416 roll: toolchain-integration
55165d1:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/403412 pw_kernel: Fix veer_pic InterruptTableEntry
3977594:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/402292 pw_bluetooth_sapphire: Update documentation on using local Fuchsia SDK

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: 9927c81cfba3cd..de5b6680c288f2
Roll-Count: 1
Roller-URL: https://cr-buildbucket.appspot.com/build/8682777479085650801
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I94da90705397a23cad8b52fc52700cec52122154
Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/406172
1 file changed
tree: 6bfc1ab8ef89fc9ce6b97f66e1067371b44ebb83
  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.