| commit | 53103dfb51d3332d611527a9e97fffbd18278dad | [log] [tgz] |
|---|---|---|
| author | pigweed-roller <pigweed-roller@pigweed-service-accounts.iam.gserviceaccount.com> | Wed Jun 28 20:29:33 2023 +0000 |
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | Wed Jun 28 20:29:33 2023 +0000 |
| tree | 846f14ad4076dbf7bb03fc0f8b685993f323191a | |
| parent | 35df059b91607b2593aefded9ca42e441d7e969e [diff] |
[third_party/pigweed/src] Roll 50 commits cf19d9e3263ac09 pw_presubmit: Apply exclusions to most lint checks 353553eac531be0 pw_web: Add icons and row styling based on severit b85cbedebf539b8 pw_web: Fix view del. order and autoscroll offset 9c997043a5e139e rust: Correct inverted no_std logic ff8202f165e3394 pw_spi: Add mcuxpresso backends for pw_spi 446b404746f214f pw_env_setup: Add support for project_actions c1ded2e332347a6 pw_hdlc: Add option to change HDLC frame parsing 8455cfabe6d7d5f python: Fix 3.11 lint errors c9778b05a585e42 pw_rpc_transport: Set HDLC address to pw_rpc defau 1f8a9744920941f pw_bluetooth: Delete temporary Emboss build librar c07555a4638bb58 third_party/fuchsia: Update patch file be184abffb31e7b third_party/fuchsia: Copybara import 3985099a5466144 pw_sys_io: Doxygenify TryReadByte() 7d1c4f21fd054bf pw_thread_zephyr: Fix doc headings 0b04368aeaf458e pw_web: Fix rollup config to inline dynamic import bfd2dd51e61898b rust: Update rules_rust and add support for thumbv 4e9bb2b06e3b349 roll: host_tools 32adfa7b302982a roll: sysroot 49c6ab689b7691b docs: Auto-generate the Zephyr Kconfig reference a6477acd8b824de docs: Document status code convention in Doxygen 704c31726ed04b9 docs: Update Zephyr geting started directions 80238af176d2ed9 targets: Add mimxrt595 FreeRTOS target ece346637c612a8 pw_build: pw_python_distribution package_data e25a85794d3d361 third_party/fuchsia: Remove unused config target 644f268e64bae04 pw_sync_zephyr: Resolve too many initializers for 8e748100f2b1e19 zephyr: Add native_posix CI e8b0a7f5a36dc0e pw_rpc_transport: Add generic stream rpc transport a40bef80ce8be20 pw_build: Remove unused python_wheels.py c018d30fb3d4528 pw_package: Add Zephyr 7196e1d7adf4440 kconfig: Add help text 698999aa748cb6d pw_stream: Add Rust streaming interfaces 9e1ec307891de20 pw_containers: Allow mutation of FlatMap values d20e35f38fc7137 boringssl: Abort on randomness request d0f6e1481471f51 pw_fuzzer: Add domains for Pigweed types 794a8d925ac7270 docs: Create a directory for Zephyr docs b0d345b80c0b925 pw_presubmit: Add missing type annotations 2b004fedfcab9cc pw_web: Implement virtualizer, basic log search an 90ef4e0ccd6343a pw_log_zephyr: Add spinlock for tokenized logging 45b1073516c7f9b roll: host_tools a35fcecc78d25ec roll: gn 410b336e17210a0 pw_sys_io: Doxygenify ReadByte() 9d591f9bf166145 pw_bluetooth: Delete duplicate temp file with Embo ead759cc68e4f35 freertos: Add bazel support for xtensa port 1da5c3aac6aa3cb pw_digital_io: Doxygenify DigitalIoOptional descri a32e043e5ee622c third_party/freertos: Add bazel support for malloc 78abfa4f833a44c pw_bluetooth: Fix incorrect enumeration for encryp c4a79032934662e pw_perf_test: Initialize the timer in the unit tes eafb7fd8c623167 pw_build: Provide CcInfo from pw_linker_script 2b5581f419e8cff pw_tokenizer: Move the API reference content 4e943da80245a57 third_party/fuchsia: Patch generation script comme https://pigweed.googlesource.com/pigweed/pigweed third_party/pigweed/src Rolled-Commits: feb469c15adacee..cf19d9e3263ac09 Roller-URL: https://ci.chromium.org/b/8777022363131588545 GitWatcher: ignore CQ-Do-Not-Cancel-Tryjobs: true Change-Id: Ibec15ccc71b3f02c96edf8f86daa895bd8212476 Reviewed-on: https://pigweed-review.googlesource.com/c/open-dice/+/153469 Pigweed-Auto-Submit: Rob Mohr <mohrr@google.com> Presubmit-Verified: CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> Commit-Queue: Auto-Submit <auto-submit@pigweed.google.com.iam.gserviceaccount.com> Reviewed-by: Darren Krahn <dkrahn@google.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 bootstrap script will automatically initialize all submodules.
$ source bootstrap.sh $ 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.