| commit | a1d7378d0a6fbaffb8422c635a6a422d4f340a8e | [log] [tgz] |
|---|---|---|
| author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Mon Apr 08 00:44:25 2024 +0000 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Mon Apr 08 00:44:25 2024 +0000 |
| tree | 5fab6e3ce8912634db9ee3699ccb3daa6676c743 | |
| parent | 1f87c95a432a30716d0db4c8c6a2da27e5151968 [diff] |
[third_party/pigweed/src] Roll 31 commits
7ca22fc66b3aa3c roll: gn
1cbf2352b3e0b5e pw_bluetooth: Define LEReadMaximumAdvertisingDataL
c79856c8e746b08 pw_bluetooth_sapphire: Add arm64 release variant
517696e29810c51 docs: Mention that Windows flow needs admin rights
849d99bd97a5613 pw_presubmit: Include examples repo docs in docs_b
3f89c18fdffd43f pw_module: Jinja template refactor
6222b1097d11fb1 docs: Update reST style guide
c68babc5337f950 pw_async2: Add Poll::Readiness helper
ef7a6d3ac854bea pw_toolchain: Fix Rust GN host build
83816fda4ae0793 pw_module: Overwrite prompt with diff display
f54d93143ffd79c pw_async2: Fix TSAN for dispatcher_thread_test
d54f6c446cd85ec mbedtls: Avoid the use of unsupported libc functio
c3dfc3987262a43 pw_bluetooth_sapphire: Stub bt-host CIPD manifest
bab24b648730fc3 pw_{cli,presubmit}: Move plural()
d909f52cfaf5652 pw_allocator: Restore DoDeallocate with Layout
e701eb8e91eeb0e pw_{build,module}: Allow nesting Pigweed modules i
09d24b46231e82f pw_ide: Support comp DB search path globs
0540acc0b8bf0b1 pw_spi_linux: Move linux_spi from pw_spi to its ow
8a7744c250833e0 third_party/freertos: Fix typo in docs
0dafca3ccc0927b SEED: Reading sensor data
4aa0252e35b34be pw_result: Avoid duplicate symbols with Soong
30f64d3eedfbd31 pw_allocator: Move Layout and UniquePtr to their o
4f049a2e95df9ca SEED-0126: Claim SEED number
035f292d35a6918 docs: Organize the documentation style guides
2262ec0a0be4690 pw_allocator: Remove Layout from Deallocate and Re
f6d9544b2895948 pw_bytes: Add example to docs of using _b suffix
18442a7e69a5b1c pw_multibuf: Replace Mutex with ISL
3c2ef28caa5205f pw_{cli,ide}: Move status_reporter to pw_cli
f50d5dcf8166a74 pw_hdlc: Document members of router
f37576a00cd3542 pw_channel: Return status from PollReadyToWrite
990b5f8ea0be1cc pw_protobuf: Support full java protos
https://pigweed.googlesource.com/pigweed/pigweed
third_party/pigweed/src Rolled-Commits: a16cc4c5e5368f0..7ca22fc66b3aa3c
Roller-URL: https://ci.chromium.org/b/8751268782354625057
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I0741151f9a5015e1a26d86143c9564b07eb2381d
Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/202290
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.