roll: third_party/pigweed/src 5e9dd49..f36b192 (48 commits)

f36b192:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/286694 roll: gn
16368a5:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/286693 roll: luci
c2da04e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/286634 roll: fuchsia-infra-bazel-rules 4dcae33..cb9e321 (38 commits)
c65f4c1:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/262793 pw_bluetooth_sapphire: Implement IsochronousStream::Write()
517b964:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/285892 pw_build: Extend colors across multiple log lines
4682f8d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/284532 pw_bluetooth_sapphire: LE random addr in advertisements
0193ef0:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/285859 pw_perf_test: New LogCsvEventHandler; measurement improvements
12ec135:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/285693 pw_checksum: Migrate size reports to Bazel
a5b7767:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/284152 pw_kernel: Initial syscall design
f294164:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/284874 pw_hdlc: Migrate size reports to Bazel
5f93ecf:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/284280 pw_async2: Store and log wait reasons
768021d:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/284691 pw_string: Migrate size reports to Bazel
d81bd23:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/286092 pw_log: Define default values for tokens
8490841:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/284395 pw_bluetooth_sapphire: Bump Fuchsia SDK API level to 27
478b9b6:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/283792 pw_kernel: Add debug_assert! macro
058426c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/285795 pw_containers: Migrate size reports to Bazel
10298a8:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/285952 Revert "pw_allocator: Refactor Deallocator::GetInfo"
51d4a2f:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/284854 pw_persistent_ram: Migrate size reports to Bazel
81e3403:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/285817 pw_tokenizer: Expand detokenization perf test
8516f31:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/285738 pw_bloat: Migrate size reports to Bazel
765afdb:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/285798 pw_protobuf: Re-enable a size report
1619c24:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/285816 pw_perf_test: Iteration tracking improvements
641dcf7:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/285912 pw_trace_tokenized: Apply clang-format findings
c2daa89:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/285653 blob_store: Update flash_write_size_bytes comment
a1763bb:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/285694 pw_kernel: Remove Cortex-M exception accesses to user frame
2254526:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/285652 pw_kernel: Move syscalls to execute in exception context
82897c9:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/285612 pw_kernel: Generate Cortex-M exception wrappers with a proc macro
1b6dc6a:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/284313 third_party/chromium_verifier: Use pw_external_chromium_verifier in gn
60b13c1:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/285732 pw_tokenizer: Add a few tests; fix typo
d1a9c37:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/285672 pw_bluetooth_sapphire: SCO Offload Index config
ef9eb37:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/285372 pw_rpc_transport: Fix docs.rst example of node B setup
ba96152:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/283972 pw_bluetooth_proxy: Handle l2cap disconnection response direction
e38aff6:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/284552 roll: clang, rust
ef778d4:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/284276 pw_cli: Add 'pw push' command
d313305:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/284689 pw_result: Migrate size reports to Bazel
c09fbd5:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/284858 pw_bytes: Migrate size reports to Bazel
5044006:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/285257 pw_base64: Use div_ceil for encoded size calculation
72f264b:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/285357 pw_work_queue: Add missing mutex include
e587b7e:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/285293 third_party/embos: Use pw_external_embos in gn
e658fd4:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/285259 pw_toolchain: Use rust nightly channel to compile stdlib
59db474:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/285332 third_party/freertos: Use pw_external_freertos in gn
a5fd1e4:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/284877 pw_metric: Migrate size reports to Bazel
c946806:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/284879 pw_kvs: Migrate size reports to Bazel
cc29764:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/285294 third_party/emboss: Use pw_external_emboss in gn
996bf64:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/282952 pw_work_queue: Templatize WorkQueue to allow for custom types
2f15246:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/284875 pw_bluetooth_sapphire: Set default security mode in SSP state
458237c:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/282893 pw_bluetooth_sapphire: Acquire wake lease while ServiceFound pending
1c7cfd3:https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/285047 Revert "pw_bluetooth_sapphire: SCO Offload Index config"

Rolled-Repo: https://pigweed.googlesource.com/pigweed/pigweed
Rolled-Commits: 5e9dd49e6dd2b2..f36b192d1ad8c6
Roll-Count: 1
Roller-URL: https://cr-buildbucket.appspot.com/build/8716388950362738145
GitWatcher: ignore
CQ-Do-Not-Cancel-Tryjobs: true
Change-Id: Iea913ab4f8b84d91e30ea7c5f635104975833c38
Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/286776
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>
1 file changed
tree: 5b96c539126c994b68ce8eea868e018af58f2049
  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.