roll: third_party/pigweed/src 19f3cfd..6427682 (49 commits) 6427682:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/308692 roll: luci 6125895:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/304457 pw_transfer: Move stream_for to .cc 68e7d63:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/307834 roll: fuchsia-infra-bazel-rules 6ae6df2..5afe284 (59 commits) d6a6beb:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/304456 pw_system: Update zephyr target hooks to new Thread API 035165f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/308392 docs: List all options for @param c630f56:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/304455 pw_system: Allow nop FileManager 992faaa:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/307652 pw_cpu_exception_cortex_m: Use WriteArmv7mCpuStateMessage() f7876e1:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/307934 pw_bluetooth_sapphire: Parse Android v0.99 7ca533d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/302832 pw_assert: Deprecate PW_CHECK_{ADD|SUB|MUL} e619728:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/300443 pw_allocator: Remove extraneous tests 2e0f248:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/307272 pw_kernel: Add Smepmp constraint and epmp regs 2eab742:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/308112 pw_ide: Fix incremental build failure 8dc1262:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/307973 pw_bluetooth: Format hci_android.emb 3be1c11:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/290584 pw_sync: Add timed threaded testing f4b9f07:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/300812 pw_multibuf: Use std::generate to create test data a15096b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/307953 pw_kernel: Turn panic_detector into a lib 776a399:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/301454 pw_allocator: Use more precise block overhead in tests cc32f80:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/307901 pw_presubmit: Register misc clang-format-based formatters 70d4a62:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/307773 pw_presubmit: Migrate whitespace formatter e090efd:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/303852 pw_thread: Add id to Thread message 90ae93f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/306032 pw_thread_freertos: Use WriteThreadsMessage() in SnapshotThreads() e8d2f96:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/307900 pw_build: Implement __contains__() in RunfilesManager 2434409:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/307899 pw_build: Cleanup error types in RunfilesManager 4103190:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/307933 pw_bluetooth: Add Android version 0.99 layout 7006d28:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/307792 pw_presubmit: Hook up rustfmt in Bazel build f9948c3:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/306417 pw_presubmit: Enable GN formatter from Bazel 6b4a6e0:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/302535 pw_cli: Fix relative path exclusion in file collection 861126d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/306416 pw_presubmit: Parameterize formatter initialization 21d5f2c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/307794 pw_kernel: Update system_image to also produce a bin file 72058f8:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/305192 pw_assert: Add uint64_t check macros 48d496a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/305358 pw_protobuf: Add two-pass submessage encoder method 3a6e468:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/307793 pw_software_update: Minor fix in verify.py 9a12d47:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/293253 pw_toolchain: Add freestanding flag 9ca2ce3:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/307772 pw_multibuf: Fix v2 Instance move assignment f199ec7:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/307474 OWNERS: Remove sarahbodin@google.com 914e8a4:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/305774 pw_stream: Add LimitedStreamWriter ebe9299:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/307632 pw_protobuf: Extract some reusable bits in codegen d1a501f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/307192 pw_sync: Make InlineBorrowable's lock interface default to its lock e4f47ca:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/307273 pw_i2c_mcuxpresso: Set log module name for initiators 5dcf370:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/307473 [owners] Remove sarahbodin@google.com from pw_bluetooth/OWNERS 2a3969b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/306972 pw_bluetooth_sapphire: Don't lock autosniff on error 9427723:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/302193 pw_containers: DynamicVector emplace and insert bab1743:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/307193 build: Add missing std::vector includes a15dd07:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/306916 pw_presubmit: Run pw_presubmit checks and format from ./pw presubmit 26a92de:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/306597 pw_presubmit: New local presubmit runnable from Bazel 36df9e7:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/306499 third_party/emboss: Fix pylint warning 4931283:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/302752 pw_clock_tree_mcuxpresso: Add ClockMcuxpressoSysPll support 2d21cc5:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/306652 pw_presubmit: Move non-build checks out of pigweed_presubmit.py 4a9f39c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/304981 pw_build: Suppress noisy output for tool shortcuts Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed Rolled-Commits: 19f3cfd63b9f1c..6427682ab7e3d0 Roll-Count: 1 Roller-URL: https://cr-buildbucket.appspot.com/build/8708144627670786273 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: I17b293ee1fbc084ee2a098c85b187783f79f11f3 Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/308540 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.