Skip to content

Commit 8c7b27c

Browse files
committed
Documentation/ATTESTATION: update transport documentation
Vsock is now the default transport for attestation and serial port support is opt-in via the `attest-serial` feature for testing only. Update the build instructions and transport method descriptions accordingly. Signed-off-by: Luigi Leonardi <leonardi@redhat.com>
1 parent a142aa3 commit 8c7b27c

1 file changed

Lines changed: 12 additions & 9 deletions

File tree

Documentation/docs/developer/ATTESTATION.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -247,10 +247,12 @@ launching the proxy. The supported backend attestation protocols include:
247247

248248
SVSM communicates with the attestation proxy using one of two transport methods:
249249

250-
- **vsock**: When the `vsock` feature is enabled, SVSM will first try to use vsock for communication with the host proxy
251-
using port `1995`. If it fails, SVSM will try again using the serial port.
250+
- **vsock** (default): SVSM uses vsock for communication with the host proxy on
251+
port `1995`.
252252

253-
- **Serial port**: If vsock is not available, SVSM uses the COM3 serial port for communication with the attestation proxy.
253+
- **Serial port** (testing only): When the `attest-serial` feature is enabled,
254+
SVSM falls back to the COM3 serial port if the vsock connection fails. This
255+
is intended for testing purposes only.
254256

255257
## Try for yourself
256258

@@ -267,8 +269,8 @@ SEV-SNP machine with an SVSM-enabled kernel.
267269
```shell
268270
git clone https://github.com/coconut-svsm/svsm.git
269271
# ... build OVMF, qemu, SVSM IGVM, etc...
270-
FW_FILE=... make FEATURES=attest # serial transport
271-
FW_FILE=... make FEATURES=attest,vsock,virtio-drivers # vsock transport (with serial fallback)
272+
FW_FILE=... make FEATURES=attest,vsock,virtio-drivers # vsock transport (default)
273+
FW_FILE=... make FEATURES=attest,vsock,attest-serial,virtio-drivers # vsock with serial fallback (testing)
272274
```
273275

274276
2. Clone and run the `kbs-test` server used for testing. Supply the following
@@ -327,10 +329,11 @@ SEV-SNP machine with an SVSM-enabled kernel.
327329

328330
4. Run a guest with SVSM
329331

330-
SVSM will use vsock for communication if the feature is enabled, otherwise it
331-
falls back to the COM3 serial port (see [Transport Methods](#transport-methods)).
332-
The attestation proxy will need to be configured correctly to ensure proper communication
333-
according to the transport used.
332+
SVSM uses vsock for communication by default. If the `attest-serial` feature
333+
is enabled, it falls back to the COM3 serial port when vsock fails (see
334+
[Transport Methods](#transport-methods)). The attestation proxy will need to
335+
be configured correctly to ensure proper communication according to the
336+
transport used.
334337

335338
* **vsock**
336339
```shell

0 commit comments

Comments
 (0)