| commit | 50abd3600884a654793a252682b9fba92c051d1d | [log] [tgz] |
|---|---|---|
| author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Mon Jan 29 00:43:22 2024 +0000 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Mon Jan 29 00:43:22 2024 +0000 |
| tree | ccc47048a26e2092e0fc9dee5b70a0846ceb7135 | |
| parent | ca97c218b638f940796b554ca266334151dd674f [diff] |
[third_party/pigweed/src] Roll 40 commits 763cd05c56745c3 roll: gn f6956d5bd0d92aa roll: clang b2766fdb547f05d blob_store: Resumable BlobWriter 14f81124603a4c4 pw_multibuf: Add SingleChunkRegionTracker e0cdf4ebf152128 SEED-0122: Organize Pigweed code samples fa9b84d9739fe94 pw_symbolizer: Expose llvm_symbolizer_binary 0d068e1b005f616 roll: clang-next 6b853a8137d3b9d pw_unit_test: Add multi event handler and tests fo 894c1ef2adf2732 pw_emu: Add Android build files 9ab076f1168d562 pw_tokenizer: Add #[used] to token Rust database e 45be7b141b8be70 docs: Update changelog c1e43cba53c2bb8 pw_rpc: Add missing include d76921dcac884a0 pw_thread: Add missing include b16f3701d34c428 pw_allocator: Add SplifFreeListAllocator fuzzer 883b7fb0ccf1187 pw_preprocessor: Add integer-overflow macros 44f2e8f6671c4c4 pw_bluetooth: Add advertising packet content filte 7d620ba7b1b20f1 pw_toolchain_bazel: Remove deprecated action names fd017242b215fad pw_compilation_testing: Skip tests excluded by the 8510c7de9b84223 pw_presubmit: Add more info to todo summary cb2d8ae3fad591c pw_bytes: Fix compilation error occured with Werro 91075ebb2367073 docs: How to use a single Pigweed module in Bazel 853989651ead5f5 gitignore: Fix how we ignore bazel- directories 8a3a2c71f9b2793 pw_kvs/flash_partition: Add EndOfWrittenData() 0a2cf87b2c8d38e pw_toolchain_bazel: Migrate to type-safe action na 0092efffb4b57f2 pw_toolchain_bazel: Require action labels in provi 255e7102792f6f5 pw_tool: Delete module c00e9e430addee0 pw_tokenizer: Compensate for GCC template bug 76c38e54f2858c6 build: Use pre-release of rules_python 583824cfc85d7d5 pw_transfer: Remove duplicated Builder call 3791673ad2de05e SEED-0124: Claim SEED number acad2170df4937c pw_toolchain_bazel: Define actions names as labels 5a62e9ef5985020 pw_bluetooth: Add android multiple advertising emb 6cd2b50fbb796e4 docs: Add pre-reqs for non-Debian Linux distros 9568ef562643f6d bazel: Use Python 3.11 7732e056260a0e6 pw_toolchain_bazel: Make the pw_toolchain reposito 892cd9ab6eaf546 pw_protobuf: Fix another &*nullptr in test 2b6959a8ecd271d pw_bytes: Update documentation bc7e53c42364578 pw_bluetooth: Add a2dp remaining offload emboss st 40a14982a9506ad pw_bytes: SignExtend template ffc60786179e0c2 build: Use rules_python in Bazel build files https://pigweed.googlesource.com/pigweed/pigweed third_party/pigweed/src Rolled-Commits: 0380161bd68c216..763cd05c56745c3 Roller-URL: https://ci.chromium.org/b/8757610571129476257 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: I55448c45db0cbd16a0b91adeef5c6fec37f25d2d Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/189472 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.