roll: third_party/pigweed/src 7292afc..34edcc4 (30 commits) 34edcc4:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/434872 roll: luci cd08fc4:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/434833 roll: fuchsia-infra-bazel-rules bd2fc25..8fc414b (6 commits) 4172886:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/434793 roll: rust-analyzer 32dc81b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/430572 android: Add Soong build rules for Pigweed Rust libraries ee08503:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/433975 pw_enum: Add _FMT suffix to generated log token format macros 061a352:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/434272 pw_tokenizer: Default versioned enum format macro to "enum_domain" c244d09:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/434274 pw_kernel: Don't assert on Mutex::lock_until being called from the same thread e492299:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/433555 freertos: Convert Rust backends to use freertos_sys 23f2c41:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/433793 pw_libcxx: Make libcxx_hooks an OBJECT library 204f542:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/429375 third_party/freertos: Add freertos_sys crate cb73f21:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/429374 pw_toolchain: Add bindgen toolchains 5a9253d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/433432 toolchain: Fix missing includes 8f6a8b1:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/407172 pw_containers: Implement type-erased POD Deque specialization for 5f7d5f0:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/433413 rust: Fix new toolchain lint errors f9d0b04:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/429692 pw_thread: Add freertos, pigweed and zephyr Rust backends 87deecc:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/429472 pw_time: Add pigweed and zephyr backends 0c4e494:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/431112 docs: Fix warnings e19579b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/433052 Revert "Reland "roll: Clang and Rust toolchain packages"" 6e18abc:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/432952 Reland "roll: Clang and Rust toolchain packages" 1867c58:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/432892 Revert "roll: Clang and Rust toolchain packages" 2a19596:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/429952 pw_async2: Clean up coroutine deallocation fbc1b56:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/422712 roll: Clang and Rust toolchain packages 1a3fe75:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/428672 third_party: Add prost-reflect crate 81bf56e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/418754 pw_kernel: Add tracing test for each architecture 65f7097:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/432592 pw_bluetooth_proxy: Fix operator precedence in sniff offload 8ae030e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/432472 pw_i2c_linux: expect the ioctl to return 0 abcec90:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/432652 New extended OWNERS 8ac39b7:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/431972 pw_toolchain/zephyr: Add m52 support ecc839d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/432612 roll: picotool prerelease 9893de8:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/432252 roll: fuchsia-infra-bazel-rules ad6b565..bd2fc25 (3 commits) Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed Rolled-Commits: 7292afc35e2253..34edcc4fedf98b Roll-Count: 1 Roller-URL: https://cr-buildbucket.appspot.com/build/8676435689075030817 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: I12548f1496ddb0d1f721e53a84d0c6afa4b65233 Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/435112
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.