roll: third_party/pigweed/src 123911b..2fb733c (51 commits) 2fb733c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/324240 roll: luci 15c064d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/324235 roll: fuchsia-infra-bazel-rules 66c9912..226a7f3 (60 commits) 82340fe:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/324234 roll: python-wheel b0f9c5f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/323973 pw_varint: Refactor and make constexpr 75ab64c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/324012 pw_minimal_cpp_stdlib: Remove module 29628d5:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/323913 pw_protobuf: Add missing Soong public dep 4df7065:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/323894 pw_multibuf: Fix invisible typo in sphinx ref names 4781df4:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/323252 pw_ide: Surface per-file compile command errors to the IDE banner 3b1f1bd:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/323793 pw_metric: Centralize Python parser logic for external use f25c53b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/323259 pw_ide: Test assembly files 970308c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/323257 pw_ide: Reland do not emit arguments for headers db04967:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/322675 pw_kernel: Add app code generation for kernel object handles 124cdce:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/322674 pw_bluetooth_sapphire: Don't accumulate unknown L2CAP config options 14759f5:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/321824 sphinx: Add role for CodeSearch links 2c0b581:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/322873 pw_compilation_testing: Consolidate generic (non-GN) functionality a764d26:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/311329 pw_bluetooth_sapphire: Create PeriodicAdvertisingSyncServer 6ac6638:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/323112 pw_bluetooth_proxy: Make StatusWithMultiBuf comment more accurate 1c62007:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/322952 pw_bluetooth: Add AVDTP_OPEN_CMD to emboss definitions 47ae132:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/322672 pw_ide: Make integration tests more scalable 4787930:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/317153 pw_kernel: Optimize PMP layout ffaf5ea:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/323312 doxygen: Shorten Doxylink role name ee15548:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/322872 pw_toolchain: Add rust aarch64-unknown-none support 45090b6:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/323113 pw_allocator: Remove unnecessary <variant> include 44034df:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/323152 bazel: Upgrade rules_rust to 0.65.0 6e8bbd2:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/322560 pw_ide: Map external files to their real paths a5b6ae8:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/322559 pw_kernel: Add `assert_matches!` and `unwrap!` 9404c71:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/317224 pw_allocator: Add conversions for managed pointers b22a59a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/322568 doxygen: Always link back to main docs 379fd21:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/322673 pw_kernel: Refactor system_generator to consolidate template rendering 6578880:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/322435 doxygen: Add Google Analytics 01a13c6:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/322561 pw_kernel: Rename system_generator commands for better uniformity 0bb763d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/322434 pw_env_setup: Bump requests to 2.32.5 8b1e2d0:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/322620 pw_containers: Add `pw::copy` and `pw::copy_if` 7ce503f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/321819 pw_cli: Add DictOfListsAction CLI argument type e7ccdcf:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/298092 pw_i2c: Add responder APIs 0006d6a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/315952 Android.bp: Add pw_trace build 769a062:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/321832 cleanup: Fix instances of "the the" in tests 198d60a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/321892 pw_{rpc,transfer}: Synchronize access to shared data in Java a9ca51a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/322392 pw_protobuf_compiler: Remove deprecated pw_proto_library rule 3d3512b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/322412 pw_build: Use rerun_shortcut as recipe titles 35f5378:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/321829 sphinx: Tidy build file 09da8bd:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/321823 pw_build: Enable project builder UI for builds 2bf56d4:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/320955 pw_i2c_mcuxpresso: Add I2C_Type base accessor 35da1ca:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/321633 pw_toolchain: Suppress abseil header warnings c87445c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/321592 pw_kernel: Change RiscVSyscallArgs to follow PSABI instead of old ISA 7fe7fde:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/320413 pw_kernel: Add syscall wrappers and concrete time types to userspace 019d095:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/321836 pw_bluetooth_sapphire: Sort service and solicitation UUIDs in ToString() 584dab5:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/321632 doxygen: Change URL c5c4b9d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/321913 *.rst: Reformat C++ code-blocks d88f83f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/321912 docs: Fix code-blocks accidentally labeled as c++ 5d8cf7b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/321692 pw_thread_zephyr: Set thread name from attributes Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed Rolled-Commits: 123911bae1b45f..2fb733cb5103f9 Roll-Count: 1 Roller-URL: https://cr-buildbucket.appspot.com/build/8703071199566498273 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: I60ef2328c0c2d5748ef0fd7327a835c17bde715c Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/324316 Lint: Lint 🤖 <android-build-ayeaye@system.gserviceaccount.com> Bot-Commit: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> Commit-Queue: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.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.