roll: third_party/pigweed/src 8fbbc0b..c3c6b2e (46 commits) c3c6b2e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/380812 roll: luci 3675b41:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/380752 roll: fuchsia-infra-bazel-rules 87916b3..e18d181 (57 commits) 25af001:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/375313 pw_containers: Optional type with custom state enum 694ae91:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/380292 pw_result: Make internal StatusOrData shareable as OptionalData 0ad0ca4:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/379972 bazel: Update pip.parse configuration 44aad11:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/380337 pw_protobuf: Add common_nanopb target a8bdfa6:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/376592 rust: Upgrade rules_rust 137aa78:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/379974 perfetto: Disable rust target for trace proto on MCU's eb45471:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/380333 roll: toolchain-integration 58f58dd:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/369212 rust: Add zngur dependency to crates_std 8469437:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/379973 pw_crypto: Add missing pw_assert dep for the aes facade 030c4b5:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/380012 pw_bluetooth_proxy: Fix obsolete comment 2184810:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/379123 pw_bluetooth_sapphire: Add L2CAP AirPods 4 interop workaround 64de9ff:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/379492 bazel: Start upstream Pigweed debugging docs 98b5d67:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/379636 pw_bluetooth_proxy: Update vendor capability event for sniff offload 292e953:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/379513 pw_ide: Remove Unsafe Globbing from Merger 2959e07:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/379635 pw_bluetooth_proxy: Break up buffer allocation for utility c697270:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/379634 pw_bluetooth_proxy: Missing move assign in sniff_offload_manager_test ba5fd4a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/379633 pw_bluetooth_sapphire: Correct android vendor capabilities for v1.05 261503f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/379632 pw_bluetooth: Add sniff_offload_support to hci_android 658f738:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/379573 pw_console: Add close method to SocketClient 48444bb:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/374755 pw_allocator: Add ControlBlockHandle f2d9010:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/379494 pw_kernel: Add additional tests to foreign_box 5edb7ce:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/379192 pw_kernel: Fix refcount bug with upcasting 383a73d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/377754 pw_kernel: Terminate userspace threads on exception 9629572:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/374153 pw_kernel: Fix build cache trash between build and test ea0f6e2:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/373953 pw_kernel: Remove SysTick CALIB assertion ac41770:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/379334 pw_toolchain: Keep debuginfo for Rust targets in all compilation modes b70eb97:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/371775 docs: Update lockfile instructions 6cf3322:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/367510 pw_bluetooth_proxy: Borrow sync l2cap channel 39ede44:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/375115 pw_kernel: WaitGroups 2abf536:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/379052 pw_toolchain: Fix Android.bp due to dependency issue 3f57ef2:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/362072 pw_bluetooth_sapphire: Add metrics for transaction collisions bbc2523:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/377292 bazel: Set explicit mnemonic for Starlark actions 7ba958a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/373737 roll: Update to protobuf 33.4 727baff:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/379012 pw_watch: Fix dry-run option 219d219:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/378694 pw_bluetooth_sapphire: Use flow control for service search results 6c33386:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/378612 pw_bluetooth_proxy: Fix missing cmake dep in rfcomm 2fa8c12:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/375972 pw_transfer: Fix xt-clang++ build error in TerminateTransfers df72a8c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/378593 pw_bluetooth_proxy: Fix sniff_offload Android.bp 71eaff9:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/378614 roll: toolchain-integration 6b6d2d2:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/378632 pw_toolchain: Fix dependency issue in Android.bp 0b0b9c6:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/378613 agents: Add code review workflow f26b92f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/378572 pw_bluetooth_sapphire: Handle empty URL string c218181:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/377756 pw_presubmit: keep-sorted Bazel entrypoint and workflow b8ee636:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/375712 pw_chrono_zephyr: Implement Cancel Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed Rolled-Commits: 8fbbc0b99de700..c3c6b2e6f646d1 Roll-Count: 1 Roller-URL: https://cr-buildbucket.appspot.com/build/8688485084468315185 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: I7aed2c90798ed8edf0fea9e3b5a7d486ad359ae3 Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/380952
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.