s390-tools/rust/pvsecret

pvsecret

Synopsis

pvsecret [OPTIONS] <COMMAND>

Description

Use pvsecret to manage secrets for IBM Secure Execution guests. pvsecret can create add-secret requests on any architecture. On s390x systems, use pvsecret to add the secrets to the ultravisor secret store, list all secrets in the secret store, or lock the secret store to prevent any modifications in the future.

The ultravisor secret store stores secrets for the IBM Secure Execution guest. The secret store is cleared on guest reboot.

Create requests only on trusted systems that are not the IBM Secure Execution guest where you want to inject the secrets. This approach prevents the secrets from being in cleartext on the guest. For extra safety, do an attestation with pvattest of your guest beforehand, and include the configuration UID in the secret request using --cuid. Refer to pvsecret-add for more information. For all certificates, revocation lists, and host-key documents, both the PEM and DER input formats are supported.

Commands Overview

• create

Create a new add-secret request

• add

Submit an add-secret request to the Ultravisor (s390x only)

• lock

Lock the secret-store (s390x only)

• list

List all ultravisor secrets (s390x only)

• verify

Verify that an add-secret request is sane

• retrieve

Retrieve a secret from the UV secret store (s390x only)

Options

-v, --verbose

Provide more detailed output.

-q, --quiet

Provide less output.

--version

Print version information and exit.

-h, --help

Print help (see a summary with '-h').

pvsecret create

Synopsis

pvsecret create [OPTIONS] --host-key-document <FILE> --hdr <FILE> --output <FILE> <--no-verify|--cert <FILE>> <COMMAND>

Description

Create add-secret requests for IBM Secure Execution guests. Only create these requests in a trusted environment, such as your workstation. The pvattest create command creates a randomly generated key to protect the request. The generated requests can then be added on an IBM Secure Execution guest using pvsecret add. The guest can then use the secrets with the use case depending on the secret type. Such a request is bound to a specific IBM Secure Execution image specified with --hdr. Optionally, the request can be bound to a specific instance when bound to the Configuration Unique ID from pvattest using --cuid

Commands Overview

• meta

Create a meta secret

• association

Create an association secret

• retrievable

Create a retrievable secret

• update-cck

Update customer communication key

Options

-k, --host-key-document <FILE>

Use FILE as a host-key document. Can be specified multiple times and must be specified at least once.

--no-verify

Disable the host-key document verification. Does not require the host-key documents to be valid. Do not use for a production request unless you verified the host-key document beforehand.

-C, --cert <FILE>

Use FILE as a certificate to verify the host-key or keys. The certificates are used to establish a chain of trust for the verification of the host-key documents. Specify this option twice to specify the IBM Z signing key and the intermediate CA certificate (signed by the root CA).

--crl <FILE>

Use FILE as a certificate revocation list (CRL). The list is used to check whether a certificate of the chain of trust is revoked. Specify this option multiple times to use multiple CRLs.

--offline

Make no attempt to download CRLs.

--root-ca <ROOT_CA>

Use FILE as the root-CA certificate for the verification. If omitted, the system wide-root CAs installed on the system are used. Use this only if you trust the specified certificate.

--hdr <FILE>

Specifies the header of the guest image. Can be an IBM Secure Execution image created by 'pvimg/genprotimg' or an extracted IBM Secure Execution header.

-f, --force

Force the generation of add-secret requests on IBM Secure Execution guests. If the program detects that it is running on an IBM Secure Execution guest, it denies the generation of add-secret requests. The force flag overwrites this behavior.

-o, --output <FILE>

Write the generated request to FILE.

--extension-secret <FILE>

Use the content of FILE as an extension secret. The file must be exactly 32 bytes long. If this request is the first, all subsequent requests must have the same extension secret. Only makes sense if bit 1 of the secret control flags of the IBM Secure Execution header is 0. Otherwise the ultravisor rejects the request.

--cck <FILE>

Use the content of FILE as the customer-communication key (CCK) to derive the extension secret. The file must contain exactly 32 bytes of data. If the target guest was started with bit 1 of the secret control flag set, the ultravisor also derives the secret from the CCK. Otherwise, the ultravisor interprets the extension secret as a normal one. This still works if you use the same CCK for all requests.

--cuid-hex <HEXSTRING>

Use HEXSTRING as the Configuration Unique ID. Must be a hex 128-bit unsigned big endian number string. Leading zeros must be provided. If specified, the value must match with the Config-UID from the attestation result of that guest. If not specified, the CUID will be ignored by the ultravisor during the verification of the request.

--cuid <FILE>

Use the content of FILE as the Configuration Unique ID. The file must contain exactly 128 bit of data or a yaml with a `cuid` entry. If specified, the value must match the Config-UID from the attestation result of that guest. If not specified, the CUID will be ignored by the Ultravisor during the verification of the request.

--flags <FLAGS>

Flags for the add-secret request. Possible values: - **disable-dump**: Disables host-initiated dumping for the target guest instance.

--user-data <FILE>

Use the content of FILE as user-data. Passes user data defined in FILE through the add-secret request to the ultravisor. The user data can be up to 512 bytes of arbitrary data, and the maximum size depends on the size of the user-signing key:

