| commit | fcf5270c67c432897364f300b263d7c3bcff964a | [log] [tgz] |
|---|---|---|
| author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Mon Oct 16 00:43:43 2023 +0000 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Mon Oct 16 00:43:43 2023 +0000 |
| tree | f7ac664624b3e6d464a3afc3922a9cc2599adff3 | |
| parent | 78f3b3105cb0a3d5648090ac948edeff684f8bb5 [diff] |
[third_party/pigweed/src] Roll 42 commits 18e1276003f5be9 roll: host_tools cc68af7c8353c8a roll: gn a5e6fa66e90950e roll: absolute_uploader, incremental_uploader c9a0c563fb6416e roll: 310, 311, 38, 39 19a0282cf752c14 pw_sync_zephyr: Add TimedThreadNotification::try_a c30e6cfa39b8394 zephyr: Allow direct CMake inclusions c83ead5f66e734b docs: Add hat tip for pixel doubling technique d86fd5b4cde0195 pw_async_basic: Add missing include 525276182e17bed pw_async: Add CMake support 842b24454f8c719 pw_emu: Add user APIs and the command line interfa dd397f9ee513ede docs: Start eng blog and add Kudzu page 80a54bb67f71ff9 docs: Add Pigweed Live directive f7e64dbf9ee4523 pw_tokenizer: Expose linker_script in BUILD.bazel c94fa6121ed3918 Bazel: Don't autodetect C++ toolchain 4d49a384075f039 pw_presubmit: Add note about --full and --base fc536d5327370cd build: Update Android.bp bcb799fdc7430c4 Bazel: Add O2 to arm_gcc toolchain 3b86a16ef93997a docs: Add builder viz to CI/CQ intro a96389142d68f63 pw_web: Fix invisible jump button 913f56cfd0ae11a pw_emu: Add core components 462a39c178dba43 pw_emu: Add Emulators Frontend module boilerplate de8254e82533bfd pw_third_party_freertos: Add arm_cm7_not_r0p1 0c7c1eb7512448e docs: Fix link e21a6c71608febe SEED-0114: Claim SEED number c8dfc2f6700a084 SEED-0113: Claim SEED number f8ecf3723f8d723 pw_minimal_cpp_stdlib: Support additional librarie 72956ad8ff68d06 pw_chre: Remove TODOs for CHRE MacOS support 526a60857f758c2 SEED-0105: Add nested tokens to pw_tokenizer and p 93c408d521c3065 pw_spi: Fix cmake integration 000c081d9124e16 targets/rp2040_pw_system: Enable time slicing ca846e3d2a90451 pw_env_setup: Add prpc 15d4c869cd9eff3 pw_log_zephyr: Clean-up unused dependencies from T 45973d204731382 pw_minimal_cpp_stdlib: Add Zephyr Kconfig to enabl 754739c7d51cf2d pw_thread_freertos: Fix extra wakeups when detachi 0e403d6a58aaf54 pw_hdlc: Update Python RPC documents 1df29eb1485fe1a *: Update formatting for new clang version dc8f049b53591d6 pw_system: Add option to pass logger to Device 319a792bbb62b76 pw_allocator: Fix SplitFreeListAllocator region al 456f8fc827ca2eb pw_package: Update boringssl commit & skip clang-t 35b18fef499e7b2 docs: Add changelog highlight ddbba2a3dd70f10 SEED-0109: Communication Buffers 666f31b024a52c8 roll: go https://pigweed.googlesource.com/pigweed/pigweed third_party/pigweed/src Rolled-Commits: 04e61c8160c5a6b..18e1276003f5be9 Roller-URL: https://ci.chromium.org/b/8767123253790643665 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: I74721ee13039feaa7136f9a17d77c7997e1a2f90 Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/176190 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.