| commit | 3191d0d7bf0930a2a32776ce012e67b19dd1f761 | [log] [tgz] |
|---|---|---|
| author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Mon Sep 11 00:43:46 2023 +0000 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Mon Sep 11 00:43:46 2023 +0000 |
| tree | 22ecf7dc3251b100dddc9cbf963d7aa1a50a9213 | |
| parent | 326c8f08c25e68056e66590971df77fb705f2221 [diff] |
[third_party/pigweed/src] Roll 33 commits add86809e72c1c6 roll: host_tools 9470353658be5df roll: absolute_uploader, incremental_uploader 2f4f1ea0dc56d36 pw_tokenizer: C functions for encoding arguments ee6dbf6430a28ce pw_varint: C API updates 76892a4afbbb45a pw_bluetooth: Add LELongTermKeyRequestSubevent Emb 6d6d5173af21984 pw_bluetooth: Add UserPasskeyNotificationEvent Emb f0da6aa28012b48 pw_log_string: Fix the default impl to handle zero dd91bceb163e0d7 third_party: Add public configs for FuzzTest deps b95ea6094ead876 pw_bluetooth: Add SimplePairingCompleteEvent Embos 8ec2b2d9452a5d7 pw_web: Fix TypeScript errors in Device files 85eb0fe4e12d948 pw_kvs: Remove usage of pw_log/shorter.h API d29d05a81164d71 pw_bluetooth: Add UserPasskeyRequestEvent Emboss d 5c83b40c060baa1 pw_build_mcuxpresso: Output formatted bazel target 60589fd364b45f1 pw_bluetooth: Add UserConfirmationRequestEvent Emb f5505073fa0b18a pw_cpu_exception: bazel build support 622dcbe04bc1fe7 pw_build: Force watch and default recipe names 31e31d0721cf00b SEED-0108: Emulators Frontend 9ebdcbda40013e4 pw_presubmit: Make builds_from_previous_iteration a49130e1cc50ca8 pw_package: Handle failed cipd acl checks c0af50196cc2585 mimxrt595_evk_freertos: Use config_assert helper 8af3cbcce3f0ff5 docs: Fix broken links c90c2ab93a012dd pw_unit_test: Add testing::Test::HasFailure() d29241fc48899fa pw_persistent_ram: Add persistent_buffer flat_file 9e60bfd06761ce9 pw_fuzzer: Refactor OSS-Fuzz support 0575b5904fa9435 pw_unit_test: Add FRIEND_TEST 7290e24df67d265 docs: Recommend enabling long file paths on Window 1db2bdcaf6f4e55 pw_tokenizer: Remove some unused deps d131218b316c4fb bazel: Fix lint issues after roll c146cb0908d2b57 pw_crypto: Add API reference 301126f4050a59b pw_varint: Add C-only implementation; cleanup a66031e1ef52feb pw_file: Add pw_file python package 34944891bc9bac4 pw_thread_freertos: Add missing dep to library c95739b4fb62732 roll: buildifier https://pigweed.googlesource.com/pigweed/pigweed third_party/pigweed/src Rolled-Commits: f29ef67144f72e6..add86809e72c1c6 Roller-URL: https://ci.chromium.org/b/8770294145974816513 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: If659cda62efd2c37df3452e03a233f9d8d905e2a Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/170291 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.