| commit | 4144e0cc9aa06795b6fd5ed0e1eddd023a33581f | [log] [tgz] |
|---|---|---|
| author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Mon Aug 19 00:45:11 2024 +0000 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Mon Aug 19 00:45:11 2024 +0000 |
| tree | 0c01e4e46cd37823aae5ce2179c36b2ff5c70455 | |
| parent | 810c2f59877933d43df8f29c111ead9c5ad8031f [diff] |
roll: third_party/pigweed/src 47 commits 75c1501bcf4bbb4 roll: rust 704a5f3dde6a006 pw_spi_linux: Remove linkage specification from cl 7654e112c63755f *: Change typedef to using d97c1620775ac5c pw_unit_test: Delete unsupported C++14 compatibilt 9b242113ab06e86 pw_kvs: Remove unnecessary Key alias and test 5e9e39285969463 pw_bluetooth: Add create connection cancel return 52fbfafaaad91e3 pw_build: Make pw_load_phase_test host only 39884c8c26fdc71 pw_status: Convert StatusWithSize to Doxygen 42cea59a620c8ee pw_status: Remove StatusWithSize::size_or() 92a0165ff5ef8d5 pw_rpc: Limit maximum stored responses in Python c ae0fb106e128a26 pw_rpc: Remove deprecated / obsolete features 2e5bb7f84aa7885 pw_rpc: Fix open in callback_client 35c221facea3abd pw_rpc: Merge PendingRpc and RpcIds 19cb9e4e638df8c OWNERS: Add davidroth@ 0975df55750a15e docs: Replace 'bazel' with 'bazelisk' 3dcd6003bf2a0b2 pw_kvs: Pass EntryHeader by const reference 010825d4c23dfd7 pw_display: Color library 56ac0e66cadfd5d docs: Update Sense flashing instructions 63604e695b9f10f pw_system: Add type annotation to pw_system.device 5edaf2937867cf9 pw_system: Update Device ctor to take Iterable of c92db29cf08b886 pw_display: Create module directory 52eee724aa78c0b pw_tokenizer: Remove unsupported C++11 and C++14 c cc28da19bce99eb *: Handle ignored status comments 5b3ea9c27679176 pw_ide: Support different workspace root c0a295853427126 rp2040: Remove references to b/261603269 0a3c5bd1614399c targets/rp2040: Add -fexceptions for the rp2040 PI 3d7d7635281155e pw_transfer: Always set protocol version in final c9d5bef2f82612f pw_package: Use bazel to build picotool package 14b586f99ceae20 pw_async2: Create OnceSender & OnceReceiver cc53189f14208ac pw_preprocessor: Expand comment for PW_PACKED d33bfc0c1620bdb pw_rpc: Require an output function for channels 7ef5e1f643b8439 pw_kvs: Move inline variable definition to .cc fil e011157a9cb05a0 pw_unit_test: Fix multi-line test macros c59ef96f75b79fe pw_bluetooth: Add LEReadSupportedStates emboss eve c3e84e4dac07a8b pw_bloat: Support custom bloaty configs in CLI com e45b2e6e9d351c1 pw_build: Add glob_dirs() Starlark helper c75557d48defde3 pw_async2: Remove accidental macro #undef 1ee458eab8a52d3 emboss: Remove -Wdeprecated-copy from public_confi b572688d1fd4b02 pw_ide: Disable Bazelisk auto-activation by defaul d1e7bbafe816dd9 pw_module: Fix OWNERS file parsing c75f089ca800163 emboss: Update emboss to v2024.0809.170004 7f624d1cf275454 pw_bluetooth_sapphire: Add common bt-host clang wa 66015431cb14693 pw_bluetooth_proxy: Release H4 buff on error 8bb7ae67e611a10 pw_bluetooth: Add HCI Command OpCode definitions 9686a7d166465d2 pw_bluetooth_sapphire: Add new emboss compiler fil 7ee36ee92d4d953 pw_bluetooth: Add more emboss definitions 17252280da5edda roll: go https://pigweed.googlesource.com/pigweed/pigweed third_party/pigweed/src Rolled-Commits: 32744f590fac430..75c1501bcf4bbb4 Roller-URL: https://ci.chromium.org/b/8739219386338213313 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: I42f8ee7e093b2dea4e5e9b9072fc5c80f594ed05 Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/230514 Commit-Queue: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> Lint: Lint 🤖 <android-build-ayeaye@system.gserviceaccount.com> Bot-Commit: 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.