roll: third_party/pigweed/src 61d7836..3e01ec3 (28 commits) 3e01ec3:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/368132 roll: luci 71cbd5f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/367973 roll: fuchsia-infra-bazel-rules 235caa4..13d5785 (53 commits) a251874:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/367972 roll: ninja 0663bb2:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/367511 pw_ide: Skip conflicting compile commands cf693a3:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/367013 pw_async2: Rename PendFuncTask to FuncTask 62a5ab5:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/367012 pw_async2: Rename PendFuncTask's header to func_task.h b525d96:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/367552 pw_result: Use same type for monadic operations in tests 56d159b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/367452 pw_bluetooth_sapphire: C++23 fixes aa02543:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/364313 pw_ide: Release v1.10.2 a168012:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/357653 docs: Add intro for setting up a MCU in Bazel bce9218:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/367553 bazel: Roll rules_libusb 06c5fc5:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/364394 pw_ide: Handle non-pigweed workspace gracefully 5f6bce5:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/355257 pw_bluetooth_sapphire: Add AdvertisingPacketFilter::Config delivery mode 76b0b31:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/355254 pw_bluetooth_sapphire: Provide an rssi floor if the user doesn't 4a5cc1e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/355854 pw_bluetooth_sapphire: Use an allow all filter during host filtering 445c5be:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/364393 pw_ide: Remove first-run confirmation to do bazel settings d05358b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/364392 pw_ide: Simplify wrapper script by always using /bin/sh 7818487:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/366895 pw_toolchain: Declare prost toolchains 5748a97:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/366332 pw_allocator: Add missing source files to Android.bp d3e4f2a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/235051 pw_chrono: Create TimerWithContext statically d4be0b9:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/364215 pw_bluetooth_proxy: Remove support for internal allocator 187bcc2:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/366896 pw_async2: Clarify the task a waker wakes b532b4a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/366893 pw_async2: Remove deprecated WakerQueue class 89d991d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/361712 pw_memory: Move features from pw_toolchain to pw_memory e61b266:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/366932 pw_async2: Remove deprecated PendFuncAwaitable class 4b4187c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/366934 bazel: Update MODULE.bazel.lock b99743b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/366892 pw_span: Remove dep on //pw_assert:assert 8ce3f57:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/364312 pw_bluetooth_proxy: Add integration test for SendNotification Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed Rolled-Commits: 61d78360e37071..3e01ec3fda61ad Roll-Count: 1 Roller-URL: https://cr-buildbucket.appspot.com/build/8691655981496036257 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: I3a4babd93d656cd181fb67f6ae6be2cec0ab246c Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/368272 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.