| commit | 8a2099b67e52c246c03b167906e00c1294b37ba3 | [log] [tgz] |
|---|---|---|
| author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Mon Jan 08 00:44:14 2024 +0000 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Mon Jan 08 00:44:14 2024 +0000 |
| tree | cd4d658f26c08d89dfe8753cbfa93a259a8e4047 | |
| parent | 2b174ec2140e14e9de4b0ebc42ac4b7bd589863d [diff] |
[third_party/pigweed/src] Roll 31 commits cbbc73dc4d56bc2 pw_bluetooth_sapphire: Refactor method and variabl cf3b22028e27a90 docs: Mention pw format tool 918f5567a15eb8d pw_allocator: Fix MulitplexAllocator's deps eda60374071f531 pw_bluetooth_sapphire: Revert commits to get to a ddd83095d16e9e8 pw_rpc: Add some missing deps in Bazel targets 0d3bc4cadce10df pw_containers: Remove DestructorHelper from vector fe8e3d2b5eda051 pw_allocator: Add extra bytes to Block 877273458e68466 pw_allocator: Add initializing constructors a8c971304f5c6f5 zephyr: Link pw_thread.sleep with appropriate kCon b8242a102440067 pw_allocator: Add note to AllocatorMetricProxy tes fed83a673aa0630 pw_emu: Remove psutil dependency 8d9da580a07cba7 bazel: Remove pw_cc_library af9badd2ffc93c0 pw_protobuf: Fully qualify message namespace d7660411ec0d621 pw_env_setup: Use correct arch for cipd in Bazel 346402f70e8f878 bazel: Remove references to pw_cc_library 4559b52b5d2f564 pw_multibuf: Add soong support 33ff80f6cc3c02a pw_env_setup: Switch to Fuchsia ninja CIPD package fee3e609802fe3f pw_log_zephyr: Add missing include for tokenized l 3887ec9bd906adf pw_ide: Support alternate `clangd` paths 77dbd41823c7ae3 bazel: Replace pw_cc_library with cc_library 9fb521d2c89fad9 pw_ide: VSC extension 0.1.2 release 788d6b60eb323a9 pw_ide: Fix CLI command docs 5a1bf6af624961d docs: Update changelog 96de184564d918e pw_ide: Allow submitting bugs from VSC a65bd44de1de9a1 pw_ide: Document `compdb_gen_cmd` 84e2bf6f82c9527 pw_unit_test: Fix sanitize(r) directive cbe50f75e2ca9de pw_ide: Improve VSC extension UX c09ca7786d475d2 pw_env_setup: Prevent NPM output from interrupting a49938f32d4beff docs: Rework first-time setup 3e12ae03b72ab8e pw_tokenizer: Make Rust hashing function const d7d4dccfa5a43c9 docs: Add troubleshooting section to Bazel quickst https://pigweed.googlesource.com/pigweed/pigweed third_party/pigweed/src Rolled-Commits: 355d7079513c703..cbbc73dc4d56bc2 Roller-URL: https://ci.chromium.org/b/8759513107260631633 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: Id9ab0f7e7b175aaaf47d2db703a35a7282ec3ec2 Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/187031 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 $ 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.