| commit | 1c826945119bb0ed0b9cf5aee202c5544b1dd50f | [log] [tgz] |
|---|---|---|
| author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Mon May 20 00:44:11 2024 +0000 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Mon May 20 00:44:11 2024 +0000 |
| tree | 1a9b5bb2ebe9a190a64bae7e00f6f78646737b2c | |
| parent | e1036b9b41442313b93e0a9cc72550955c03eb4d [diff] |
[third_party/pigweed/src] Roll 50 commits 49dd44fcb1a0b68 roll: gn 19c5ce1182033b6 roll: 310, 311 eb7a4e724f6205f [fuchsia_infra] Roll 20 commits 894f848bccb6dbb rp2040_utils: Replace exceptions with logging efcc36b25be8339 targets/rp2040: Increase device_detector verbosity d8d48ae0cbd9574 docs: Update changelog 9c7d87957171705 pw_unit_test: Ensure alignment of test fixtures 969c75d77d2fbcf pw_transfer: Fix transfer_thread_test initializati 2e46e4ac3dfbbfc pw_config_loader: Remove unnecessary dep 1edf35a4ff1c563 pw_allocator: Add AsPmrAllocator 16fb026b93fcdad pw_rpc: Include FakeChannelOutput in soong target 7e07cfabb7a8768 pw_env_setup: Remove f-strings from github_visitor 770fffc2d741fc5 pw_transfer: End active transfers when RPC stream 3a93dbec943d0aa pw_config_loader: Add missing types dep fe3b300897488d8 pw_build: pw_cc_test.lib fixup dcbe39839b38dd2 pw_async2: Move PW_CO_TRY functions d1841fd3ddeb184 pw_env_setup: Change Bazel library name 68b69d497c6f47a pw_env_setup: Add GitHub environment visitor 994c87cecd4d9c5 third_party/freertos: Add CM3 support to Bazel bui 6393be463cc0815 pw_proto: Create genrule for raw rpc with prefix 843bd1cf3b198a4 pw_transfer: Add tests for GetResourceStatus 44c6eb538a67ad6 pw_env_setup: Bazel support for config_file 137e8b7fe7ade32 bazel: Ignore reformatting change in git blame 8c39d4026adc12f pw_presubmit: Auto fix unsorted-dict-items 6b1323857437a22 third_party/perfetto: Rename proto targets 7c4acea38d79a7f pw_toolchain: Fix typos in newlib_os_interface_stu 54a35ecd0d457ca pw_cpu_exception_cortex_m: Add error flag masks 42a82886e1fa154 pw_bloat: Add padding to utilization c7128f5797ce9d4 bazel: Fix unsorted-dict-items instances 1f9748d17b29edc pw_cpu_exception_cortex_m: Fix PSP unit test 9d5fa2aef16857b pw_toolchain: Add clang-apply-replacements plugin 5a5d85cf27c4421 [fuchsia_infra] Roll 13 commits 7ed020b6db73345 pw_bluetooth_proxy: Also support V2 of LE read buf 624978e6fb2f4fe pw_protobuf: Build common.proto with Nanopb+Soong 64b8f9177534bbf pw_sys_io_rp2040: Bazel build file update d3177c05eea8174 pw_docs: Add inline search to sidebar c1441316f6bfcc0 pw_bluetooth_proxy: Use LE read buffer event 51c17fb5e937755 pw_presubmit: Fix missing pico-sdk for docs_build cd07cc170ebc110 pw_toolchain: Support Rust toolchains in downstrea 077ce0610af5305 third_party/perfetto: Add third party perfetto rep 042145933488ae0 pw_async2: Add Coro<T> coroutine API bfcaab8edf331e4 third_party/perfetto: Copybara import 170ad30163fb5ab pw_transfer: Add py_proto_library target for updat f55e8b048419481 targets/rp2040: pre_init and freertos config 430a4df2aea9b2e pw_transfer: GetResoureStatus fix missing return 158200d25a8562f pw_spi_mcuxpresso: Add responder implementation b6a1c89349d9ee5 pw_dma_mcuxpresso: Module for working with NXP DMA 07f748073e5aa65 pw_unit_test: Add missing :config dependency for g c004a95cf667642 pw_result: Fix typo in template member 8d2fdc5ed1aa017 roll: go https://pigweed.googlesource.com/pigweed/pigweed third_party/pigweed/src Rolled-Commits: 8fefe0c2a5a34c8..49dd44fcb1a0b68 Roller-URL: https://ci.chromium.org/b/8747463710521109009 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: I52e3c136064f1eb5dffc650edf280626b6abf58f Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/210491 Bot-Commit: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> Commit-Queue: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> Lint: Lint 🤖 <android-build-ayeaye@system.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.