roll: third_party/pigweed/src ee0df99..e7cf4b9 (78 commits) e7cf4b9:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/313754 roll: luci 968e154:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/313434 roll: fuchsia-infra-bazel-rules cec8688..05c81c4 (58 commits) 1160022:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/313433 roll: ninja 25ab6e8:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/312753 doxygen: Migrate pw_containers 654b7d4:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/313133 doxygen: Migrate modules 1621a81:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/312893 pw_i2c_mcuxpresso: Fix compilation errors cfeded5:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/313573 pw_build: Add missing dependency eacae21:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/313552 pw_protobuf: Don't try decode from empty reader in Next() 84798bd:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/313492 pw_kernel: Add kernel argument to timer callbacks 61d8149:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/313473 pw_kernel: Refactor timer callbacks into a trait 5292d84:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/313334 pw_async2: Codelab instructions for step 1 e3de272:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/313159 pw_kernel: Use correct values for 64KB 456ed66:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/312052 pw_async2: Example for using InlineAsyncQueue with coroutines f544c01:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/313158 pw_kernel: Switch to JSON5 for system manifests 52ca5ff:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/311437 pw_i2c_mcuxpresso: Add SETMWL call 6e466b7:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/313313 pw_thread: Use protobuf-provided enum string mapping 07af7f0:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/313335 pw_build: Add --step selector for Workflow groups 70b9843:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/313532 pw_ide: Set clangd arguments in settings.json on boot c516da3:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/313332 pw_async2: CoinSlot abstraction for codelab 5578de5:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/313172 docs: Add analysis section to Sense tour 93f02d7:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/313056 pw_toolchain: Add constraints to rust toolchains 75b13b7:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/313494 .gitignore: Add *.code-workspace 10c1560:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/312493 pw_kernel: Simplify ForeignRc 83bf224:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/313493 pw_async2: Rename Poll<>::OutputType to Poll<>::value_type c76ff86:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/313432 pw_rpc: MaxWriteSizeBytes() function for raw call objects 46f12c7:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/311539 pw_async2: Example for using an InlineAsyncQueue 45c247d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/313453 pw_allocator: Reset UniquePtr<T[]>::size_ to 0 on Reset 0e3d7f9:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/313337 pw_intrusive_ptr: Add deduction guide for MakeRefCounted 262e21c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/313312 pw_thread: Simplify snapshot creation in thread_analyzer_test.py cf9ded3:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/313232 pw_thread: Expand description of Thread.stack_pointer field ca04ce8:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/312692 docs: Add note about bazelignore 4205cc1:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/300412 pw_chrono_stl: Improve infinite timeout handling in system timer ac8c8d8:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/306912 pw_kernel: Simplify pmp structure e34e218:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/313292 pw_toolchain: Load sh_binary from rules_shell 3803949:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/313162 bazel: Always set pylintrc config flag 6ca50f4:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/313092 pw_async2: Initial codelab files 591f199:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/313055 pw_metric: Remove message that this is not production ready f29dbd6:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/312892 pw_uart_mcuxpresso: Fix dma_uart_nonblocking compiler errors 0524f95:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/312757 pw_async2: Use the PendResult and PendOptional aliases e8fd38b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/313156 pw_bluetooth_proxy: Add TODO for to-host frag tests b7ccb9a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/313155 pw_bluetooth_proxy: Pass on unhandled recombined PDU 14e2976:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/313154 pw_bluetooth_proxy: Tweaks to recombine null rx allocate test 48d6349:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/313153 pw_bluetooth_proxy: Always fill broadcast_flag 1299d4c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/312754 pw_presubmit: Allow .expected without copyright 8aa469f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/313161 pw_presubmit: Exclude codelabs and examples from GN build files check 986f721:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/313157 crates_io: Add serde_json5 to crates_std b5596a5:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/313160 roll: nanopb 54f34b9:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/311536 pw_kernel: Implement has_access for memory configs ca15544:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/312676 pw_async2: Enable wait reasons by default 29add2b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/312952 pw_thread_zephyr: Fix NativeOptions::set_name c9ba341:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/312756 pw_async2: Convenience aliases for Poll d1fa0c5:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/308195 pw_kernel: Add the `mtval` to exception messages 32d7a20:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/304252 pw_crash: Add DebugMon exception to arm cortex-m crash handling 5e5c8d8:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/312318 pw_sync: Create no-op lock stand-in pw::sync::NoLock 2a5775d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/312675 doxygen: Migrate pw_function d69e09d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/312752 pw_kernel: Improve system_generator error handling b0f8747:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/312673 pw_async2: Don't build interrupt example on Windows 3c94819:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/311319 docs: Refactor the automated analysis docs 989a628:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/312652 pw_build_android: Update pw_build_android docs with proper target name 78f43df:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/312672 pw_bytes: Rename uint variable to avoid potential conflicts 70d1b3b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/311617 pw_async2: Initial docs and examples for unit testing with pw_async2 0027f9b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/312320 gemini: Command to fetch and respond to gerrit comments 4cefbef:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/311614 pw_async2: Fake interrupt example 93ebb01:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/312432 pw_env_setup: Fix arm-none-eabi-gdb detection logic 913b3b2:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/312252 pw_change: Add comments subcommand 652d07c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/312322 pw_bluetooth_proxy: Update TODO bug # d601bc1:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/311540 pw_bluetooth_proxy: Check for null channel rx allocator 415ebf0:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/311412 pw_clock_tree: Remove ClockTree class e51744f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/312372 pw_clock_tree_mcuxpresso: Stop using ClockTree in docs and examples 54de344:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/312313 pw_build: Use Label() instead of @@ in mypy aspect dcbb114:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/312312 pw_ide: Remove zxh404.vscode-proto3 as dependency f97f38f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/312292 pw_protobuf_compiler: Remove black dependency 4679013:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/311732 [owners] Remove aharp@google.com from pw_stream_uart_linux/OWNERS 293df77:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/309392 pw_uart_mcuxpresso: Drop ClockTree completely 2c94e84:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/309393 pw_stream_uart_mcuxpresso: Drop ClockTree completely b3de4b9:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/309394 pw_i2c_mcuxpresso: Drop ClockTree completely 2f23c98:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/311535 clang-tidy: Add modernize-pass-by-value 3c25e01:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/312112 roll: go Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed Rolled-Commits: ee0df9974ad347..e7cf4b9d58d1ce Roll-Count: 1 Roller-URL: https://cr-buildbucket.appspot.com/build/8706242090570165345 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: I651165b8960db1a59c2673966be7d8e1ecebf690 Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/313466 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 --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.