| commit | 5a338b2b6dcecefd953bc50735cbb4490df81e45 | [log] [tgz] |
|---|---|---|
| author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Mon Oct 30 00:43:26 2023 +0000 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Mon Oct 30 00:43:26 2023 +0000 |
| tree | e3beced38e6bba5266b04722f5347c15c72012db | |
| parent | b0a0c477d6ed1a6360ad66ff57418b403580c4b7 [diff] |
[third_party/pigweed/src] Roll 45 commits
24bec3ca536ede0 roll: host_tools
4b24ec34f9b44c7 roll: gn
88aad83343c8b7a roll: 310, 311, 38, 39
87ce3c98de71f1d pw_string: Docs tweaks
1863631ae76c219 Bazel: stm32cube support
a74535c7d8b644d pw_bytes: Add _b suffix for byte literals
5bdcaf22dfa2995 pw_bluetooth: Remove anonymous entry in LEPeerAddr
ab4e275111ff336 pw_bluetooth: Separate LEAddressType and LEExtende
9aa8a037d67ac4f pw_build: Remove pw_build_default_configs_in_toolc
f50e8aa47fdcf24 pw_format: Correct crate name in docs
3652215bacf5393 pw_format: Move Rust format string parsing into it
53ad55011629ed7 pw_package: Use mirror for stm32cube
feab5389df0005a pw_allocator: Return Range from SplitFreeListAlloc
38b84d7e926aec5 targets/host: Change pw_assert_BACKEND
5cd05b6018478ec pw_{toolchain,build}: Apply pigweed_default_config
459a1826957c35a pw_log: Introduce backend_impl label flag
94e41edc059dd6c pw_libcxx: Add pw_libcxx library
7837bf3c86d47c0 pw_toolchain: Build compiler-rt builtins to replac
bd6266657485841 pw_assert: Update print_and_abort backend formatti
1355e5b8a5ad1e2 build: Drop C++14 compatibility from the build and
af57fad456ce3b6 Bazel: Remove most copts from pw_cc_library macro
7eb9df1b37c6a76 docs: Mention command for updating Py dep hashes
e6aa95bf08fba2b pw_env_setup: Pin pip and pip-tools
f3190dcd2b5a44c pw_arduino_build: STM32 Core fixes
aac7fab8fbb8d1f pw_bluetooth: Define LEExtendedCreateConnectionV1
a893425653d8c93 zephyr: Update checkout to v3.5
8febfab039bf0ee pw_build: Fix blob attribute ordering
5363b1f02a05690 pw_multibuf: Add Chunk::Merge
3964e532b2a7a11 SEED-0107: Update SEED references; fix typo
ddbc9fc7f5c601a third_party/nanopb: Detect protoc updates
a2dd3fbd45269c8 pw_allocator: Refactor SplitFreeListAllocator to u
556c19d670b9dc4 SEED-0116: Claim SEED number
65ab9e4fde35275 pw_multibuf: Fix TrackingAllocatorWithMemory UAF
96de268be9cd48f pw_bluetooth: Define LEEnhancedConnectionCompleteS
ae1e90eb632000a pw_rpc: Support DynamicClient with SynchronousCall
62da7d49d272099 pw_sys_io: Fix Bazel backends
332042a7748a0bd docs: Define facade in glossary
74cdfacb22b6246 pw_bluetooth: Remove padding from Emboss command d
bb1bfba2371738c pw_tokenizer: Let tokenizer prefix be configurable
90d97fa3b4292c3 docs: Remove symlinks to files that were removed
3f2ce7672ef5c6c docs: Mention upstream development guide in contri
22db84fc5868737 pw_unit_test: Pass verbose flag to TestRunner
88335d06bf8926d pw_package: Fix Zephyr URL
fb640c84662c744 pw_multibuf: Add module and Chunk implementation
24eef22e00e02fa pw_env_setup: Update protoc to 2@24.4
https://pigweed.googlesource.com/pigweed/pigweed
third_party/pigweed/src Rolled-Commits: fbb318aff82edfe..24bec3ca536ede0
Roller-URL: https://ci.chromium.org/b/8765854894212021985
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I72952bd3d8401c0bdf81e7424c0a2689999da12a
Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/178202
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.