• No key: user data can be 512 bytes.

• EC(secp521r1) or RSA 2048 keys: user data can be 256 bytes.

• RSA 3072 key: user data can be 128 bytes.

The firmware ignores this data, but the request tag protects the user-data. Optional. No user-data by default.

--policy <FILE>

Links an Add‑Secret-Request (ASR) to a policy file. This option embeds a PolicyReference in the ASR user data field. The PolicyReference includes the relative file path and the SHA‑512 hash of the policy file, allowing the policy’s integrity to be verified.

This option conflicts with --user-data, because both options use the same user data field in the ASR structure.

--toc-policy <FILE>

Adds the AES‑GCM authentication tag to a TOC policy file. This option appends the AES‑GCM authentication tag to the specified TOC policy file. This allows the TOC policy to maintain a list of all ASR MAC tags for completeness verification during boot. During verification, the TOC checks the MAC tags against this list to ensure that all expected ASRs are present and unmodified.

--user-sign-key <FILE>

Use the content of FILE as user signing key. Adds a signature calculated from the key in FILE to the add-secret request. The file must be in DER or PEM format containing a private key. Supported are RSA 2048 & 3072-bit and EC(secp521r1) keys. The firmware ignores the content, but the request tag protects the signature. The user-signing key signs the request. The location of the signature is filled with zeros during the signature calculation. The request tag also secures the signature. See man pvsecret verify for more details. Optional. No signature by default.

--use-name

Do not hash the name, use it directly as secret ID. Ignored for meta-secrets.

-h, --help

Print help (see a summary with '-h').

pvsecret create meta

Synopsis

pvsecret create meta

Description

Create a meta secret. Use a meta secret to carry flags to the ultravisor without having to provide an actual secret value. Meta secrets do not appear in the list of secrets.

pvsecret create association

Synopsis

pvsecret create association [OPTIONS] <NAME>

Description

Create an association secret. Use an association secret to connect a trusted I/O device to a guest. The 'pvapconfig' tool provides more information about association secrets.

Arguments

<NAME>

String that identifies the new secret. The actual secret is set with '--input-secret'. The name is saved in `NAME.yaml` with white-spaces mapped to `_`.

Options

--stdout

Print the hashed name to stdout. The hashed name is not written to `NAME.yaml`

--input-secret <SECRET-FILE>

Path from which to read the plaintext secret. Uses a random secret if not specified.

--output-secret <SECRET-FILE>

Save the generated secret as plaintext in SECRET-FILE. The generated secret can be used to generate add-secret requests for a different guest with the same secret using '--input-secret'. Destroy the secret when it is not used anymore.

-h, --help

Print help (see a summary with '-h').

pvsecret create retrievable

Synopsis

pvsecret create retrievable [OPTIONS] --secret <SECRET-FILE> --type <TYPE> <NAME> pvsecret create retr [OPTIONS] --secret <SECRET-FILE> --type <TYPE> <NAME>

Description

Create a retrievable secret. A retrievable secret is stored in the per-guest storage of the Ultravisor. A SE-guest can retrieve the secret at runtime and use it. All retrievable secrets, but the plaintext secret, are retrieved as wrapped/protected key objects and only usable inside the current, running SE-guest instance.

Arguments

<NAME>

String that identifies the new secret. The actual secret is set with '--secret'. The name is saved in `NAME.yaml` with white-spaces mapped to `_`.

Options

--stdout

Print the hashed name to stdout. The hashed name is not written to `NAME.yaml`

--secret <SECRET-FILE>

Use SECRET-FILE as retrievable secret.

--type <TYPE>

Specify the secret type. Limitations to the input data apply depending on the secret type. Possible values: - **plain**: A plaintext secret. Can be any file up to 8190 bytes long. - **aes**: An AES key. Must be a plain byte file 128, 192, or 256 bit long. - **aes-xts**: An AES-XTS key. Must be a plain byte file 256, or 512 bit long. - **hmac-sha**: A HMAC-SHA key. Must be a plain byte file 512, or 1024 bit long. Special care is required when creating HMAC-SHA keys. For more Information refer to the DESCRIPTION section of the man file. - **ec**: An elliptic curve private key. Must be a PEM or DER file.

-h, --help

Print help (see a summary with '-h').

pvsecret create update-cck

Synopsis

pvsecret create update-cck --secret <CCK-FILE> pvsecret create cck --secret <CCK-FILE>

Description

Update customer communication key. Insert a customer communication key into a guest.

Options

--secret <CCK-FILE>

Use CCK-FILE as new CCK.

-h, --help

Print help (see a summary with '-h').

pvsecret add

Synopsis

pvsecret add [OPTIONS] [INPUT]

Description

Submit an add-secret request to the Ultravisor (s390x only). Perform an add-secret request using a previously generated add-secret request. Only available on s390x.

Arguments

<INPUT>

Specify the request to be sent.

Options

-i, --input <FILE>

Specify the request to be sent.

-f, --force

Force the addition of add-secret requests. Add an add-secret request even if there is already a secret with the same ID in the secret store.

-h, --help

Print help (see a summary with '-h').

