| commit | 3390c321b830c1e60e84801884aa5d480f0f88e3 | [log] [tgz] |
|---|---|---|
| author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Mon Apr 29 00:43:56 2024 +0000 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Mon Apr 29 00:43:56 2024 +0000 |
| tree | 3accbd5600af57926b3e45c3fad433d9befc48c4 | |
| parent | a793c1bc8aee584d4d68631fea265449d018a1a9 [diff] |
[third_party/pigweed/src] Roll 61 commits ccc5241d8133cd2 roll: gn ab83b349da5c2fd roll: clang-next 736f7179de8ac99 pw_thread: Fix pw_thread_zephyr compilability 2d65e87e6086474 pw_unit_test: Add support for a test_main in CMake 188bd4726e0eca3 *: Remove remaining usages of legacy thread entry 74004ce5958687a pw_async: Add missing dispatcher facades to cmake ae56930feef9426 fuchsia: Add defer.h to Bazel build defs 9e90af3746446e4 pw_thread: Use pw::Function to start threads 87126e11b80d206 pw_transfer: Assume a minimum window size when res 2593707a02b0c21 pw_toolchain: Add clang-tidy suggestion b2c733596a777c5 pw_transfer: Attempt to recover when receiving inv 5a8cde71ecadfd8 pw_rust: Fix Rust tokenized logging example 144ac20a8cbfa3f pw_module: Include :authors: in generated SEED fil 55f718e19c789f7 pw_format: Better explain core::fmt whitespace par a56e966f863779b pw_build: Fix using pw_cc_blob_library target in e de74460373ec62a pw_string: Add ToString for iterables cda2a749853a894 SEED-0128: Claim SEED number 1807af542686e6d pw_web: NPM version bump to 0.0.19 f3299bee142a088 pw_allocator: Remove conflict marker 46f6477f64d1411 pw_allocator: Move FallbackAllocator implementatio 54558a97edeb5ab pw_presubmit: Separate 'bazel info' stderr 32ff69e60cb8ad6 pw_allocator: Clean up LibCAllocatorTest c50cd3d84714aa6 pw_allocator: Move block allocators to separate fi 4613447f11e0513 pw_presubmit: Save 'bazel info output_base' f79f7c42e7921fe pw_tokenizer: Add DecodeOptionallyTokenizedData 82bbfff7ff83136 pw_sensors: Add support for triggers 96dee917b1ede10 SEED-0124: Getting Used Size from Multisink 4dad2cbb2bd183c pw_bluetooth_proxy: Add some emboss helper functio d55154afdb9d9a3 pw_bluetooth_proxy: Template test emboss packet cr c7f27e2026d681c .bazelversion: Add file 6f9099b2b688bf6 pw_allocator: Add BuddyAllocator e01ca5820679aeb pw_containers: Omit size on FlatMap construction 36a94a20ffbaf42 pw_snapshot: Add python processor tests e7fc5d241ad4508 pw_bluetooth_proxy: Fix ordering of TEST arguments 314a7b9bfa1e540 pw_bluetooth: Comment why we include all emboss he a5052ba92950982 pw_allocator: Make AllMetrics internal 14e0d76298d7690 pw_unit_test: Standardize ASSERT_OK_AND_ASSIGN dea2ecf94d39c9c pw_unit_test: Clarify status macros are gunit-only 4c0dd405e0eedfa pw_build_info: Make the python module importable a9707e739fefa6f pw_allocator: Fix SynchonizedAllocator data race 3d2be38e99af311 pw_presubmit: Remove --verbose_explanations flag 69675d0eddb6ce8 pw_transfer: Implement adaptive windowing in Java 0ce38d914d7f6de pw_presubmit: Use _LOG global for logging 1e72e7e55cef252 pw_presubmit: RST format updates d01aa29f9f9e113 pw_presubmit: Allow disabling hook creation bc6388fd60ff21b pw_tokenizer: Switch detokenize.h docs to Doxygen 5ee9af02a1ef96c docs: Mention @deprecated in the Doxygen style gui c6e83c173d13b52 pw_tokenizer: Support arbitrary recursion in C++ d 8d915ae182f1a1f docs: Update module docs contributor guidelines 682ac383f108edd emboss: Update emboss repo to tag v2024.0419.15560 b21f1b705dbf644 pw_web: Add user guide page for features and filte 9a0e93fe506c9f5 *: Replace `string_view&` with `string_view` 1e8d9d0656f836f docs: Add GitHub pull request template abdcf98492e16e7 pw_spi_mcuxpresso: Rename flexspi to flexio_spi 1faa03a619f99f7 pw_spi_mcuxpresso: Fix Bazel build 9c2c92297a5165d pw_format: Add support for core::fmt style format c8bdb2434d1efa8 pw_allocator: Add BumpAllocator d128b112a1f7dd5 pw_cli: Add SEED creation to CLI tool 5f7e53a3f388446 emboss/CMakeLists.txt: Use COMPILE_LANGUAGE:CXX 6a9cc30b10a4ef8 docs: Require Bazel+GN+CMake for new contributions cbb157a22f60e27 pw_snapshot: Fix bazel builds https://pigweed.googlesource.com/pigweed/pigweed third_party/pigweed/src Rolled-Commits: 0bfe65d4331f9ee..ccc5241d8133cd2 Roller-URL: https://ci.chromium.org/b/8749366246234016129 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: Ibf677c23a0e5f54541ac951910da5607216a610b Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/206861 Lint: Lint 🤖 <android-build-ayeaye@system.gserviceaccount.com> Commit-Queue: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.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.