roll: third_party/pigweed/src b06cdf7..dfefd0c (65 commits) dfefd0c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/335072 roll: luci 263c47e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/334892 roll: fuchsia-infra-bazel-rules c4a75a7..fd27f0a (53 commits) 4e9c2b6:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/334872 roll: python-wheel d1af3b0:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/334475 pw_async2: Define log macros before all includes 147a670:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/333293 pw_ide: Fix manual compile commands generation with wrapper 46cc451:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/334152 docs: Update rp2040 target docs e4c113e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/330752 pw_async2: Relist ListableFutureWithWaker on Pending 19a10cc:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/333972 pw_{cli,presubmit}: Fix path filtering 44b0293:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/329921 pw_async2: ListableFutureWithWaker without provider 362c4c3:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/333973 *: Remove unused files and add missing file to BUILD.bazel f330f66:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/330074 pw_kernel: Add thread priority 56a04d5:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/334253 pw_trace_tokenized: Fix Android build error 515eecc:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/332935 pw_kvs: Better conform to GDSG 844fb9b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/330073 pw_kernel: Encapsulate scheduler algorithm b6d9d10:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/333994 pw_unit_test: Disable no-compile tests on MCUs 0e8e0ae:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/333993 pw_async2: Tag js_run_binary as target_incompatible_with_mcu cc18ce6:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/330472 pw_digital_io_zephyr: Refactor GPIO flag support 346d2e1:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/333712 pw_presubmit: Exempt size reports from the GN build 1ba89dc:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/333912 pw_continers: Move Storage's type template parameter to an alias 790cd8c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/333152 pw_i2c_zephyr: Support read only and write only i2c transactions 9f5f893:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/333853 docs: Remove Sense factory test rp2350 bug notice a084ad1:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/333295 pw_trace_tokenized: Add an alias for TraceBuffer abf1641:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/332855 pw_containers: Aligned storage utility class d55c3fc:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/332854 pw_containers: Update shared test structure; various fixes d5642b4:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/333292 pw_containers: Add method to dering variable length entry queues 85279c1:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/332212 pw_file: Add android build support 4b00064:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/330592 pw_trace_tokenized: Add decoder to Android.bp 73a7b29:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/332336 pw_bluetooth_proxy: Squash signaling channel classes c32949f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/325932 pw_kernel: Refactor 16550 UART and move to common drivers directory 4adef55:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/333012 pw_async: Add HeapDispatcher::inner() getter c3eb8ea:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/329918 pw_containers: Add data accessor to var len entry queue bfbba22:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/332732 pw_metric: Remove internal alias e4336b7:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/332752 pw_metric: Remove obsolete PW_METRIC_PWPB_WRITER_NEW and fallback dbaebf7:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/332936 pw_tokenizer: Use given domain for lookup() 19f576a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/333133 pw_bluetooth: Change Snoop::Add methods to accept const packet 3be5001:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/333132 pw_bluetooth_proxy: Add const accessors to H4PacketInterface edf1889:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/316735 pw_containers: Add VarLenEntryQueue 29cef26:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/332933 pw_presubmit: Add pw_internal_namespace check dc0b59f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/333073 pw_build: Fix pw_py_importable_runfile when used in downstream 3cd2cda:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/332934 pw_ide: Fix manual compile commands generation option 945e5d5:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/333053 pw_kernel: Remove unused use statement 44b6397:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/333052 docs: Rename //:docs 1ed0873:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/332714 pw_metric: Remove template from PwpbMetricWriter a7d4fd1:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/332932 pw_unit_test: Add PW_CONSTEXPR_TEST_IF_{CLANG|GCC} 446d811:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/332912 pw_ide: Fix typo 3d56e38:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/330832 pw_kernel: Support dynamic base address registers 4e3f4ee:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/332453 pw_build: Add workflows tests fe31e1d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/332913 pw_ide: Only generate compile commands for compiled files 59c4086:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/332852 pw_containers: Fix explicit guards for OptionalTuple 7b8736e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/332692 pw_metric: Move metric_walker.h out of pw::metric::internal namespace d848f10:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/332572 zephyr: Depend on FULL_CPP rather than select it 6bf1c5b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/332416 Revert "roll: ninja" 5e0cbce:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/332413 pw_config_loader: Support searching for multiple configs 2093384:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/332415 pw_bluetooth: Add check for moving into active Reader object 2547eff:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/331133 pw_bluetooth: Use InlineString and Vector instead of heap for snoop test 5fe02c8:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/331093 pw_bluetooth: Add Reader stream access to snoop log 17fb2df:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/331312 pw_build: Add output specs to workflows.proto 21fa95f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/330912 pw_compilation_testing: Improve NC test build errors bd8ccac:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/332332 zephyr: Update OWNERS 967ad18:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/330412 pw_metric: Introduce PwpbStreamingMetricWriter for zero-copy encoding c1df27e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/331352 pw_bluetooth_proxy: Accept client Allocator for H4 packets 4d59dac:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/331132 pw_ide: Show Retry Fixing button when clangd path is empty 73cfd64:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/330279 pw_bluetooth_proxy: Migrate from H4Storage to Allocator 887cbd9:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/332012 roll: go 45cfb69:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/331892 roll: zephyr Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed Rolled-Commits: b06cdf7b659664..dfefd0c6cbae90 Roll-Count: 1 Roller-URL: https://cr-buildbucket.appspot.com/build/8700534484070467249 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: I1578e8bd8e18666e8fd90a6332983fea74675cda Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/335253 Bot-Commit: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> Lint: Lint 🤖 <android-build-ayeaye@system.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.