roll: third_party/pigweed/src baa7b86..34d3f2b (47 commits) 34d3f2b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/394392 roll: luci e278c5b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/394332 roll: fuchsia-infra-bazel-rules 68e4ab3..a1d2f9b (33 commits) b58178e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/394252 roll: rust-analyzer ca2aef5:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/393553 pw_clock_tree: Specify behavior of Element 2d344f0:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/393552 pw_clock_tree: Remove may_block function d64aa43:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/393772 pw_build: Removed deprecated generated GN docs group 5f2308b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/387694 pw_kernel: Add ability for userspace apps to share .text sections e6c0924:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/380334 docs: Renew changelog and fix heading styles 5bdab56:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/393812 pw_containers: Add intrusive_queue.cc to pw_containers lib in aosp 2f4bff6:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/393532 pw_bluetooth_proxy: Allow consumers to include config headers ab88459:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/393212 pw_bluetooth_sapphire: Fix rp2040 toolchain build errors 1fbf83c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/391153 pw_kernel: Merge app_package and rust_binary into app_binary task 3cd2928:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/390532 pw_multibuf: Make v1_adapter's MultiBuf derive from MultiBufChunks 70eec11:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/393372 pw_memory: Mark SiblingCast aliases as [[maybe_unused]] fd6c1fb:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/302835 pw_numeric: Avoid overflows in integer division 0d53323:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/372212 pw_numeric: Add constexpr pw::abs 8a8d135:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/393374 Revert "pw_sync_freertos: Inline the interrupt_spin_lock lock & unlock" 9a0e4e4:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/393373 Revert "pw_sync_freertos: Add config to skip scheduler lock in ISL" 528a795:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/390094 pw_multibuf: Mitigate conversion ambiguity 113fdb8:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/387732 pw_ide: Fix missing headers in deep chains of header-only targets 0b44b62:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/393232 pw_clock_tree_mcuxpresso: Rename NewSource to Source cd5e289:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/392073 pw_preprocessor: Rename Bazel arch library target a1bf3c2:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/391933 pw_sync_freertos: Add config to skip scheduler lock in ISL e27572e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/391932 pw_sync_freertos: Inline the interrupt_spin_lock lock & unlock 903b548:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/388554 pw_bluetooth_proxy: Fix rfcomm tx while rx deadlock 5c912c5:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/378577 pw_bluetooth_proxy: Add SendAdditionalRxCredits method 9682547:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/392536 pw_clock_tree_mcuxpresso: Sync selector cbd117d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/392535 pw_clock_tree: Allow to set source element 3b38a21:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/392534 pw_clock_tree_mcuxpresso: Relax clock tree dependency requirements 7907154:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/392533 pw_clock_tree: Relax clock tree dependency requirements e5908f1:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/392532 pw_clock_tree_mcuxpresso: Add test cases f6158b5:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/302836 pw_numeric: Add rounding.h 820253a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/392712 pw_bluetooth_sapphire: Refactor dispatcher to be passed to classes b164627:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/389972 pw_multibuf: Fix double free in SimpleAllocatorForTest f1abb60:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/392232 pw_function: Support specifying a config header a47cb73:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/387065 pw_ide: Include header files in compile commands 3e2a21b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/388413 pw_ide: Optimize the compile_commands aspect 81c5abe:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/391033 pw_rpc: Docs improvements 34754b5:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/392492 third_party/fuchsia: Update Fuchsia patch 014a200:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/388212 pw_ide: Cache external path resolution to optimize I/O 40d19e6:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/392652 pw_multisink: Add Drain::attached method 3d282db:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/392772 pw_async2: Remove CRTP reference from async2 code size doc 6e19a3e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/379572 pw_transfer: Add server-side pw transfer lifecycle callbacks 2f0e782:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/392372 pw_containers: Add reset() function to free all memory 6e225e5:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/389672 pw_multibuf: Add default ctor to SingleChunkRegionTracker cabbf3e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/392092 pw_bluetooth_sapphire: Clean up some unused includes f0e6cae:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/388532 pw_async2: Fix Android.bp errors for multiple projects Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed Rolled-Commits: baa7b869f5bbb8..34d3f2b76f96c4 Roll-Count: 1 Roller-URL: https://cr-buildbucket.appspot.com/build/8685314191851650209 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: I67a31bda9e9c213b9306b6bcf2543d6400335f9a Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/394393
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.