roll: third_party/pigweed/src 947b968..4c234ae (63 commits)

4c234ae:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/290319 roll: luci
11df3bc:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/290313 roll: python-wheel
f6afe18:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/290312 roll: ninja
70d1cca:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/290292 roll: fuchsia-infra-bazel-rules 726a944..98449cb (59 commits)
60d5bd8:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/289672 pw_sync: Remove try_lock in CheckLocked
7273b90:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/289378 pw_tokenizer: Update definition of DetokenizedString::ok()
cc9e6dc:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/289983 pw_system: Make allocator heap size configurable
a4fe433:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/289819 zeyphr: Fix missing Kconfig deps on interrupt context
ef3eb13:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/289374 pw_ide: Add last bazel build UI indicator
91b3a63:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/289517 pw_bluetooth_proxy: Remove ProxyHost gatt send
fb9c8ff:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/284855 pw_uart_mcuxpresso: Support reinit on dma uart
fa2b309:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/289532 pw_tokenizer: Remove uses of deprecated functions in Python
0964137:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/289392 pw_module: Do not generate references to pigweed.bzl
b137011:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/286932 pw_async2: Support optional task names
2d02a6f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/289873 pw_hdlc: Workaround for PRIu64 newlib error
98be709:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/287293 pw_thread_zephyr: Implement yield backend
e9aa33b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/287642 pw_thread_zephyr: Add zephyr hooks to pw_thread_zephyr backends
babceb1:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/289516 pw_assert_basic: Add missing include
525a455:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/289696 pw_ide: Increase unit test timeout to fix CI
77f3436:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/289376 pw_bluetooth_sapphire: Add hci::Connection to IsoStream
e6f911b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/289375 pw_bluetooth_sapphire: Refactor hci::Connection
c8ac4d8:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/236875 targets/lm3s6965evb_qemu: Add Bazel support
6e09941:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/287653 pw_allocator: FaultInjectingAllocator for testing
435f8ca:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/289632 Revert "pw_tokenizer: Never silently detokenize collisions in Python"
68343a0:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/289612 pw_transfer: Mark client streams closed on RPC error
613d0fa:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/289152 pw_bluetooth_sapphire: Add IsoDataChannel::ClearControllerPacketCount
48f6208:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/289512 pw_chrono_stl: Add system_timer.cc to android build
43b391a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/289192 pw_env_setup: Uprev 'requests' for Zephyr compatibility
70e703c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/280933 pw_kernel: Add Event primitive
19d9058:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/288972 pw_bluetooth_sapphire: Remove unique_ptr from IsoStream rx queue
0f7f2c6:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/288154 pw_bluetooth_sapphire: Remove unique_ptr from GenDataBlob return value
f2a9ba5:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/288153 pw_sys_io_zephyr: Send bytes to printk if !console
86c9dd4:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/287976 pw_bluetooth_sapphire: Move ISO TX queue to IsoStream
8bbf389:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/289452 pw_tokenizer: Never silently detokenize collisions in Python
5c5e892:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/289453 pw_tokenizer: Warn about using deprecated functions
8290285:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/282933 pw_ide: Overhaul of Bazel compile commands workflow
472a303:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/286475 pw_kernel: System image construction
1d9bfbb:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/286505 pw_grpc: Guard module with new enabled constraint
0dabdad:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/289412 pw_tokenizer: Deduplicate entries when reading from ELF
81291f0:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/289195 pw_kernel: Document register wrappers
a83f811:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/289194 pw_kernel: Make regs structs repr(transparent)
1cb9ceb:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/289372 third_party/pico_sdk: Remove noisy TODOs
95bb7d2:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/289313 pw_ide: Replace hyphen in pigweed-vscode dir
8bdb9b2:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/287716 pw_kernel: Override target via platform
89063fb:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/289052 pw_ide: Add `vsceLogin` command
10e0844:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/289332 pw_clock_tree_mcuxpresso: Remove instance of dir_pw_third_party
a6dfe9f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/289312 pw_string: Add pw_containers dependency
400558a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/287772 pw_bluetooth: Run emboss formatter
9332751:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/288194 pw_bluetooth_proxy: Use emboss to generate expected in gatt tests
97b9c75:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/288193 pw_bluetooth_proxy: Double check att_size vs bframe size
ee01230:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/288192 pw_bluetooth_proxy: Set H4 Packet Type Indicator in SetupAcl test util
a5a0958:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/287175 pw_grpc: Make window update less chatty
01610a7:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/281854 pw_ide: Bazel rules for compile commands generator
bc055a5:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/287296 pw_kernel: Use MaybeUninit<u8> for stack memory
aa93459:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/286672 docs: Remove the GN build
3c8f92d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/287176 pw_presubmit: Remove obsolete bazel_test step from presubmit
f622e98:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/284393 docs: Remove WORKSPACE-related notes
8643c1d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/289032 pw_grpc: Apply fixes for internal_strict_warnings
430430d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/287893 pw_containers: Improvements to common utilities
a9c9b55:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/287652 pw_numeric: Saturating multiplication polyfill
8fc7b53:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/287713 pw_kernel: Factor thread structures into module
80b61fe:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/281892 pw_bluetooth_sapphire: Don't offload non-offloadable filters
9b059bf:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/288654 roll: buildifier

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: 947b9681400b8b..4c234aea10192a
Roll-Count: 1
Roller-URL: https://cr-buildbucket.appspot.com/build/8715120594463001889
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: Id365c1550eb5b1e5d881e2e0e167359958776082
Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/290323
Commit-Queue: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>
Lint: Lint 🤖 <android-build-ayeaye@system.gserviceaccount.com>
Bot-Commit: Pigweed Roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com>
1 file changed
tree: ce93fe8e9d957d5d942e849a0a0726c6fa196c9c
  1. build_overrides/
  2. docs/
  3. dpe-rs/
  4. images/
  5. include/
  6. src/
  7. third_party/
  8. toolchains/
  9. tools/
  10. .clang-format
  11. .gitignore
  12. .gitmodules
  13. .gn
  14. banner.txt
  15. bootstrap.sh
  16. BUILD.gn
  17. BUILDCONFIG.gn
  18. generate_test_values.py
  19. LICENSE
  20. navbar.md
  21. OWNERS
  22. pigweed.json
  23. pyproject.toml
  24. README.md
  25. run_fuzzer.sh
  26. rustfmt.toml
