roll: third_party/pigweed/src 3cd31cb..c119d20 (32 commits) c119d20:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/386312 roll: luci c636c8e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/386232 roll: fuchsia-infra-bazel-rules a8229fe..e128163 (19 commits) 1685478:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/385912 pw_kernel: Don't compile tests into system images d844706:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/385793 pw_bluetooth_sapphire: Add LE connection Inspect data 465ef5a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/385555 pw_bluetooth_sapphire: Add BR/EDR connection Inspect data 8c58dba:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/385575 pw_format: Remove unused unstable features 5de921b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/385556 pw_async2: Add default case to handling Context for CoroTask 424cd78:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/385553 pw_kernel: Increase wait_group stack sizes to match other tests 53b7d52:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/385454 pw_presubmit: Exclude roll changes from check 934faee:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/385572 pw_protobuf: Remove in progress note from docs dc59fc1:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/372352 pw_async2: Use PW_AWAIT instead of TRY_READY* f080d75:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/385052 pw_async2: Update Join to move values out on completion 2050c3c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/385432 roll: fuchsia-infra-bazel-rules bfcbce6..a8229fe (45 commits) db13df1:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/383992 pw_async2: Switch Dispatcher to IntrusiveForwardList 4f7f36d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/383612 pw_bluetooth: Add btsnoop epoch delta 6004156:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/384392 pw_package: Log output when git clone fails 381b193:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/382478 pw_toolchain: Expose toolchain tools and add docs 8ffc64a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/382772 pw_bluetooth_proxy: Fix build fail from FreeRTOS system c2a60fa:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/381612 pw_ide: Add a Local GEMINI.md for more specific guidance 5a9beee:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/384332 pw_kernel: Preserve system template evaluation error context e21bd35:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/384352 agents: Refactor code review workflow into a skill 5513af6:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/383938 pw_containers: Merge CountAndCapacity into GenericDeque cb45bc3:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/383892 pw_bluetooth_proxy: Create Bazel aliases for gatt and rfcomm ea310a2:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/382512 agents: Create bluetooth skill 6bb3e49:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/383973 pw_async2: Move coroutine examples to source file; JoinFuture fix 58b7f38:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/379212 pw_bluetooth: Add LEGetControllerActivityEnergyInfoCommand 4f20d14:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/383873 pw_bluetooth_sapphire: Add documentation on how to use local Fuchsia SDK 327fbe0:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/381872 bazel: Delete WORKSPACE file e31fe49:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/383572 pw_async2: coro.h Add missing <variant> include 7eb2a4b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/383012 pw_async2: Clean up Waker and Task 3198994:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/383732 roll: go ef2647d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/382812 multibuf: Remove SingleChunkRegionTracker memset on release Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed Rolled-Commits: 3cd31cbba67cb2..c119d2065b42b0 Roll-Count: 1 Roller-URL: https://cr-buildbucket.appspot.com/build/8687216727661062177 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: I84744a55b788cb548acda07d1546b3404f36a6b3 Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/386472
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.