commit | 4069e6e99c3371e5c4e5bc8fd32aceb51eb446a5 | [log] [tgz] |
---|---|---|
author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Mon Mar 11 00:43:34 2024 +0000 |
committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Mon Mar 11 00:43:34 2024 +0000 |
tree | 5734d8e09d5a03eeaa6ca0acb3cb566ae755b16d | |
parent | 9ff0ddb86c3357763027bcb176e082f5ce179a67 [diff] |
[third_party/pigweed/src] Roll 47 commits 1f12d06f5133a9a roll: gn 16ef8365a740635 roll: ninja 181d4e5bc6059aa pw_bluetooth: Add H4 packet indicators in emboss a3626d8e20bd74b pw_allocator: Remove erroneous quotes around tagli e90b28ad25c613b pw_transfer: Fix Java client timeouts in terminati 163b0286505f68a pw_allocator: Refactor code size reports 38da87de52333c3 pw_multibuf: Add SimpleAllocator 8f232f68faa1d72 pw_watch: Add emboss files to default watch patter 4f40cc5c1e596f4 pw_polyfill: Detect C23 6610d86a58f71d9 pw_allocator: Remove metrics.cc 92e710323451892 pw_allocator: Fix move semantics for UniquePtr e4548430290ecd3 pw_libc: Include sqrtur and expk in stdfix 5730ca17f6c7845 pw_bluetooth: Reformat l2cap_frames.emb 07e95885dab7ddd pw_allocator: Refactor docs 3f8b108f7124003 pw_allocator: Make metrics configurable 01f704a974aa98c pw_env_setup: Update CIPD rust version df32be4ec5003b9 pw_tokenizer: Refactor Rust hash code to allow mul 64f74b46f6ad258 pw_bytes: Add Rust helpers for contcatenating cons 6de3886721711f0 pw_rust: Tweak docs for Rust tokenized logging exa 232f7deb24cc9a4 docs: Update changelog 7cf520f32b42a01 pw_watch: Add bazel files to default watch pattern 601edba48e579d4 Revert "bootstrap: Warn about Windows case-sensiti 8dcf8a563470945 pw_blob_store: Set module name to BLOB f247de63b15372f third_party/freertos: Tidy up Bazel build 7fd77555601719b pw_log: Fix stdout race in println_backend_test_te 081fda08421df2a pw_proto_compiler: strip_import_prefix + options 8a6f44e41e80bf8 pw_build: Remove FUZZTEST_OPTS aaf126b137a6c24 pw_unit_test: Update docs dc5ef2e7790bfa5 docs: Add protobuf style guide 64bfe3952506478 pw_log: Add tests for Rust printf and println back ee60eb2ee49d19b third_party/stm32cube: Build template formatting f bc2a4e4cbcf4b94 pw_transfer: Respect user-specified resource size 2c13ea8f2033a76 pw_presubmit: Remove unused presubmit step 2c1ea5ca55a6136 pw_module: Remove README.md check 8425ed014a4751b bazel: Update rust_crates in Bazel WORKSPACE 4f37a0bd3126b44 pw_multibuf: Add MultiBufAllocator interface 710f2337bfb925c pw_digital_io_linux: Introduce new module 45fab0df4aca712 third_party/freertos: Create Bazel build template d551c36e7bb5799 pw_rpc: Expose CloseAndWaitForCallbacks in client 70708e6ee084070 third_party/emboss: Support latest version of Embo 385a1e4a5585ba2 many: Unrecommendify 2dbe2a2755d5079 pw_string: Add ToString for Result and Poll 8ea97acdb603f7b pw_toolchain_bazel: Apply more common attrs to cc_ f62f5f97e34fc05 docs: Clarify that Pigweed doesn't support msan f29922999ef1ebb pw_async2: Address post-submit comments 89f5a3abe8f43f2 emboss: Add CMake support for emboss 7b799c29f0f0522 pw_transfer: Temporarily disable broken integratio https://pigweed.googlesource.com/pigweed/pigweed third_party/pigweed/src Rolled-Commits: ea93eb586cad181..1f12d06f5133a9a Roller-URL: https://ci.chromium.org/b/8753805497109164161 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: I6295fb72cced8f9f0a86de6ecfefca996eb2a89c Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/195693 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.