README.md

Open Profile for DICE

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:

  • Separate CDIs for attestation and sealing use cases
  • Categorized inputs, including values related to verified boot
  • Certified UDS values
  • X.509 or CBOR certificates

Mailing List

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.

Specification

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.

Code

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.

Thirdparty Dependencies

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.

Building and Running Tests

Quick setup

To setup the build environment the first time:

$ git submodule update --init --recursive
$ source bootstrap.sh
$ gn gen out

To build and run tests:

$ ninja -C out

More details

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.

Porting

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.

Style

The Google C++ Style Guide is used. A .clang-format file is provided for convenience.

Incorporating

To incorporate the code into another project, there are a few options:

  • Copy only the necessary code. For example:

    1. Take the main code as is: include/dice/dice.h, src/dice.c

    2. 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.

Size Reports

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.

Thread Safety

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.

Clearing Sensitive Data

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.

  • The caller of this code is responsible for buffers they own (of course).
  • The ops implementations need to clear any copies they make of sensitive data. Both boringssl and mbedtls attempt to zeroize but this may need additional care to integrate correctly. For example, boringssl skips optimization prevention when OPENSSL_NO_ASM is defined (and it is currently defined).
  • Sensitive data may remain in cache.
  • Sensitive data may have been swapped out.
  • Sensitive data may be included in a crash dump.