| commit | 0028ac547841feee4c9df47deddc406de72f9a7b | [log] [tgz] |
|---|---|---|
| author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Mon Nov 27 00:43:34 2023 +0000 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Mon Nov 27 00:43:34 2023 +0000 |
| tree | bd1d80ccac40d9082b4a008b85807428e223dfcf | |
| parent | 90ce0250e8fa4af1ee8c725e92de8b574cfadef8 [diff] |
[third_party/pigweed/src] Roll 26 commits 8b5d45a34aa2d4b roll: gn 4f55cd893c39b21 pw_rpc_transport: Unblock sockets when stopping 5d6c8774460f969 pw_transfer: Don't "block-network" by default 8ac986c74c35d73 pw_perf_test: Rename logging event handler files 4b364904cfc955c pw_transfer: Use StatusCode in integration tests 72fbddaec144309 pw_allocator: Improve heap poisoning configuration 8c14e34c768452a SEED: Generate the SEED index table 764ed8f3950766c pw_bluetooth_sapphire: Use explicit constructor fo 9e204659334a44a pw_bluetooth_sapphire: Follow pigweed style for te a4b7366b78abfc3 pw_perf_test: Rework docs 0c7d8aaf023b6b9 pw_transfer: Make integration_test_server testonly fdc60cf2bd0f4c7 Revert "pw_bluetooth: Update all commands and even 5137292e08ea5fa SEED-0118: Claim SEED number a8bf01aab9b8a23 bazel: Rename Python toolchains 6c2b186c7fcd088 SEED-0114: Channels 0ef8bdcbde8b7a6 pw_bluetooth: Update all commands and events to th 3bf61f1d7c0c21a pw_bluetooth_sapphire: Add OWNERS file 3aff8a3ef73ffde pw_bluetooth: Fix LEExtendedAdvertisingReportData 431faf75b7b6052 bazel: Remove py_proto_library wrapper fddeb6c56f90d9e pw_toolchain_bazel: Mirror features to be flag set 2997df7c3ad7ce6 pw_system: Add missing dependency on pw_trace f41e118cbb24bbb pw_transfer: Tag integration tests block-network 2a963a07cfa228c pw_bluetooth_sapphire: Delete unused build file 6a45a6e8af6a171 bazel: Use py_proto_library from rules_python 5a3735537697d02 pw_presubmit: Add Fuchsia style to todo_check_with 3623b95aac6bcc7 roll: buildifier https://pigweed.googlesource.com/pigweed/pigweed third_party/pigweed/src Rolled-Commits: 5d8f62aff08aa9f..8b5d45a34aa2d4b Roller-URL: https://ci.chromium.org/b/8763318179908801729 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: I67f671b6bd36b851bb77e3d1c7bf1c223ff76dc3 Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/182590 Commit-Queue: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.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.