| commit | 1d67074b60fc9393335da7ac6bf666ba045edba8 | [log] [tgz] |
|---|---|---|
| author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Fri Jul 28 17:20:13 2023 +0000 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Fri Jul 28 17:20:13 2023 +0000 |
| tree | c3c708b1a39c07dab14708dd8bf0f28948927ed0 | |
| parent | 07d999057f9eeb86be6ca0bab798bf0065162580 [diff] |
[third_party/pigweed/src] Roll 53 commits
50925b562f5fff3 pw_presubmit: Add ifndef/define check
28b70a038345ba9 pw_containers: Doxygenify pw::containers::Filtered
decf14dbacac80d pw_containers: Support copying the FilteredView pr
4341d7b31e90c9d pw_cli: Make pw_cli tab completion reusable
f5c2f22d37e0aea pw_interrupt: Tidy up target compatibility
d4215d0554f6408 pw_interrupt: Remove cpu-based backend selection
08f63ed0c1bb9aa bazel: Add host_backend_alias macro
ac97d24514bec1c pw_env_setup: pw_build: Disable pip version check
b8363e324f4258d bazel: Fix missing deps in some modules
a31f520483f6d4f pw_cli: Print tab completions for pw commands
dd52ac781d9893f pw_interrupt: Add backend constraint setting
5fff2c3fef8e88a pw_log_rpc: Explain relation to pw_log and pw_log_
d2dbd7b292b7f8d pw_rpc: Create client call hook in Python client
c8024eea6dedb8f pw_toolchain: Test trivially destructible class
9fb0ba4a38bf596 pw_package: Add picotool package installer
7db78523ff059c7 pw_digital_io: Doxygenify the interrupt handler me
598599c0d244839 pw_{console,hdlc}: Detect comms errors in Python
3b68c84d2909ecf pw_build: Upstream build script fixes
c0bcf5adae9ee7b pw_sync: Improve Borrowable lock traits and annota
10eb559000cfb5d pw_build: Add pw_test_info
8270c58a25e7d1b bazel: Support user bazelrc files
8451a05b3362a81 rust: Add rustdoc links for existing crates
601f070ae1d8ba5 pw_cli: Fix logging msec timestamp format
e1b56dbcd84a836 python: Remove setup.py files
895aaa03a847bca pw_bloat: Cache and optimize label production
f9baecd1044c6db build: Add Rust toolchain to Bazel macOS build
cdf958f1ed0ccd7 pw_build: Upstream build script & presubmit runner
70a124c4634a946 pw_build: pw_watch: Redraw interval and bazel step
58119f625055d42 pw_env_setup: Add docstrings to visitors
3ab03722caee67c pw_env_setup: Sort pigweed_environment.gni lines
e7488c09099a958 pw_chrono_freertos: Update SystemTimer comments
1c86969fd424fe4 pw_containers: Improve FlatMap algorithm and filte
2c9efc96d6ba638 pw_docgen: Add rustdoc linking support to pigweed-
785682ce0a3e86e pw_presubmit: Remove deprecated gn_docs_build step
0889de69c640669 pw_toolchain: Make tools use relative paths
f04f934b3c69910 pw_presubmit: Fix issues with running docs_build t
67c87c7fe8f129c build: Mark linux-only Bazel build targets
86d80d6921dffc8 pw_base64: Doxygenify MaxDecodedSize()
e171f29b7d61f05 pw_stream: Fix Doxygen typo
5e70fc18053d41f pw_docgen: Add extension debugging instructions
6a99259953c9933 bazel: Update rules_python to 0.24.0
ed01e19308cd8ac pw_{i2c,spi}: Standardize naming on initiator/resp
7c2db61b792479a pw_i2c_mcuxpresso: Allow for static initialization
5fd8cf288fa857d pw_env_setup: Mac and Windows Python requirements
3f8d519b1f597eb pw_env_setup: Add more Python versions
37e821f8beff560 pw_env_setup: Remove python.json from Bazel CIPD
d92d02f1a25cd6b pw_env_setup: Redirect variables from empty dirs
213640f04755cad pw_env_setup: Split Python constraints per OS
eec910d37e6c5e6 pw_allocator: Doxygenify the freelist chunk method
3fb983d9e8f95cd pw_stream_uart_linux: Add stream for UART on Linux
e89ac8201c40a93 pw_bluetooth: Add 3 Event packets & format hci.emb
2ddb378fedc39f3 pw_env_setup: Add --additional-cipd-file argument
97c6a1079c65b9c roll: go
https://pigweed.googlesource.com/pigweed/pigweed
third_party/pigweed/src Rolled-Commits: f4d0b3563c09d94..50925b562f5fff3
Roller-URL: https://ci.chromium.org/b/8774308300781842433
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I681e108b015ffc3eb4300fb5b72ed3be7e58a2e0
Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/160323
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 bootstrap script will automatically initialize all submodules.
$ source bootstrap.sh $ 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.