Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

README: add a table of contents #3

Merged
merged 1 commit into from
Oct 12, 2023
Merged

README: add a table of contents #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 27 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# SPDM-Utils
<div align="center">
<h1>SPDM-Utils</h1>
</div>

SPDM-Utils is a Linux application designed to support, test and
develop SPDM requesters and responders.
Expand All @@ -18,6 +20,25 @@ SPDM-Utils source code is dual licensed under the Apache-2.0 license and MIT lic

See LICENSE-APACHE, LICENSE-MIT, and COPYRIGHT for details.

# Table of Contents

- [Dependencies](#dependencies)
- [Fedora](#fedora)
- [Building](#building)
- [Build libspdm](#build-libspdm)
- [Build the binary](#build-the-binary)
- [Build the `no_std` library](#build-the-no_std-library)
- [Generate mutable certificates](#Generate-mutable-certificates)
- [Configuring the Logger](#configuring-the-logger)
- [Testing](#testing)
- [Running libspdm tests](#running-libspdm-tests)
- [Testing completely on the host](#testing-completely-on-the-host)
- [Testing a real device](#testing-a-real-device)
- [Setting the certificate](#setting-the-certificate)
- [Getting a Certificate Signing Request](#getting-a-certificate-signing-request)
- [Signing a Certificate Signing Request](#signing-a-certificate-signing-request)
- [QEMU SPDM Device Emulation](#qemu-spdm-device-emulation)

# Dependencies

First you need to install Rust, instructions for that are available at: https://rustup.rs/
Expand Down Expand Up @@ -111,9 +132,9 @@ All changes should go through the Cargo formatter and tests, which can be run wi
cargo fmt; cargo clippy; cargo test
```

## Optional for running libspdm tests through SPDM-Utils:
## Running libspdm tests

Also setup and build `SPDM-Responder-Validator` in the third-party directory
Setup and build `SPDM-Responder-Validator` in the third-party directory

```shell
cd third-party/
Expand Down Expand Up @@ -182,6 +203,9 @@ For example to set the certificate run:
SPDM-Utils --doe-pci-cfg request --cert-path ./certs/slot0/immutable.der set-certificate
```

You can additionally specify `--cert-slot-id` to specify the target slot number, valid slot numbers range from
0-7.

## Getting a Certificate Signing Request

A requester can get the Certificate Signing Request (CSR) from the device
Expand Down