| commit | 6953267450f04a16f7b443a7dc1ca72b5672f3e0 | [log] [tgz] |
|---|---|---|
| author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Mon Nov 06 00:43:36 2023 +0000 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Mon Nov 06 00:43:36 2023 +0000 |
| tree | d4331ba68c35fd2cded3433bc43006b003e924c8 | |
| parent | 24c205d8155f87156bd7a97eb664250b32353c13 [diff] |
[third_party/pigweed/src] Roll 33 commits
1dc8cfcfe4b2565 roll: host_tools
c63c671f4119386 roll: 310, 311, 38, 39
cdc4f812189e16f docs: Update changelog
b08c5cfa8c95c8a pw_system_demo: Add clang to default stm32f4 build
5ae3ecbf4261cbc pw_emu: Fix CLI gdb and load commands
5eb5b51fb17e731 docs: Split the style guide: Doxygen & Sphinx
4e5595180701fcc docs: Split the style guide: C++
21eae82a9cbb993 SEED-0110: Memory Allocation Interfaces
af237dbf10c3843 docs: Split the style guide: commit style
9335766691d9ddd docs: Update module docs authoring guidelines
e1835d3d9149ec6 pw_rpc: Update Java service error with tip
20b5cd27bfe54bc bazel: Move Kythe copts to toolchain configuration
dcaf9148da1ad26 docs: Fix nav and main content scrolling
90f350d0ea40d86 pw_presubmit: Add basic CSS formatter
3cabebf8a147672 pw_multibuf: Add basic MultiBuf operations
3d96f77e48a58d2 pw_{hdlc,system}: Enforce use of CancellableReader
c841ecda9527cb0 pw_bluetooth: Add TODO for issue 308794058
fe0d15aa5841fc1 pw_emu: renode: Show more details when failing to
ef859eb5d832bb9 bazel: Move warnings to toolchain configuration
4ec74d4107594c3 pw_web: Limit component rerendering
050c2211536b89e pw_build: Add empty_cc_library
cde4af63efd7b35 pw_{log,protobuf,tokenizer}: Enable sandboxing for
54bd48f7fa02550 docs: Add udev instructions to Bazel Get Started
1c95672718137e0 docs: Add information on the experimental repo to
dd7d1407ce51298 pw_digital_io_mcuxpresso: Remove RT595 size def
99196c2972ba716 pw_allocator: Add size reporting
f48b7c0db427b8f pw_presubmit: Kalypsi-based coverage upload
55c0af095329ff5 bazel: Silence warnings from external code
a350fb5a873085d pw_containers: Update VariableLengthEntryQueue siz
f7ce76732615428 pw_tls_client: Update to new boringssl API
dd93fa16b9de0a3 pw_presubmit: Handle missing upstream better
20847156966b050 pw_fuzzer: Inline NonOkStatus()
4aef8392e114b11 pw_fuzzer: Fix instrumentation config
https://pigweed.googlesource.com/pigweed/pigweed
third_party/pigweed/src Rolled-Commits: 24bec3ca536ede0..1dc8cfcfe4b2565
Roller-URL: https://ci.chromium.org/b/8765220714974799761
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I5f757bc188b5e633d7ed4b0908e49d720cf23aa2
Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/179130
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.