| commit | 9bb8087dfa1ac6c597d3cdc758d97dc4365c1458 | [log] [tgz] |
|---|---|---|
| author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Mon Feb 12 00:44:03 2024 +0000 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Mon Feb 12 00:44:03 2024 +0000 |
| tree | 02618503c74cd49931e3c1cea95b15ff0d2f6e13 | |
| parent | 92ceaf599c5931015f0c6b98cb9e634ce05cb216 [diff] |
[third_party/pigweed/src] Roll 44 commits 9b1e38c0b5cbefc roll: cmake b5ee28a91525dd5 roll: bazel 4f06563df2b2088 pw_digital_io_rp2040: Config with polarity 69cff2d769fb9a0 pw_presubmit: Allow Bazel issues in TODOs ca188a7fd5829b2 docs: Update changelog 13eacb6f3f68647 pw_toolchain: Add nightly Rust toolchains that all 97e234ac74b153f pw_string: Make IntToString constexpr 263aad2aa53799d pw_toolchain: Disable unstable features in rust to a404483ea17191c pw_config_loader: Add support for nested keys 14455b147cb3a51 pw_compilation_testing: Do not expand regexes 59c0c141e8dab89 pw_toolchain_bazel: Remove support for *_files 65866c3bb3d44a3 pw_toolchain_bazel: Add support for setting enviro 221456bd12cd382 pw_result: Add missing libs in Soong blueprint d0ae1f109153bf2 pw_allocator: Refactor metric collection for tests e677b355fde59f2 docs: Nest backends under respective facades in si 322850723d19c91 pw_bluetooth: Add l2cap_frames.emb 67a4b97833869aa zephyr: Fix default logging in chromium CQ 577ea9288918b86 pw_bloat: Allow removal of zero sized labels 71d73d819df943c pw_allocator: Add Allocator::GetLayout 41349cb7250e484 pw_fuzzer: Fix Bazel run target instructions a5328ae3a525897 pw_config_loader: Add tests 81242b0406fd717 pw_allocator: Add BlockAllocator a7e8a40c06c2ee5 pw_toolchain_bazel: Implement per-action files e821637464c104e pw_allocator: Fix SynchronizedAllocator typo ba81124ae9b1e92 pw_env_setup: Roll cipd 36a249c883d7ccb pw_config_loader: Initial commit 9624e0c4a793753 pw_cli: Add json_config_loader_mixin f4aaf3e2566c184 pw_allocator: Streamline Block and improve testing 2e5201bfb6b53ac docs: Add doxygengroup to the style guide b0ef36889d503bd pw_build: Add Fuchsia to TARGET_COMPATIBLE_WITH_HO f5df52c1185e9ac seed: Fix pw_seed_index template deps 0d764ab24825195 pw_unit_test: Remove obsolete label flag b31d94d6d972466 pw_channel: Docs fix 674294db69c284a pw_allocator: Separate metrics from Fallback-, Mul 600f5069c9905ab pw_allocator: Make TrackingAllocator::Init optiona 702b089cf600e65 pw_grpc: Fix off-by-one error when handling DATA f 7a5caf8fec37c8b pw_ide: Disable Python terminal activation in VSC 17fc4f9c0ea9669 pw_transfer: Account for remaining_bytes in payloa d531cdca1114adc pw_channel: Module for async data exchange with mi e4d29e728933864 pw_allocator: Check for integer overflow in Layout 1769ad368ae68e4 bootstrap: Update the bootstrap script to have sta fd11e9439683800 pw_async_basic: Remove unneeded locks from test 037b7ea11aace3f pw_thread: Incease the sleep duration in tests fcb3619a087beb2 pw_target_runner: Remove .dev from path name https://pigweed.googlesource.com/pigweed/pigweed third_party/pigweed/src Rolled-Commits: a2c5384a67fc2c2..9b1e38c0b5cbefc Roller-URL: https://ci.chromium.org/b/8756342212524292497 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: I500bd83579b78deb856b361848ae9af88daeb3b7 Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/191488 Bot-Commit: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> Commit-Queue: 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.