| commit | 49d5b712a28186c55d13256d0bc65e943b8a7b05 | [log] [tgz] |
|---|---|---|
| author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Mon Aug 21 00:44:12 2023 +0000 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Mon Aug 21 00:44:12 2023 +0000 |
| tree | 5b49558b5c62b9efc247c3b176cbb72fccb2e189 | |
| parent | fe2137b0b75f32024819aa89c31f1d2273767698 [diff] |
[third_party/pigweed/src] Roll 44 commits e8a541f8a5f8e10 roll: host_tools 696e7bebf174212 roll: absolute_uploader, incremental_uploader 1b80d6056dce333 roll: 310, 311, 38, 39 b55d71fb623e5ee roll: cmake 17b2aeb98f59c72 pw_web: Add jump to bottom button, fix UI bugs and 32009f25a629a5d pw_rpc: Various small enhancements 10f09568e72d08d pw_build: Fix output_logs_ unused warning 7b76986c75e38b2 pw_toolchain: Add Linux host toolchain 7d49faa31bff81b pw_toolchain: Use CIPD provided Rust toolchains b4eae48950b64b9 pw_containers: Silence MSAN false positive in pw:: b16672062c028e1 pw_bluetooth: Add missing test dependency 19a93dc88581075 pw_console: Update web viewer to use pigweedjs 31c8f3563e01630 pw_ide: Make VSC extension run on older versions ab38cec3dd7d554 pw_rpc: Remove deprecated method from Service a898f29d6e177db pw_rpc: Prevent encoding failure when dynamic buff 5f6d2fcd7ec9b1c pw_tokenizer: Fix instance of -Wconstant-logical-o 8df5682fd2b031f pw_bluetooth: Add new hci subset files e6188f496ab96ca pw_rust: Update rules_rust to 0.26.0 2fb5bc26c9acede pw_bloat: Fix typo in method name c15dfa73e84c8d7 pw_env_setup: arm-gdb: propagate errors d1bb1fa109d221d pw_web: Implement advanced filtering 6d40f25448cc833 pw_hdlc: Use explicit logger name 9f56449292f686e pw_unit_test: Reset static value before running te db314ef0d07942b pw_build: Don't include compile cmds when preproce af5b42db29280e4 pw_env_setup: arm-gdb: exclude %VIRTUAL_ENV%\Scrip 47b9698d116acec pw_build: Add pw_python_venv.output_logs 7a1f6a44c4cad95 pw_toolchain: Switch macOS to use builtin_sysroot 76c50230960c14f SEED: Update protobuf SEED title in index 12e4138288a0f15 pw_tokenizer: Add Rust support 3b8f14c4364b9c9 pw_fuzzer: Add test metadata 2c93ab299c560b5 python: Upgrade mypy to 1.5.0 9595ee33170d321 python: Upgrade pylint to 2.17.5 bcca1d5f85a5867 pw_presubmit: Upstream constraint file output fix 7dec9b96d75005f pw_unit_test: Add per-fixture setup/teardown ab194ec0b404ff6 pw_stream: Use more appropriate error codes for Cu 01b5d06eeaf14e9 pw_presubmit: JavaScript and TypeScript lint check e81ae0345b268ce docs: Update changelog b8d6d511016b2e8 pw_sync: Test Borrowable with Mutex, TimedMutex, a 3db851cdbd209e9 soong: Remove host/vendor properties from defaults 565311e620090fe pw_build: Increase size of test linker script memo 46b09091f2c1c77 pw_rpc_transport: Add simple_framing Soong rule aa9cec4c76bcbaa pw_env_setup: Add ability to override bazel BUILD 00004972582735c roll: go 0e3ebc9ceeecfcf pw_web: Remove object-path dependency from Device https://pigweed.googlesource.com/pigweed/pigweed third_party/pigweed/src Rolled-Commits: c02cc30dc10b225..e8a541f8a5f8e10 Roller-URL: https://ci.chromium.org/b/8772196681654630241 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: I07fcba8e03fe0c775650276ca2eb4ca7d1e07b8d Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/167450 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.