commit | d7d234a27c72d5e5a28dfe735ff2e2c2fde63a65 | [log] [tgz] |
---|---|---|
author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Mon Oct 14 00:44:44 2024 +0000 |
committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Mon Oct 14 00:44:44 2024 +0000 |
tree | 45e5804eb4c01b2e9c3d95d23fdd147a1897c094 | |
parent | 329da0d412fb0eaf57b8f57636c776187e4e7bb5 [diff] |
roll: third_party/pigweed/src 223c6d9..c221c63 (50 commits) c221c63:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/241953 roll: python-wheel d3d8490:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/241952 roll: ninja 98d4ea4:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/241637 roll: fuchsia-infra-bazel-rules 589d68e..7011a76 (43 commits) 5a33668:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/241913 roll: cmake 21c3798:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/240732 pw_bluetooth_sapphire: Support creating LE dynamic channels in gap 676147b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/240713 pw_bluetooth_sapphire: Support creating LE dynamic channels in l2cap de832f1:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/241194 targets/rp2040: Add --chip argument to unit_test_server.py 6bdaaa9:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/238471 bzlmod: Add transitive deps for oss-fuzz 32f28d6:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/241136 pw_env_setup: Update clang next version d08c60c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/241201 pw_stream_uart_mcuxpresso: Remove dma_stream b39ad5c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/241200 pw_uart: Add pw::uart::UartStream 98667e8:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/241193 bazel: Switch to forked pre-release probe-rs prebuilts ba98cd9:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/237452 pw_bluetooth_sapphire: Cleanup compatibility attrs f6a7bb7:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/238393 pw_uart: Add UartBlockingAdapter ebf33f5:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/159050 python: Add ruff linting d44807b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/235638 roll: clang bdcf658:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/238572 pw_uart: Add UartNonBlocking::FlushOutput() 840c58d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/241199 pw_uart: Update OWNERS a789e9c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/241359 pw_env_setup: Remove black.json 9024130:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/241472 bazel: Move WORKSPACE based toolchain declarations to generated repo 17df82d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/241212 pw_tokenizer: Ignore whitespace in domain values c4ea179:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/238052 pw_web: Improvements to `device` RPC APIs 9ff1095:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/238952 pw_bluetooth_sapphire: Support new bredr.Profile/Search argument d356f50:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/241132 bazel: Update Fuchsia SDK to 24.20241009.5.1 ea85dfd:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/241272 *: Fix ruff-detected Python lint errors 9aae89c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/239913 pw_allocator: Add UniquePtr::MakeUniqueArray 60e7e4f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/237196 pw_toolchain: Switch arm_clang to rules_cc toolchains 7d78c54:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/239497 pw_bluetooth_sapphire: Update docs 6efc99b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/240833 pw_protobuf: Support directly specifying options file locations 4321a46:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/236234 pw_spi: Use non-virtual interface (NVI) pattern on pw::spi::Initiator 1e33c23:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/241038 pw_containers: Include C++ versions of headers from C++ 0125f4a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/238429 pw_toolchain: Add Bazel mechansim for clang/gcc-specific flags 9fe59f4:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/240877 docs: Add more guidance to Bazel docgen quickstart 385019a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/133971 SEED-0103: pw_protobuf: Past, present, and future 8bd77ab:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/233033 pw_console: Fix progress bar division by zero 2828847:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/239115 many: Remove loads of pigweed.bzl 86719db:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/240803 bazel: Update rules_rust to 0.52.2 fd6b7a9:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/233752 pw_system: Add `debugger-listen` and `debugger-wait-for-client` options 7698704:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/240832 pw_build: Add pw_copy_and_patch_file be43983:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/239509 pw_tokenizer: Load all domains from ELF files by default 56aa667:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/234414 pw_tokenizer: Include the domain in CSV databases ec62be9:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/206670 SEED-0128: Abstracting thread creation e3f0f42:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/240752 pigweed.json: Add "docs" program d8a6c4d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/239944 pw_fuzzer: Updates docs for libFuzzer+Bazel d3a6358:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/232212 pw_allocator: Add BlockResult 87f43fe:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/240792 pw_build: Fix pw_python_venv generated requirements 29fc404:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/227601 Revert "pw_system: Don't use implementation_deps" 35c10c4:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/240673 Revert "roll: rust" 01e206b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/240672 pw_multibuf: Include missing header bf0f12d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/240574 roll: go Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed Rolled-Commits: 223c6d99c503f1..c221c639957646 Roller-URL: https://ci.chromium.org/b/8734145958688460305 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: Ib6587c3d500e478273dcf6a754c483d6a6993218 Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/241958 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 $ 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.