roll: third_party/pigweed/src 6bc0bc6..19f3cfd (48 commits) 19f3cfd:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/306675 roll: luci 0c02471:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/306658 roll: fuchsia-infra-bazel-rules 82e6cdc..6ae6df2 (58 commits) 4e721e5:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/306692 roll: python-wheel 0305df2:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/306672 roll: ninja b15500c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/305813 pw_build: Ensure ProjectBuilder logs are all sent to the right logger f6fd828:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/305812 pw_build: Make run_builds() and run_recipe() class methods c8e4854:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/306452 pw_build: Suppress diff apply warnings 7aeeeef:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/306440 pw_console: Add missing depedency 34b1c7b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/306492 docs: Omit from wildcard build c51c616:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/306415 pw_software_update: Fix Python Bazel targets af17c33:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/306177 pw_thread: Support 64-bit thread priorities 7c47be9:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/306080 pw_build: Separate out build driver post-processing 6a68e69:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/304796 pw_sys_io_zephyr: Prefer raw write 481c120:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/295632 pw_multibuf: Add examples and size_reports 128ac19:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/305852 pw_protobuf: Use `inline constexpr` for k*MaxSize constants e9da3f4:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/305832 pw_multibuf: Handle rvalue references in conversions 5a446c5:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/305933 pw_console: Read user_guide.rst as utf-8 fcd4c6b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/305792 pw_bluetooth: Re-format emboss files 1baea6b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/305492 pw_system: Add bundle size limitation for extra logging 9af5cbf:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/297273 OWNERS: Remove lesprit@google.com from OWNERS fcd4be9:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/304462 pw_system: Update docs for CLI 6e82f7d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/304790 pw_multibuf: Add TruncateTopLayer() 174bd60:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/305712 targets/stm32f429i_disc1: Restore exports_files afd022c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/304454 pw_system: Set default backend for pw_system.io b80172e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/305672 pw_multibuf: Crash if PopLayer() is called on a sealed layer 335900d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/304453 pw_system: Zephyrize the target hooks library d971109:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/302625 pw_log_tokenized: Function for parsing log key-value format a362fc2:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/304788 pw_channel: Require ProxyTasks to disconnect before destruction e8eed7c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/301992 pw_bluetooth_sapphire: Read device path from config again a98759f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/304452 pw_chrono_zephyr: Add system_timer backend 51e1b93:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/305532 pw_bluetooth_proxy: Fix filenames in comments 20b8b3f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/305312 workflows: Make entry point copyable fc1802a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/305187 pw_kernel: Fix docs typos b36fdb5:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/304785 pw_snapshot: Provide default for example f261554:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/305186 .bazelrc: Add msan config to the Bazel build ffc5076:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/304314 pw_rpc: Fix layering check violations b5bbf1d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/305180 bazel: Use pw_py_binary instead of py_binary 2819b3a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/305179 pw_snapshot: Remove unnecessary `imports` 4fed0d5:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/230751 pw_presubmit: Require Python in the source_is_in_bazel_build check 8dfd907:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/304818 *: Add Python files to the Bazel build 77ec892:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/305013 pw_env_setup: Update constraints for cryptography b93d534:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/305021 pw_rpc_transport: Split out pw_metrics dep from StreamRpcDispatcher dd7db8d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/305034 pw_bytes: CopyInOrder overload that writes to a pointer 622cf82:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/305032 pw_build: Replace use of filter_labels_exclude 874e28c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/303172 pw_build: Add driver_options support 29b0d02:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/305033 pw_bytes: Switch pw_bytes/endian_test.cc to PW_CONSTEXPR_TEST 80c6077:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/304492 pw_sync_stl: Remove includes attribute 9edabb1:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/304798 roll: go Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed Rolled-Commits: 6bc0bc64b03333..19f3cfd63b9f1c Roll-Count: 1 Roller-URL: https://cr-buildbucket.appspot.com/build/8708778802817573425 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: I38469f8df125891a5dbbdf17f11e4ccf8b752512 Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/306834 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.