| commit | 16719c932568c6fbac50cc287de6fcadca376d65 | [log] [tgz] |
|---|---|---|
| author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Sun Apr 13 17:46:32 2025 -0700 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Sun Apr 13 17:46:32 2025 -0700 |
| tree | d0f65a9bcc6e980171c1b84888503a0a9b7a5d18 | |
| parent | f5ba2166d824bd0e7b01776df8674243b0173077 [diff] |
roll: third_party/pigweed/src 0c348e1..f1c1ba7 (34 commits) f1c1ba7:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/283594 roll: gn 6fb93ef:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/283335 roll: luci 713a0ec:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/283432 roll: ninja 4b46c19:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/283312 roll: cmake 6c414a1:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/282895 pw_sync_freertos: Fix -Wthread-safety issues with thread notifications a18dd87:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/264643 pw_allocator: Refactor Deallocator::GetInfo 28f8cdb:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/282772 pw_multisink: Expose underlying buffer size 9a65920:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/282773 pw_kernel: Fix deadlock writing to stdout in qemu wrapper script fd726e0:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/282392 pw_bluetooth_sapphire: Acquire wake leases in PeerWatcher 8bc0f20:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/281454 pw_bluetooth_sapphire: Acquire wake lease in ChannelServer 0379712:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/264639 pw_containers: Reduce map template expansion f1819cf:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/282935 pw_env_setup: Roll clang-next 402011f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/260419 pw_presubmit: Check that rst files are in Bazel b60380d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/282912 pw_tokenizer: Skip spaces in domains 4d02310:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/282932 third_party: Add LLVM docs to Bazel build 59f60a7:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/282914 pw_trace_tokenized: Add missing type_traits include 4387b94:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/282732 pw_async2: Enable conversion warnings 68222f9:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/282452 pw_async2: Use IntrusiveForwardList for task wakers b61bd3b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/282814 pw_perf_test: Set log level; minor updates 72f5894:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/282775 pw_rpc: Add kconfig dependency on PIGWEED_THREAD_SLEEP 69fc79a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/282774 pw_sync_zephyr: Fix backend mapping for binary_semaphore 5ba1848:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/282776 pw_ring_buffer: Suppring reading via a pw::Function 1c277ee:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/280973 pw_async2: Crash if task returns Pending() without a waker 2ca5393:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/239232 pw_env_setup: Detect lack of Internet 300393a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/281255 pw_bluetooth_sapphire: Acquire wake lease in Recombiner f84fc7f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/282792 pw_sync: Update support matrix a23c49e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/281932 pw_bluetooth: Add AVDTP abort command 57260d9:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/280974 pw_bluetooth_sapphire: Acquire wake leases in SignalingChannel 99572be:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/281834 pw_tokenizer: Add more Python tools to Bazel 64d06ce:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/281833 pw_transfer: Add Number() coercion for 64-bit int proto field access 2452fa9:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/277893 pw_toolchain: Clarify clang-tidy exclude behavior 39b40e3:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/281714 pw_i2c_rp2040: Use Initiator(Feature) constructor e84eaa6:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/258972 bazel: Update rules_android to 0.6.0 12489e3:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/281712 roll: go Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed Rolled-Commits: 0c348e1c1632b3..f1c1ba7230307b Roll-Count: 1 Roller-URL: https://cr-buildbucket.appspot.com/build/8717657307324100641 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: I9d398bf3198a9d7fe787f650f286504d7523ea48 Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/283692 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>
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:
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.
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.
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.
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.
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
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.
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.
The Google C++ Style Guide is used. A .clang-format file is provided for convenience.
To incorporate the code into another project, there are a few options:
Copy only the necessary code. For example:
Take the main code as is: include/dice/dice.h, src/dice.c
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.
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.
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.
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.