Skip to content

Commit 2740f49

Browse files
committed
Update readme
1 parent ddd3015 commit 2740f49

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,7 @@ Header value: an attestation type given as a string as described below.
9393

9494
These are the attestation type names used in the HTTP headers, and the measurements file, and when specifying a local attestation type with the `--client-attestation-type` or `--server-attestation-type` command line options.
9595

96+
- `auto` - detect attestation type (used only when specifying the local attestation type as a command-line argument)
9697
- `none` - No attestation provided
9798
- `dummy` - Forwards the attestation to a remote service (for testing purposes, not yet supported)
9899
- `gcp-tdx` - DCAP TDX on Google Cloud Platform
@@ -138,7 +139,13 @@ Following a successful attestation exchange, the client can make HTTP requests u
138139

139140
As described above, the server will inject measurement data into the request headers before forwarding them to the target service, and the client will inject measurement data into the response headers before forwarding them to the source client.
140141

141-
### CLI differences from `cvm-reverse-proxy`
142+
## Dependencies and feature flags
143+
144+
The `azure` feature, for Microsoft Azure attestation requires [tpm2](https://tpm2-software.github.io) to be installed. On Debian-based systems this is provided by [`libtss2-dev`](https://packages.debian.org/trixie/libtss2-dev), and on nix `tpm2-tss`.
145+
146+
This feature is enabled by default. For non-azure deployments you can compile without this requirement by specifying `--no-default-features`. But note that this is will disabled both generation and verification of azure attestations.
147+
148+
## CLI differences from `cvm-reverse-proxy`
142149

143150
This aims to have a similar command line interface to `cvm-reverse-proxy` but there are some differences:
144151

0 commit comments

Comments
 (0)