roll: third_party/pigweed/src 5172ccd..ffb5324 (49 commits)

ffb5324:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/252352 pw_bluetooth_proxy: Separate rx_additional_credits method
22ec962:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/252952 pw_bluetooth_proxy: Write Identifier in signaling command headers
13c7f3c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/252292 pw_cli: Allow output-specific color checks
23cc90c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/231911 pw_crypto: Add AES facade
92c01bf:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/252812 bazel: Specify nanopb version
70e716f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/252852 pw_bluetooth_proxy: Remove static mutex on l2cap channel
4954f2e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/252573 pw_bluetooth_proxy: Split RFCOMM tests into own file
b336566:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/252556 pw_bluetooth_proxy: Un-hardcode transport type for BasicL2capChannel
e858848:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/251435 pw_bluetooth_proxy: Add write flow control mechanism
99944ed:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/251472 pw_bluetooth_proxy: Reset proxy on HCI_Reset
327bbb7:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/252772 pw_protobuf: Fix EnumStreamFinder read function
571ba51:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/252574 pw_protobuf_compiler: Fix nanopb warning
4a28597:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/240811 docs: Add Bazel style guide
bb9f65d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/251914 pw_assert: Improve error messages in constant expressions
d257329:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/251432 pw_protobuf_compiler: Split pw_proto_library.bzl
2bfeaec:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/249754 pw_bluetooth_proxy: Add L2cap service listener API
9de12f9:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/252557 pw_presubmit: Remove pw_grpc from includes exception list
a7c4dd8:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/251992 pw_containers: Do not move assign to destroyed objects in Vector::erase
983b4f1:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/252555 pw_grpc: Remove old constructor and make multibuf allocator required
fd94748:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/252353 pw_bluetooth_proxy: Merge WriteChannel & ReadChannel into L2capChannel
0f7202e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/244815 pw_async2: Add quickstart
d30c2bb:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/249952 pw_grpc: Implement per stream send queues and make sending non-blocking
4a1535b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/252332 pw_bluetooth_proxy: Remove assert for moved-into objects
c4113b4:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/252356 third_party/emboss: Remove public_config removal of warnings
aca1330:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/252355 pw_bluetooth_sapphire: Add [[maybe_unused]] where needed
4d16136:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/249412 pw_bluetooth_sapphire: Migrate 1 fuzz test to Bazel
f52ea29:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/250832 pw_bluetooth_proxy: Support rx_additional_credits for L2capCoc
a4d795f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/252172 pw_system: Add facade for rpc server in Bazel
53c440b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/252212 pw_intrusive_ptr: Add Android.bp
23370ed:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/250492 pw_tokenizer: Add macro for tokenizing enums with custom string
534e65d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/251792 pw_log: Remove _PW_LOG_REQUIRES_VERBOSITY
d99cc15:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/251863 pw_bluetooth: Add bluetooth quality report command
f198dc6:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/251972 pw_i2c: Add an alert comment in ProbeDeviceFor function
4a1d9b2:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/251452 pw_async2: Support value constructor for OnceReceiver
8fd1fd1:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/247892 pw_bluetooth_sapphire: Implement AdvertisedPeripheral::StopAdvertising
35e22c9:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/250592 pw_bluetooth_proxy: Make BasicL2capChannel an L2capWriteChannel
7dc00bb:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/251056 pw_bluetooth_proxy: Make send_queue_mutex static
fc9a118:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/251913 pw_presubmit: No TODO check for MODULE.bazel.lock
49deebd:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/245652 pw_bluetooth_sapphire: Implement Peripheral::Advertise
fb15677:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/251912 pw_channel: Wake readers after ForwardingByteChannel writes
52554de:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/251572 pw_build: Fix missing `configs`
b950987:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/251392 pw_snapshot: Add per-thread processing callback for snapshot decoding
ce9b2de:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/251492 pw_bluetooth: Add AVDTP stream end point packets
9c46a25:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/250912 pw_rpc: Update ifdef guard for assert for Andestech RISC-V GCC12.2.0
74663b2:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/250152 pw_rpc: Debug logs for call termination
eb762ca:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/249692 pw_rpc: Make packet proto library public in Bazel
061d674:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/249932 pw_metric: Add max depth test
807a3aa:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/250572 pw_toolchain: Support replacing GNU libs for ARM
f7a18a2:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/251434 docs: Update changelog

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