| commit | 326c8f08c25e68056e66590971df77fb705f2221 | [log] [tgz] |
|---|---|---|
| author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Mon Sep 04 00:44:42 2023 +0000 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Mon Sep 04 00:44:42 2023 +0000 |
| tree | 63ddd2c59f3106c712ec49b286e60079ad5322b1 | |
| parent | 6f1298ac7746606761c418b529d41e6780e9e3b9 [diff] |
[third_party/pigweed/src] Roll 47 commits
f29ef67144f72e6 roll: host_tools
b848bcc7604d04c roll: absolute_uploader, incremental_uploader
df79662e0626fd9 roll: clang
f1192a73c6f201d pw_system: Multi-channel configuration
24156dddb964db5 pw_env_setup: Add i2c protos to python deps
9514d6ad0ea0758 pw_env_setup: Fix banner printing on Windows
b3717b13619c28f pw_tokenizer: Simplify implementing a custom token
0f264ed2ff52d3f pw_random: Doxygenify xor_shift.h
08c186f9cc8df88 pw_tokenizer: Refactor the docs to be task-focused
e2212fecc91015b pw_tokenizer: Reload database in dedicated thread
dfe7d1d3abf5abd pw_bluetooth: Use hci.LinkKey in LinkKeyNotificati
d5843fe323e42c8 pw_web: Json Log Source example
1961c9c8ef71c4f pw_unit_test: Allow <<-style messages in test expe
d87b6d5a00113bd pw_function: Explain non-literal design rationale
26a96bae47d9d37 pw_function: Expose `bind_member`
dae119cfa3c0baa pw_spi: Fix Responder.SetCompletionHandler() signa
f4f4ac2f9bdde56 *: Fix formatting with new clang version
04e2b439b026c29 pw_i2c: Use new k{FieldName}MaxSize constants to g
119674131764032 roll: clang
fb5f2ca113295de pw_protobuf: Expose max_size, max_count in generat
3011a52d1c50c87 pw_protobuf: Introduce proto_message_field_props()
c94b32d9bb61f4c pw_protobuf: Change PROTO_FIELD_PROPERTIES to a di
5964d3c6b964e82 pw_protobuf: Rename 'node' to 'message' in forward
ec3187d104452f1 pw_protobuf: Simplify unnecessary Tuple return typ
86a14c7f77169bc pw_log_string: Provide more detail in the getting
612a8b64cae1581 pw_symbolizer: LlvmSymbolizer tool improvement
1972fe82e554003 pw_bluetooth: Add IoCapabilityResponseEvent Emboss
7533632f4b372d9 pw_tokenizer: Combine duplicated docs sections
155b55c593ad161 pw_bluetooth: Add IoCapabilityRequestEvent Emboss
8fe3c02b69f8e69 pw_bluetooth: Add EncryptionKeyRefreshCompleteEven
b7e36e5fce67a8e pw_bluetooth: Add ExtendedInquiryResultEvent Embos
86f92b542927fce pw_assert: Remove placeholder target
df7a49a2da88ffd pw_presubmit: Move colorize_diff to tools
54def9ab8ff0a56 pw_web: Enable downloading logs as plain text
203b3f1236e01db pw_web: Fix UI/state bugs
b6302bd8f47b64f pw_assert: Fix Bazel circular deps
81ce829732b2a15 pw_presubmit: RST formatting
f35c92af56acfc4 pw_tokenizer: Support change detection for directo
66231a2ef232238 pw_libc: Import LLVM libc's snprintf
13199babf8a62f8 pw_assert: Introduce pw_assert_backend_impl
abbdf3c98e7351a docs: Update Windows command for git hook
b698b02ae772df2 third_party/emboss: Reconfigure deps & add cflags
7df1768d915fe11 Bazel: Fix alwayslink support in MacOS host_clang
fc0a682bc19c5cc docs: Fix main content scrolling
7357044b275120d docs: Update changelog
238cb664a4ec6af pw_sync: Add GenericBasicLockable
0c42501cb8ddb39 pw_log_zephyr: Split tokenize handler into its own
https://pigweed.googlesource.com/pigweed/pigweed
third_party/pigweed/src Rolled-Commits: 6f78430711b3064..f29ef67144f72e6
Roller-URL: https://ci.chromium.org/b/8770928326433176417
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: Ifc4baa951b9db0c8630aad2ae37e7bf10add503c
Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/169391
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.