roll: third_party/pigweed/src 85ff7d8..4866ff3 (36 commits) 4866ff3:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/331092 pw_ide: Fix active files detection for symlinked files 59e0a8f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/330753 pw_stream_uart_mcuxpresso: Acquire / release clock element dynamically 279b0c2:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/330263 pw_bluetooth_proxy: Remove RFCOMM c2e3baa:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/330572 pw_bluetooth_proxy: Correct Android.bp dependencies 949cf60:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/330272 pw_build: Move describe to separate file de8b71f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/328273 pw_tokenizer: Support accessing tokens at runtime fce05b3:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/330278 pw_spi_mcuxpresso: Support SDK 25.09.00 966df73:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/330276 pw_transfer: Add support for limited range to TransferHandlerAllocator 58bc121:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/321533 pw_bluetooth_proxy: Migrate to multibuf_v2 d2e5e41:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/324509 pw_transfer: Reopen stream on start packets in Python 7137a2f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/328333 pw_bluetooth_sapphire: Handle different transaction collisions 71e49f3:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/316734 pw_containers: Make GenericVarLenEntryQueue tests reusable 4b1ffcb:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/315472 pw_containers: Add methods to bulk copy/move to GenericVarLenEntryQueue 055542d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/328973 pw_transfer: Add TransferHandlerAllocator 0840cac:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/330275 pw_presubmit: Get formatting tests working in Bazel 86e8936:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/330072 pw_i2c_mcuxpresso: Use a ScopeGuard for releasing the clock_tree element 9098899:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/329925 pw_i2c_mcuxpresso: i3c: Acquire/release clock_tree element dynamically 4720e40:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/316934 pw_multibuf: Add a top-down example 7bebdb3:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/330153 pw_async2: Misc cleanups ab9db62:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/297538 pw_thread_zephyr: Export files for zephyr build c056120:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/330014 pw_ide: Fix fragment collection with RBE enabled d5d5f62:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/321914 pw_presubmit: Format C++ code blocks in RST with clang-format edf0647:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/330152 pw_presubmit: Enable unnecessarily disabled test 1efdc99:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/323314 pw_async2: Experimental SelectFuture cfae9b2:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/329252 pw_unit_test: Include file name in test expecations c2b34c9:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/328674 pw_tokenizer: lookup() method for the Java Detokenizer dc0adae:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/329932 pw_containers: Fix DynamicVector::erase() 6cfefb6:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/329922 pw_multibuf: Fix msan finding in examples a183a6e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/329917 pw_async2: Remove package.json from the webui build 39400c0:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/321830 pw_unit_test: Update pw_golden_test for test executables a09ff62:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/330013 pw_bluetooth_sapphire: Accept various linter suggestions 197070a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/316356 pw_containers: Refactor InlineVarLenEntryQueue 9374d5d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/329253 *.rst: Reformat C++ code-blocks f777841:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/326103 pw_containers: Avoid dereferencing `end()` 2054fe6:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/329172 pw_i2c_mcuxpresso: Acquire / release clock_tree element dynamically b40327a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/328072 pw_build: Support configurable pypi repos Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed Rolled-Commits: 85ff7d8715ad7b..4866ff3d26ee5e Roll-Count: 1 Roller-URL: https://cr-buildbucket.appspot.com/build/8701455700490975633 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: Ib11be446f6bd591ec6a24834b84f9f5316f97d19 Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/331056 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.