roll: third_party/pigweed/src c119d20..7269078 (34 commits) 7269078:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/388572 pw_async2: Remove WakerQueue references ffda31f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/385812 pw_bluetooth_sapphire: Update Fuchsia SDK 4db0219:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/388052 pw_transfer: Reopen stream if closed on client transfer start in C++ e2a9055:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/388215 docs: Link to VARIADIC_MACROS(...) after bug fixes c0c1290:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/388214 pw_env_setup: Switch to doxylink@main instead of upstream/master 627b9a2:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/386833 pw_async2: Remove use of deprecated build system aliases dc724ad:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/387592 pw: Use prebuilt protoc a619e33:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/387872 pw_rpc: Fix implicit conversion warnings ebac615:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/387058 pw_metric: Fix implicit conversion warnings ea3a231:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/387692 pw_containers: Fix implicit conversion warnings 2e3aa19:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/386752 pw_transfer: Support multiple clients on a transfer thread a248201:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/386832 docs: Switch to Pigweed doxylink mirror f0baae6:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/387712 pw_async2: Fix Android.bp for internal yield header 01adad6:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/374273 pw_metric: Wrap metrics lists in custom type 76ef269:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/387534 pw_protobuf: Expose the field key when decoding b49a291:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/386654 pw_async2: Categorize FutureTask as a task instead of a future in docs fb12a0f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/385552 pw_async2: Clarify future completion semantics 246a363:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/385574 pw_bytes: Fix implicit conversion warnings e164d2f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/385452 pw_async2: Dispatcher stress test b78be75:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/385152 pw_ide: Improve Bazel path resolution with symlink prefix support bddecd8:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/387056 pw_log: Fix default log level comment; migrate to Doxygen 922e20b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/386693 pw_build: Add deps handling to pw_linker_script b5ae97d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/372514 pw_bluetooth_proxy: Use v1_adapter::MultiBuf f18e4d7:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/377812 pw_containers: Optimize DynamicMap::erase(const_iterator) 5260489:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/354752 pw_kernel: Panic on double lock 21432ee:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/385872 pw_kernel: Properly break scheduler lock on thread start 7fc049d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/385554 pw_kernel: Implement lock propagation in thread/process join signalling 5aa5d5b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/386692 pw_bluetooth_sapphire: Downgrade log for unacked search results ace6f38:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/386793 roll: toolchain-integration 5e2fab3:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/386792 pw_async2: Fix deregistering a task that is woken while running fd8bb48:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/382832 pw_async2: Do not hold the lock during Wake() f0ac35a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/386812 pw_allocator: Assert ok result in Init() c91d97a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/383893 pw_async2: Remove std::variant; use ReadyType instead of Empty 6685f88:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/374633 pw_async2: Add BoxedFuture and Box helper Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed Rolled-Commits: c119d2065b42b0..72690785a236a4 Roll-Count: 1 Roller-URL: https://cr-buildbucket.appspot.com/build/8686582549481710689 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: Ie8f80fca62766fbf62d1f8fc68c1766edae6da82 Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/388892
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.