roll: third_party/pigweed/src 9cffd07..187b3da (38 commits) 187b3da:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/475825 roll: luci 4acb139:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/475245 pw_stream_uart_mcuxpresso: Bypass USART_WriteBlocking() fd7de1c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/475125 docs: Update search index filters 096dff1:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/468065 doxygen: Demonstrate snippets ac2148a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/381039 pw_allocator: Add FramingAllocator 5bdc1c6:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/474105 docs: Fix miscellaneous issues in new UI 2e5d536:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/473245 docs: Add breadcrumbs 83bb188:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/467905 docs: Integrate navs 6ab18d7:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/456609 docs: Start theme selector c7c4172:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/456608 docs: Update search ec6a097:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/461365 docs: Start tests fdc232b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/456607 docs: Start header 81d1b0e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/474225 third_party/fuchsia: Copybara import 4206163:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/474266 pw_tokenizer: Update google3 Java JNI build files b852b7c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/474285 third_party/fuchsia: Update Copybara config and patch c63ef78:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/457405 pw_log_rpc: Release drain mutex during transport egress in SendLogs a69c300:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/473765 pw_buf: Add ConstBuf::Unowned 040a050:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/468146 pw_env_setup: Bump aiohttp to 3.10.11 for Python 3.13 support 93cccc4:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/413992 pw_multibuf: Integrate pw::MultiBuf with pw::Buf e5aab50:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/354134 pw_containers: Introduce pw::ForwardList 766f56f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/464005 pw_rpc: Refactor docs; add integration guide ed478b2:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/440233 pw_sync: Add pw_sync_mutex crate 6c49f7d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/434193 pw_grpc: Check return value of QueueSend ffacc87:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/417432 pw_bluetooth_sapphire: Remove CIG on close 7ea06cf:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/472666 pw_allocator: Support null control block in SharedPtr ba9b15b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/470645 go: Upgrade grpc to 1.82.1 e7f29be:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/463069 build: Fix missing deps, includes, and headers bfda163:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/470365 pw_ide: Fix header include resolution relative to compilation directory 361fe7a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/469325 nanopb: Fix nanopb_pb2.py output path in CMake 581082c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/472585 lint: run pw format --fix BUILD.gn **/*.gn **/*.gni 294d431:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/472185 pw_bluetooth_proxy: Support loopback mode in CommandMultiplexer 7b8f882:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/464845 pw_build: Define sharded kernel_host and kernel_device workflow groups 9009709:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/472345 pw_i2c_zephyr: Add initiator bazel target d7dbc70:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/455906 pw_kernel: Program the VeeR MEIVT redirect table b05f4bc:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/472186 pw_async2: Add ValueFuture::Cancel; fix destruction race f47827e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/468005 pw_protobuf: Fix code generation for "tag". a82ae0c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/468925 pw_bluetooth: Add LE Remove CIG command complete event e4f9446:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/471565 roll: go Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed Rolled-Commits: 9cffd077bfd5ff..187b3dad5677ae Roll-Count: 1 Roller-URL: https://cr-buildbucket.appspot.com/build/8670728079718491249 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: Ife96923b549d2855306dc0ea91820b42d0452c6c Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/476165
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.