| commit | 27cb475062a9c9cdbf1cf3655b2f6576ae61b227 | [log] [tgz] |
|---|---|---|
| author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Mon Jan 15 00:43:31 2024 +0000 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Mon Jan 15 00:43:31 2024 +0000 |
| tree | f2c38b7631e4a34f992238d9281a2c521634e863 | |
| parent | 8a2099b67e52c246c03b167906e00c1294b37ba3 [diff] |
[third_party/pigweed/src] Roll 48 commits
9640cdef100f87d roll: gn
cace272e9216279 roll: qemu
41b455bcbc7d49c pw_env_setup: Retrieve qemu on ARM Macs
a587c5eebced9d3 pw_presubmit: Exclude docs on Mac ARM hosts
4c95093e6f39f4a pw_build: Add pw_cc_binary variant to generate .ma
d06ec146fbe683d targets/host_device_simulator: Update docs
ed3b51b88ff6246 pw_digital_io: Remove conditional interrupt disabl
aadaf20b356323a docs: Update changelog
13739dabe1a3881 pw_build: Introduce default_link_extra_lib
68af5d8f586dbaf docs: Merge first-time setup guides into one page
420672d94c74c53 pw_tokenizer: Remove <assert.h> include for static
a29bf57c735c7c7 pw_span: Follow new module docs guidelines
856491408766e7d pw_ide: Fix VSC extension build command
749043357bc3303 pw_ide: Improve Python `--install-editable`
06aca398f331735 pw_toolchain: Enable thread safety warnings for ba
f6cc07b4dd431e2 SEED-0122: Update status, facilitator
cba4fdeaa2e16f9 pw_presubmit: Remove transitional coverage upload
7235731565cecea build: Add --verbose_failures to .bazelrc
12690fbff8b1271 pw_tokenizer: Directory database docs fixes
12298dc69496227 pw_presubmit: Fix codesearch coverage type
2bc58521173f81e pw_presubmit: Allow multiple uploading of coverage
6d2b92a0ec93430 pw_web: Fix autoscroll when window is resized
5affa0741d71b17 bazel: Update to Bazel 7.0.0 release version
b768cc015332fa3 pw_rpc: Have Method optionally store it's MethodTy
ce1ac38beaa1a2d pw_ide: Add Jest testing to VSC extension
72807ee86c32b61 pw_ide: Make VSC extension enforcement an option
ba479cf9a61c9a9 SEED-0001: Fix typo and formatting
f0732862b312cef pw_rpc: Run tests with completion callback config
51936c939a01ab9 docs: Add example of conditionally enabling code b
d3c6af1625f3e77 SEED-0114: Fix Compiler Explorer link
d9721a5c7adc7ed pw_toolchain: Remove duplicate config from Cortex-
1acfec029f8d3d8 pw_doctor: Fix overridden package check
a45e16f5e308f59 pw_toolchain: Add -fno-ms-compatibility to cflags
9125bcd82d833b9 pw_env_setup: Update ref to bazel version file
895905bc294b6d9 pw_protobuf: Fix bool overflow
bec5c822b4e5268 pw_protobuf: Fix nullptr dereference in fuzz test
d9d109c30c39a85 pw_allocator: Fix source file list in soong rule
3eb57d69e29fa27 pw_protobuf: Don't crash on invalid field number
646551493f985ed SEED-0122: Claim SEED number
92fe74d2b7e6a42 pw_{log,system}: Let Device accept logger adapter
a00ec41003c70cc pw_env_setup: Drop reference to rust version file
9933e458c6375f7 pw_tokenizer: Fix undefined dereference in fuzz te
39aca01d21fb858 pw_stream: Make stream adapters use reinterpret_ca
e4224c5161e81d6 bazel: Add module configuration support
9d38561541ad6e9 pw_thread_stl: Don't allow std::thread::detach() o
35f08d7210aa502 pw_protobuf: Fix conflict in messages with fields
b2ced3bf20c155c pw_protobuf: Properly fuzz nested encoders/decoder
45cb7d8f37b60fc pw_bluetooth_sapphire: Advertise FCS Option
https://pigweed.googlesource.com/pigweed/pigweed
third_party/pigweed/src Rolled-Commits: cbbc73dc4d56bc2..9640cdef100f87d
Roller-URL: https://ci.chromium.org/b/8758878927677971921
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I88f4332bf7a5cc0829cce673d0be0aa5c679d2d3
Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/187931
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.