| commit | 5f53b1bd56068fa3b3834a2e651e023fb3f43f20 | [log] [tgz] |
|---|---|---|
| author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Mon Feb 26 00:45:27 2024 +0000 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Mon Feb 26 00:45:27 2024 +0000 |
| tree | 4aad411864e6807d88701d3e53351d4c8b7b0c92 | |
| parent | 2df7eb23b30d6b3429e9fb407d9d380a987243b3 [diff] |
[third_party/pigweed/src] Roll 37 commits
154897dd5f6d239 roll: gn
7a9b71ad0a5436e roll: clang
dcbf65b8a91ddaf pw_tokenizer: Add code size optimization to Rust i
510845caaaa2cdd many: Clean up Python proto imports
9c1540d84fb3aa8 pw_web: Create log store and enable download logs
ff074e72f67c37f pw_unit_test: Fix googletest backend
277297be6fea9fc bazel: Mark more targets testonly
ea6ef4f4f5bd82b pw_config_loader: Support custom overloading rules
4a4b17d29ec1087 pw_log: Fix the Pigweed Soong build
40fa6880873d75c pw_allocator: Make TrackingAllocator correct by co
e8c65f4cc0c1568 pw_allocator: Remove total_bytes metric
a5038affded6fea docs: Add breadcrumbs
97f12d317d2ef3d Revert "roll: clang"
5165b9c17a9933b pw_transfer: Add an android_library for the Java c
49808df458b1fa1 third_party: Roll FuzzTest and Abseil
853a9814ac52e9d pw_kvs: Follow new module docs guidelines
02ffd1ad2aa82a9 docs: Fix incorrect module name in changelog
1b6855609edc8c5 pw_transfer: Change class to parser
28c114d7b228a56 pw_assert: Apply formatting changes
31fee27f25a2332 pw_web: NPM version bump to 0.0.14
a4514bdc2d5b5dd pw_rpc: Remove use of deprecated Python API
01827d2c9302d1f pw_bluetooth: Add Emboss rules to BUILD.bazel
fb0e62a49c6dd76 pw_web: Enable multiple log sources
9a3bb012f2c6dc4 bazel: Remove shallow_since attributes
371015e36501c36 pw_{hdlc,log,rpc}: Add android_library targets
ce288f125447b66 pw_preprocessor: Do not check for __VA_OPT__ on ol
975a59eafba5f87 docs: Fix canonical URLs for all */docs.html pages
4d84f9fc0269f12 roll: clang
7e49f0b7f5e47ac roll: clang-next
b83c8ed0ce86ff9 pw_transfer: Fix integration test START packet iss
36b6a7ddb0c28b6 pw_json: Classes for serializing JSON
1ac49bcda648d72 pw_software_update: Add java build objects
fc92d636edcc491 pw_toolchain: Add missing #include
a438bf7f3271870 pw_preprocessor: Switch to Doxygen
8e87382862fa9df pw_preprocessor: Use __VA_OPT__ when available
68f37cc76f34908 pw_ide: Fix environment inference
5f27e8171fe5207 pw_package: Update GoogleTest
https://pigweed.googlesource.com/pigweed/pigweed
third_party/pigweed/src Rolled-Commits: a2b21f201273691..154897dd5f6d239
Roller-URL: https://ci.chromium.org/b/8755073847192411121
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: I615fecf98dbf38f9f4de7b186ed27e9d319dd663
Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/193853
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.