| commit | cf3f4cc7a3506a33ee3a437544ef6f40056b3563 | [log] [tgz] |
|---|---|---|
| author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Mon Sep 09 00:44:43 2024 +0000 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Mon Sep 09 00:44:43 2024 +0000 |
| tree | 185eb26d6be40962c79c27580342d0a5fb5bb505 | |
| parent | bd046f44f74e09b61c4b7f9523bdab84c6cb7c04 [diff] |
roll: third_party/pigweed/src 53 commits f2d25b993ef8133 roll: python-wheel 22e1c7725b69892 roll: fuchsia_infra 31 commits f728fea14685b4b roll: rust 77d4ffe19965706 fuzztest: Update GN files for FuzzTest and Abseil 54679d205e48883 bazel: Re-enable platform-based flags 877c8f486a81493 pw_async2: Replace AwaitableBase with pw::Function 8ed816611d2aa80 pw_fuzzer: Add asan_default_options 0c216de1a41aa5c pw_build: Update scripts for converting Bazel to G 2d7b15a9f319fff bazel: Update cmsis_core checksum c1053db0462769f docs: Adopt pydata-sphinx-theme de38a67fb1b342a SEED-0130: Update Sphinx theme 54c90e55d7d27b7 pw_bluetooth_sapphire: Document how tests are run 13eef66fafd043a pw_tokenizer: Set prefix in Detokenizer; fix typin bce3cdbb55763e7 pw_system: Add missing host cmake build deps 9ee719d8a2770ac pw_bluetooth_sapphire: Clean up unnecessary deps i 444d211943b4813 pw_bluetooth: Add SniffModeCommand f56b3e7d3905c04 pw_bluetooth_sapphire: Add transport Bazel unit te 006f279167ca591 docs: Add logging recommendations 196272619238281 pw_bluetooth_sapphire: Add testing Bazel unit test 7e9104fb19c00c3 pw_package: Fix pictotool install on mac 1eb09016e8bd33e pw_bluetooth_sapphire: Add sm Bazel unit test targ 1c6ecb99c9eb472 pw_bluetooth_sapphire: Add sdp Bazel unit test tar 1d6978a9f251c70 pw_bluetooth: Add LEAdvertisingSetTerminated event d726d01274174ab pw_bluetooth_sapphire: Add sco Bazel unit test tar 4fee7205aac81c2 pw_bluetooth: Format emboss files d06bb1cc4fa470d docs: Update bug reference to a public one 02e9f98073cc396 pw_presubmit: Enable strict Bazel lockfile checks 4816267a3988600 rust: Register Pigweed Rust toolchains with bzlmod 00faa5bb544b18b pw_bluetooth_sapphire: Add l2cap Bazel unit test t 0704d81595a7d7b pw_bluetooth_sapphire: Add iso Bazel unit test tar 0922a519cad1230 docs: Add cloud build section to Sense tutorial 53395847ef97c1f pw_bluetooth_sapphire: Add hci Bazel unit test tar a42f6690f2225b6 pw_bluetooth_sapphire: Add gatt Bazel unit test ta 25e471bd23daca9 pw_bluetooth_sapphire: Add gap Bazel unit test tar 495ac11f580ca6b pw_bluetooth_sapphire: Add common Bazel unit test 14d05ca59262261 pw_bluetooth_sapphire: Add att Bazel unit test tar 5bb658063fba43f pw_log_rpc: Invoke pw.log.Logs.Listen() to restore f177db338b9a065 Remove jethier@google.com from pw_env_setup/OWNERS 2132190c17cd41e pw_bluetooth_sapphire: Add hci-spec Bazel test tar dbbbad542b74bcd pw_cli: Add in option to retrieve commit date 114064192788e79 pw_stream_uart_linux: Add Config struct 2fbf9d847123b2e pw_async2: Use variant in awaitable 0acb4afcc63a107 roll: cipd d499b841d0d4aed pw_uart_mcuxpresso: Introduce DMA UART backend for 7b9a2c51e9b7cc0 pw_bluetooth: Add test case for reading payload le cca9825598d223d pw_bluetooth: Add ScoDataHeader 7f4dd568811587b pw_bluetooth: Separate IsoDataFrameHeader from Iso f2c1020e83c2b46 pw_ide: Allow disabling clangd query drivers arg 745690761e12338 docs: Add link to good first issue list fb6904746a2b5d6 docs: Fix capitalization f438978ee6805ca pw_tokenizer: Use uint64_t for calculation f85d4f62a404caa pw_chrono: Add VirtualClock dc92fa94360e3b8 pw_toolchain: Explicitly link with lld when using https://pigweed.googlesource.com/pigweed/pigweed third_party/pigweed/src Rolled-Commits: 8512b20c7f93492..f2d25b993ef8133 Roller-URL: https://ci.chromium.org/b/8737316849985093089 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: Id67c60e82ca39244687b123148ee80dd43f8f68f Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/234596 Bot-Commit: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> Commit-Queue: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> Lint: Lint 🤖 <android-build-ayeaye@system.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.