kata-containers/s390-tools
1
0
Fork 0
mirror of https://github.com/ibm-s390-linux/s390-tools.git synced 2026-08-05 02:14:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

pvattest: Update man and Readme

Browse Source 
man and README got out of sync with --help over time.
Resync them.

Reviewed-by: Jan Höppner <hoeppner@linux.ibm.com>
Signed-off-by: Steffen Eiden <seiden@linux.ibm.com>
Signed-off-by: Jan Höppner <hoeppner@linux.ibm.com>
This commit is contained in:
Steffen Eiden
2026-05-05 12:57:06 +02:00
committed by Jan Höppner
parent a50d0485c9
commit 1d6f7d0bec
6 changed files with 68 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
rust/pvattest/README.md
View File

@@ -17,7 +17,7 @@ Create an attestation measurement request
- **perform**
<ul>
Send the attestation request to the Ultravisor
Send the attestation request to the Ultravisor (s390x only.)
</ul>
- **verify**
@@ -150,11 +150,11 @@ Print help (see a summary with '-h').
### Synopsis
`pvattest perform [OPTIONS] [IN] [OUT]`
### Description
Send the attestation request to the Ultravisor. Run a measurement of this system
through ’/dev/uv’. This device must be accessible and the attestation
Ultravisor facility must be present. The input must be an attestation request
created with ’pvattest create’. Output will contain the original request and
the response from the Ultravisor.
Send the attestation request to the Ultravisor (s390x only.) Run a measurement
of this system through ’/dev/uv’. This device must be accessible and the
attestation Ultravisor facility must be present. The input must be an
attestation request created with ’pvattest create’. Output will contain the
original request and the response from the Ultravisor. Only available on s390x.
### Arguments
`<IN>`
@@ -171,6 +171,18 @@ Write the result to FILE.
### Options
`-i`, `--input <FILE>`
<ul>
Specify the request to be sent.
</ul>
`-o`, `--output <FILE>`
<ul>
Write the result to FILE.
</ul>
`-u`, `--user-data <File>`
<ul>
Provide up to 256 bytes of user input User-data is arbitrary user-defined data
@@ -256,7 +268,7 @@ Print help (see a summary with '-h').
## pvattest check
### Synopsis
`pvattest check [OPTIONS] <IN> <OUT>`
`pvattest check [OPTIONS] [IN] [OUT]`
### Description
Check if the attestation result matches defined policies. After the attestation
verification, check whether the attestation result complies with user-defined
@@ -277,6 +289,18 @@ Specify the output file for the check result.
### Options
`-i`, `--input <FILE>`
<ul>
Specify the attestation response to check whether the policies are validated.
</ul>
`-o`, `--output <FILE>`
<ul>
Specify the output file for the check result.
</ul>
`--format <FORMAT>`
<ul>
Define the output format.

16
rust/pvattest/man/pvattest-check.1
View File

@@ -3,7 +3,7 @@
.\" it under the terms of the MIT license. See LICENSE for details.
.\"
.TH "PVATTEST-CHECK" "1" "2025-03-12" "s390-tools" "Attestation Manual"
.TH "PVATTEST-CHECK" "1" "2026-05-19" "s390-tools" "Attestation Manual"
.nh
.ad l
.SH NAME
@@ -11,7 +11,7 @@ pvattest-check \- Check if the attestation result matches defined policies
.SH SYNOPSIS
.nf
.fam C
pvattest check [OPTIONS] <IN> <OUT>
pvattest check [OPTIONS] [IN] [OUT]
.fam C
.fi
.SH DESCRIPTION
@@ -31,6 +31,18 @@ Specify the output file for the check result.
.RE
.RE
.PP
\-i, \-\-input <FILE>
.RS 4
Specify the attestation response to check whether the policies are validated.
.RE
.RE
.PP
\-o, \-\-output <FILE>
.RS 4
Specify the output file for the check result.
.RE
.RE
.PP
\-\-format <FORMAT>
.RS 4

3
rust/pvattest/man/pvattest-create.1
View File

@@ -3,7 +3,7 @@
.\" it under the terms of the MIT license. See LICENSE for details.
.\"
.TH "PVATTEST-CREATE" "1" "2026-02-12" "s390-tools" "Attestation Manual"
.TH "PVATTEST-CREATE" "1" "2026-05-20" "s390-tools" "Attestation Manual"
.nh
.ad l
.SH NAME
@@ -21,6 +21,7 @@ Workstation. To avoid compromising the attestation do not publish the
attestation request protection key and shred it after verification. Every
\fBcreate\fR will generate a new, random protection key.
.SH OPTIONS
.PP
\-k, \-\-host\-key\-document <FILE>
.RS 4

19
rust/pvattest/man/pvattest-perform.1
View File

@@ -3,11 +3,11 @@
.\" it under the terms of the MIT license. See LICENSE for details.
.\"
.TH "PVATTEST-PERFORM" "1" "2025-03-12" "s390-tools" "Attestation Manual"
.TH "PVATTEST-PERFORM" "1" "2026-05-19" "s390-tools" "Attestation Manual"
.nh
.ad l
.SH NAME
pvattest-perform \- Send the attestation request to the Ultravisor
pvattest-perform \- Send the attestation request to the Ultravisor (s390x only.)
.SH SYNOPSIS
.nf
.fam C
@@ -18,7 +18,8 @@ pvattest perform [OPTIONS] [IN] [OUT]
Run a measurement of this system through ’/dev/uv’. This device must be
accessible and the attestation Ultravisor facility must be present. The input
must be an attestation request created with ’pvattest create’. Output will
contain the original request and the response from the Ultravisor.
contain the original request and the response from the Ultravisor. Only
available on s390x.
.SH OPTIONS
.PP
<IN>
@@ -33,6 +34,18 @@ Write the result to FILE.
.RE
.RE
.PP
\-i, \-\-input <FILE>
.RS 4
Specify the request to be sent.
.RE
.RE
.PP
\-o, \-\-output <FILE>
.RS 4
Write the result to FILE.
.RE
.RE
.PP
\-u, \-\-user\-data <File>
.RS 4

3
rust/pvattest/man/pvattest-verify.1
View File

@@ -3,7 +3,7 @@
.\" it under the terms of the MIT license. See LICENSE for details.
.\"
.TH "PVATTEST-VERIFY" "1" "2026-02-12" "s390-tools" "Attestation Manual"
.TH "PVATTEST-VERIFY" "1" "2026-05-20" "s390-tools" "Attestation Manual"
.nh
.ad l
.SH NAME
@@ -26,6 +26,7 @@ solely verifies that the Attestation measurement is correct. It does not check
for the content of additional data or user data. See `pvattest check` for policy
checks after you verified the Attestation measurement.
.SH OPTIONS
.PP
\-i, \-\-input <FILE>
.RS 4

5
rust/pvattest/man/pvattest.1
View File

@@ -3,7 +3,7 @@
.\" it under the terms of the MIT license. See LICENSE for details.
.\"
.TH "PVATTEST" "1" "2026-02-12" "s390-tools" "Attestation Manual"
.TH "PVATTEST" "1" "2026-05-19" "s390-tools" "Attestation Manual"
.nh
.ad l
.SH NAME
@@ -29,7 +29,7 @@ Create an attestation measurement request
\fBpvattest\-perform(1)\fR
.RS 4
Send the attestation request to the Ultravisor
Send the attestation request to the Ultravisor (s390x only.)
.RE
.PP
@@ -47,6 +47,7 @@ Check if the attestation result matches defined policies
.RE
.SH OPTIONS
.PP
\-v, \-\-verbose
.RS 4