pvsecret lock

Synopsis

pvsecret lock

Description

Lock the secret-store (s390x only). Lock the secret store (s390x only). After this command executed successfully, all subsequent add-secret requests will fail. Only available on s390x.

pvsecret list

Synopsis

pvsecret list [OPTIONS] [OUTPUT]

Description

List all ultravisor secrets (s390x only). Lists the IDs of all non-null secrets currently stored in the ultravisor for the currently running IBM Secure Execution guest. Only available on s390x.

Arguments

<OUTPUT>

Store the result in FILE.

Options

-o, --output <FILE>

Store the result in FILE.

--format <FORMAT>

Define the output format of the list. Default value: 'human' Possible values: - **human**: Human-focused, non-parsable output format. - **yaml**: Use yaml format. - **bin**: Use the format the ultravisor uses to pass the list.

-h, --help

Print help (see a summary with '-h').

pvsecret verify

Synopsis

pvsecret verify [OPTIONS] [INPUT] [OUTPUT]

Description

Verifies that the given request is an Add-Secret request by testing for some values to be present. If the request contains signed user-data, the signature is verified with the provided key. Outputs the arbitrary user-data. All data in the request is in big endian. verify checks the following:

• The first 6 bytes of the request are equal to: B6173 7263 624d | asrcbM
• The sizes in the request header are sane and do not point out of the file
• The request version is supported by the binary
• If user-data contains a signature, verify the signature using a public key

The content of bytes 6&7 of the request define which kind of user-data the request contains.

• 0x0000 no user-data (512 bytes zero)
• 0x0001 512 bytes user-data
• 0x0002 265 bytes user-data| 139 bytes ecdsa signature | 5 bytes reserved | 2 bytes signature size | ...
• 0x0003 256 bytes user-data | 256 bytes rsa2048 signature
• 0x0004 128 bytes user-data | 384 bytes rsa3072 signature

The actual user-data may be less than the capacity. If less data was provided during create zeros are appended. For type 2-4 The signature is calculated as follows:

1. The request is generated with the user-data in place and zeros for the signature data.
2. The signature is calculated for the request. The signature signs the authenticated data and the encrypted data, but not the request tag. I.e. the signature signs the whole request but the last 16 bytes a,d with the signature bytes set to zero.
3. The signature is inserted to its location in the request.
4. The request GCM tag is calculated.

The verification process works as follows:

1. copy the signature to a buffer
2. overwrite the signature with zeros
3. verify the signature of the request but the last 16 bytes

Arguments

<INPUT>

Specify the request to be checked.

<OUTPUT>

Store the result in FILE If the request contained abirtary user-data the output contains this user-data with padded zeros if available.

Options

-i, --input <FILE>

Specify the request to be checked.

--user-cert <FILE>

Certificate containing a public key used to verify the user data signature. Specifies a public key used to verify the user-data signature. The file must be a X509 certificate in DSA or PEM format. The certificate must hold the public EC, RSA 2048, or RSA 3072 key corresponding to the private user-key used during `create`. No chain of trust is established. Ensuring that the certificate can be trusted is the responsibility of the user. The EC key must use the NIST/SECG curve over a 521 bit prime field (secp521r1).

-o, --output <OUTPUT>

Store the result in FILE If the request contained abirtary user-data the output contains this user-data with padded zeros if available.

-h, --help

Print help (see a summary with '-h').

pvsecret retrieve

Synopsis

pvsecret retrieve [OPTIONS] [INPUT] [OUTPUT] pvsecret retr [OPTIONS] [INPUT] [OUTPUT]

Description

Retrieve a secret from the UV secret store (s390x only)

Arguments

<INPUT>

Specify the secret ID to be retrieved. Input type depends on '--inform'. If `yaml` (default) is specified, it must be a yaml created by the create subcommand of this tool. If `hex` is specified, it must be a 32 byte handle encodes in hexadecimal. Leading zeros are required. If there are multiple secrets in the store with the same Id there are no guarantees on which specific secret is retrieved. Use --inform=idx to make sure a specific secret is retrieved.

<OUTPUT>

Specify the output path to place the secret value.

Options

-i, --input <ID>

Specify the secret ID to be retrieved. Input type depends on '--inform'. If `yaml` (default) is specified, it must be a yaml created by the create subcommand of this tool. If `hex` is specified, it must be a 32 byte handle encodes in hexadecimal. Leading zeros are required. If there are multiple secrets in the store with the same Id there are no guarantees on which specific secret is retrieved. Use --inform=idx to make sure a specific secret is retrieved.

-o, --output <FILE>

Specify the output path to place the secret value.

--inform <INFORM>

Define input type for the Secret ID. Default value: 'yaml' Possible values: - **yaml**: Use a yaml file. - **hex**: Use a hex string. - **name**: Use a name-string. Will hash it if no secret with the name found. - **idx**: Use the secret-index (base 10) instead of the secret-ID.

--outform <OUTFORM>

Define the output format for the retrieved secret. Default value: 'pem' Possible values: - **pem**: Write the secret as PEM. - **bin**: Write the secret in binary.

-h, --help

Print help (see a summary with '-h').