roll: third_party/pigweed/src 6427682..b9f1c4d (62 commits) b9f1c4d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/310453 roll: luci 18b8c0d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/310452 roll: fuchsia-infra-bazel-rules 5afe284..975a6fb (52 commits) 94340c0:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/310392 pw_bluetooth_sapphire: Fix typo in LESupportedFeature 299a0d7:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/309796 pw_ide: Run compile commands target with flags as real bazel invocation 6aa476c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/307634 pw_protobuf: Refactor codegen around "generate" functions 8c09ffa:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/307633 pw_protobuf: Refator codegen to reduce duplication around ClassType 873f732:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/306414 pw_build: Allow users to use their own Zephyr module e48f9ae:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/309972 pw_build: Improve must_place.ld.h error output d2b4a3b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/309992 pw_log_fuchsia: Update to new Fuchsia logging API d3cba10:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/309732 pw_cpu_exception_cortex_m: Access cortex_m regs via function 5efc915:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/309760 pigweed.json: Add docs build to bazel_presubmit 5e40b7c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/309442 doxygen: Document namespaces cdf12ab:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/309815 rust: Changes to support rust toolchain roll 12964cd:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/309932 pw_kernel: Remove multiple calls to Target::console_init() e59efb0:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/309814 pw_bloat: Update Rosetta 2 check 1a79f1e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/301459 third_party/crates_io: Add bitflags crate ca37f06:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/304673 pw_log_zephyr: Add support for other backends 8395cf9:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/308972 third_party: re-allow FuzzTest to be ASAN instrumented by default 88ff1ab:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/309440 pw_ide: Remove "refresh compile commands and set target" command entry a647434:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/309477 pw_ide: Use VS Code's when clause to manage command availability 87f7abc:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/308413 pw_build: Update rust edition to 2024 e2552c5:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/307876 pw_sync: Adjust unit test namespacing a2d2850:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/299832 pw_trace_tokenized: Decouple buffer clearing from trace stop d802b1a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/306952 pw_trace_tokenized: Fix incorrect timestamp 93d7208:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/303112 pw_trace_tokenized: Use pw_sync for trace locking 94612e0:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/298892 pw_trace_tokenized: Get platform clock parameter 6661c8a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/309443 Revert "pw_log_fuchsia: Update to new Fuchsia logging API" 67a7bac:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/309438 pw_presubmit: Support formatting Go in Bazel projects 963ed52:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/309437 pw_presubmit: Enable Starlark formatting 40e21b5:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/309475 pw_ide: Fix clang path on fish shell b341c2f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/309478 pw_ide: Enable composite tsconfig for VSCode dev 889c3d6:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/308913 pw_clock_tree_mcuxpresso: Change ClockMcuxpressoFrg to own config b91cac9:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/307903 pw_presubmit: Enable JS/TS formatting from Bazel f60cb2b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/301392 pw_allocator: Add method to find the largest free block 8c7de10:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/307910 pw_bluetooth_sapphire: Create GEMINI.md for host stack a3d8ef6:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/309476 pw_build: Fix type in PythonRunfilesLabelAdapter c72af82:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/309432 pw_presubmit: Add toggle flags for all formatters dac849c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/309433 pw_bytes: Clarify restrictions of ObjectAs[Writable]Bytes 72d8343:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/307906 pw_bluetooth_sapphire: Add periodic advertising test packet helpers 8416642:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/307976 pigweed.json: Add pylint to Bazel lintformat e8ad179:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/307958 python: Exempt some packages from pylint a63c930:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/309472 Revert "docs: Enable Doxylink" 2889f70:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/308273 pw_multibuf: Remove ResizeTopLayer from v2 86a146f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/307875 pw_sync: Move test utilities 89632ab:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/308814 pw_env_setup: Add `prettier` to the PATH 05f18a2:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/308192 pw_presubmit: Migrate reST formatter to be Bazel-ready 134ffa7:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/309073 pw_toolchain: Adjust toolchain config scope 3cd267d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/309032 pw_env_setup: Fix NPM install on Windows ed98e92:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/299993 docs: Enable Doxylink 264d264:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/309113 MODULE.bazel: Use variables for some versions a9fd1ff:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/309033 pw_ide: Improve VSCode dev instructions 44ad98b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/307974 python: Fix or silence pylint warnings 7294c0b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/309112 pw_env_setup: Remove ruff.json fb2de36:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/307902 pw_presubmit: Enable JSON formatter in Bazel 2334604:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/307905 pw_bluetooth_sapphire: Support Emboss OpCode in CommandPacket 10803f6:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/308912 pw_rpc: Add unwrap_or_raise to StreamResponse beb1354:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/304794 pw_system: Set module name for hdlc_rpc_server c8eb960:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/308272 pw_bluetooth_proxy: Remove SetType from comms2 H4Packet 828dfc2:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/306081 bazel: Add pylint support a3b73b8:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/307904 pw_blueooth: Add periodic advertising Emboss packets 4a43271:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/308352 pw_hex_dump: Add pw_log dep d208dfa:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/308032 pw_log_fuchsia: Update to new Fuchsia logging API Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed Rolled-Commits: 6427682ab7e3d0..b9f1c4d1d046ea Roll-Count: 1 Roller-URL: https://cr-buildbucket.appspot.com/build/8707510444079851409 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: Id3172b200d99c88efa5791f1fdd90be1424b2d2c Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/310515 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.