roll: third_party/pigweed/src aa22856..6985a85 (61 commits)

6985a85:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/280253 roll: gn
9646081:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/278532 pw_rpc: Update soong rules for pwpb & pwpb_rpc
abd0403:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/280116 roll: luci
61b5a37:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/280012 pw_trace_tokenized: Add config_backend label flag
aa2e896:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/280095 pw_kernel: Add qemu_virt_riscv32 target to presubmit
c18cd91:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/275092 pw_kernel: Tokenize the kernel
2ec20de:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/280072 targets: rm includes
e832fa7:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/280053 presubmit: Ignore GN and CMake checks for files in pw_kernel
063230e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/279553 pw_kernel: Change console to write lines atomically
25c6d51:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/280054 pw_kernel: Set riscv stack to top instead of bottom of region
95040aa:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/278014 pw_bluetooth: Add AVDTP_GET_CAPABILITIES parser
826f383:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/280052 pw_kernel: Fix incorrect assert on cortex-m in qemu
b21016a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/279377 pw_bluetooth: Add AVDTP Start, Continue & End signaling header
4d461ea:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/279712 pw_bloat: Fix GN build for size report generation
e078345:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/279533 pw_sync: Support yield on riscv64
b4a6f35:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/279112 pw_stream_shmem_mcuxpresso: Add write timeout option
1040a27:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/278874 pw_stream_shmem_mcuxpresso: Add OWNERS
8eeeb95:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/277953 pw_toolchain: Add riscv clang toolchain libc support
340ed12:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/279652 pw_bloat: Reusable Python run_report function
c837726:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/279052 pw_bluetooth_sapphire: Add field to LowEnergyScanResult
d2241c7:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/279613 pw_ide: Configure Bazel settings automatically after a timeout
6be7274:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/279113 pw_ide: Select first target if none is set
7941b5b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/279492 Revert "pw_tokenizer: Add support for nested tokenization in C++"
8ee9b49:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/279532 pw_protobuf_compiler: Rephrase import statement
a63c499:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/278432 pw_protobuf_compiler: Make --compile-dir optional
bfff1ff:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/278493 pw_ide: Use CIPD clangd for non-Bazel targets
2d7b882:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/278877 pw_bluetooth_sapphire: Fix gtest macro sign error
ebeb08b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/278392 pw_protobuf_compiler: Add UT for generate_protos.py
e936455:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/279472 pw_bluetooth: Add sarahbodin@google to OWNERS
b83cfa9:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/279452 pw_bluetooth_sapphire: Add sarahbodin@google to OWNERS
8c6e65d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/275179 pw_presubmit: Migrate owners formatter
0cc57ee:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/278732 pw_toolchain: Fix typo
982bc7d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/278678 pw_bluetooth_sapphire: Fix basic_mode_rx_engine_fuzzer
1e464ac:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/278675 pw_kernel: Fix missing log statements
be9140e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/278872 pw_build: Use --output_base for build_dir
7d91dfc:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/278676 pw_kernel: Use clang toolchain cortex-m builds
a9c1069:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/278674 pw_tokenizer: Encode u8 as varint in rust tokenizer
8f6c6b4:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/278492 pw_kernel: Always compiler fence when dropping interrupt guard
5b78009:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/276112 pw_kernel: Basic implementation for riscv32
257025a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/278812 pw_console: Fix lost focus when moving tabs
7f2b75e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/278363 pw_i2c_mcuxpresso: Track actual assigned i3c addresses
61c6096:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/278367 pw_i2c_mcuxpresso: Revert i2c to use Blocking calls
ed7ac2a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/278383 pw_hdlc: Add PendWrite() to the router Router::WriteOutgoingMessages()
abd5df8:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/278452 pw_bluetooth_sapphire: Fix iso asan/tsan failures
684d4e9:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/278632 pw_bluetooth_sapphire: Fix central and peripheral tests
8dab133:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/278455 pw_bluetooth_sapphire: Fix UBSAN failures in l2cap fuzz tests
2861b6a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/278332 pw_protobuf_compiler: Fix unused variable
3003d35:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/278454 pw_bluetooth_sapphire: Re-enable UBSAN tests in sm
c658b93:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/278393 pw_bluetooth_sapphire: Fix gatt UBSAN failure
3ccc4c6:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/278453 pw_bluetooth_sapphire: Remove outdated TODO
011a081:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/274695 pw_bluetooth_proxy: Implement L2CAP configuration request handling
096b4e7:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/276332 pw_bluetooth_sapphire: Return credits after reading
5fd1e1f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/278377 docs: Warn about LED not working on Pico W
244b3d0:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/278032 pw_ide: Stricter detection of Bazel projects
fd7055a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/277793 pw_async2: Add debugging logs and metrics to dispatcher
cdb6318:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/277954 pw_ide: Allow compDB refresh of bootstrap projects
df8b1de:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/278033 pw_ide: Fix target display name
24fc182:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/278152 pw_bluetooth_sapphire: Fix common ubsan failures
089e227:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/278292 pw_multibuf: Reduce stack usage in test
7bf3b52:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/278352 pw_build: Add test for subpackage directory globbing
e38b971:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/278153 pw_bluetooth_sapphire: Fix hci ubsan failures

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: aa2285683111b0..6985a85e5cc6b0
Roll-Count: 1
Roller-URL: https://cr-buildbucket.appspot.com/build/8718925660073298209
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I33c851e0a9a1a39f0f6f2b054f09a5b1ac2e9f7a
Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/280256
Bot-Commit: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>
Commit-Queue: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>
Lint: Lint 🤖 <android-build-ayeaye@system.gserviceaccount.com>
1 file changed
tree: e97091321fdd754c8ebbbd8f7b19448492296e84
  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.