| commit | 68e73a638b15b9bbe4cf33028194c60d5e006ed9 | [log] [tgz] |
|---|---|---|
| author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Mon Jul 08 00:43:59 2024 +0000 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Mon Jul 08 00:43:59 2024 +0000 |
| tree | 9f3dc028a1d911fcfece40c81df2589c3c699207 | |
| parent | 9f28de3c1e6533aa32bca493192863c6bf124391 [diff] |
roll: third_party/pigweed/src 31 commits 434ae75c94cbd00 roll: cmake ca9cf97101655f2 third_party/mbedtls: Remove old build file 9ea805fc87d0853 pw_cpu_exception: Remove multiplexers 1fe2f388a99a60c third_party/mbedtls: Rename build file d4308f754669e92 pw_rpc: Update docs 1643306da16c9b2 third_party/emboss: Add missing ir_data_utils.py t db3b2adb2df73dc bazel: Provide backend collections as dicts 4a79fe82a35e6b8 third_party/emboss: Update emboss to v2024.0702.21 4749e232d808939 pw_trace: Remove backend multiplexer f219e65ac4075ab pw_bluetooth_sapphire: Refactor LowEnergyScanResul 5c3289c29896ea2 pw_web: Fix columns on first load 3bce472d07ecae8 pw_async_basic: Fix size report build error 4066416d3c4eb7d pw_assert: Split up Bazel assert backend, part 1 c927404b863ed9f pw_web: Debounce grid template calc on resize 97438c6e8344be2 pw_digital_io_rp2040: Add pull up/down resistors t bfaf596d3e1231c bazel: Roll out incompatible_with_mcu c703cce68d0d061 pw_bluetooth_sapphire: Refactor TxEngine to allow 877418cbee51ee1 pw_bluetooth_sapphire: Add incoming CIS request ha ed07e6a0fe91aca pw_bluetooth_sapphire: Add IsoStreamManager class 0542d0d5b6b4b36 pw_bluetooth_proxy: Remove unneeded PW_EXCLUSIVE_L 4879c3176e7668e pw_bluetooth_proxy: Soft transition to SendGattNot 554f6366c6d05c8 pw_bluetooth_proxy: Add ProxyHost/AclDataChannel:: aaa79654cd8c74d pw_bluetooth_proxy: Dedup NOCP construction in tes 514c000421901a1 targets/rp2040: Fix build command in docs c370e1da8ce32c9 pw_thread_stl: Change NativeThreadHandle to ptr 0ce37b58c597d83 pw_bluetooth_proxy: Document which events are expe 947d85d964b002e bazel: Introduce incompatible_with_mcu 324824be015681a pw_bluetooth: Format emboss files 9324fd3b8eec8bb pw_bluetooth_sapphire: Add CIS events and commands 4fd97f5fc4ae5dc pw_bluetooth_sapphire: Retrieve sleep clock accura 194c43b97cef496 pw_bluetooth_sapphire: Fix LowEnergyScanner crash https://pigweed.googlesource.com/pigweed/pigweed third_party/pigweed/src Rolled-Commits: 0bff625d0768fe8..434ae75c94cbd00 Roller-URL: https://ci.chromium.org/b/8743024459684180033 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: I9283aefedb53d8ea8995e32409d17a5f5dd03d88 Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/220411 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 $ 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.