| commit | 8410d96034d98f3efc3875938ad91220fcec8eac | [log] [tgz] |
|---|---|---|
| author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Mon Oct 21 00:44:14 2024 +0000 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Mon Oct 21 00:44:14 2024 +0000 |
| tree | b7cb081d65e5d42d898d749576eba45979b966bc | |
| parent | d7d234a27c72d5e5a28dfe735ff2e2c2fde63a65 [diff] |
roll: third_party/pigweed/src c221c63..5eec847 (45 commits) 5eec847:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/243267 roll: gn 5eaf939:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/243472 roll: fuchsia-infra-bazel-rules b9502a2..8c99ec2 (5 commits) f803d94:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/243260 pw_channel: Discuss backpressure in docs ec16989:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/243255 pw_containers: Fix intrusive doc lists 5551203:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/243262 roll: fuchsia-infra-bazel-rules 7011a76..b9502a2 (38 commits) 632f1af:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/243292 docs: Update changelog 3e9c883:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/242452 pw_bluetooth_sapphire: Add test config to bazelrc 170f745:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/242635 pw_build: Add LinkerSymbol f66f4e4:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/242639 pw_build: Add Python Bazel tests 273ade2:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/242638 pw_presubmit: Add Python Bazel tests 2097d2e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/242928 pw_protobuf_compiler: Make oneof_callbacks a per-library setting 60572e8:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/242637 pw_env_setup: Add Python Bazel tests e5db91d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/238432 pw_thread: Migrate to Thread::id 9c37b72:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/236262 pw_tokenizer: Add support for tokenizing enums f316527:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/242716 pw_env_setup: Move pip lock file exports 03c2d2b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/243033 pw_env_setup: Add type annotations to config_file.py c460937:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/243034 pw_bluetooth_sapphire: Upgrade socket relay failures to WARN 8fb97ee:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/242933 pw_allocator: Fix enable_if error in unique_ptr: operator[] c42ec10:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/242713 pw_env_setup: Drop Python 2 support f633c61:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/242812 pw_allocator: Add size() to UniquePtr eb03d32:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/242918 pw_async2: Provide default template type for PendFuncTask 57183de:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/242736 pw_allocator: Fix data race 8e0d91c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/242917 targets/rp2040: Update `flash_rp2040` helper with --chip argument 11ac924:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/242893 pw_cli_analytics: Two bugfixes 2055703:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/242392 pw_protobuf: Force use of callbacks for oneof 6ae64ef:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/188432 pw_cli_analytics: Initial commit 068949b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/242035 pw_async2: Add EnqueueHeapFunc cbbb308:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/242592 pw_env_setup: Replace f-string with .format() eaca721:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/242512 docs: Fix a typo c51a1d2:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/242632 pw_containers: Fix broken link c986667:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/242594 targets/rp2040: Fix broken link 5574faa:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/242334 *: Rm deprecated whitespace for suffix operators 8639b56:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/242093 pw_presubmit: Handle rolls a little more flexibly 8437527:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/242192 docs: Consolidate content for pigweed.dev contributors 1eadbb9:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/240656 pw_numeric: Rounded integer division 0c98e51:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/240655 pw_numeric: New module for mathematical utilities 1184ff5:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/242252 bazel: Add `load` statments for the builtin Bazel java rules 3eab170:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/242332 pw_bytes: Remove deprecated whitespace b854269:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/240912 docs: Build pw_async2 docs with Bazel a222b3f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/242172 targets/rp2040: Add default linker script targets f60e870:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/242193 Revert "pw_protobuf: Force use of callbacks for oneof" 53d4032:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/236592 pw_protobuf: Force use of callbacks for oneof 064c768:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/242133 pw_log_fuchsia: Replace stcompat cpp17::string_view with std version d0dd0b3:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/242016 roll: bazelisk-as-bazel 358d410:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/242013 *: Fix formatting Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed Rolled-Commits: c221c639957646..5eec847de00e03 Roll-Count: 1 Roller-URL: https://ci.chromium.org/b/8733511778253323009 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: Iac1e37838a171f50de8571ddf2570f469d8cf4b9 Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/243512 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>
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 $ 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.