Module params 

The params type of each action, and the rules over a step’s with: values that hold in every build.

The types generate the schema of each action’s with: block (see with_schema), which says what keys it takes and what each value may be. cross_field holds the few rules a schema cannot say. Both live in the model so the resolver, the runtime and an editor read the same ones, since the language server links the model and the resolver but no backend.

Only rules that travel with the document belong here. RSA-9999 is not a key algorithm on any machine, so rejecting it is portable. Whether this binary can generate an ML-DSA key is a property of the build doing the checking, and that question is answered by the action handler instead, at the point where a backend exists to ask.

Structs

AttestParams

Params for attest action.

AttestSlotParams

Parameters for the yubikey_attest_slot action.

CheckValueParams

Params for check_value action.

ClockCheckParams

Params for clock_check action.

ConfirmParams

Params for confirm action.

EncryptDataParams

Params for encrypt_data action.

EnterShareParams

Params for enter_share action.

EntryParams

Params for the enter_value and enter_secret actions.

EntryShape

What an enter_value or enter_secret step says about the value it asks for, as the with: fields spell it.

GatherEntropyParams

Params for gather_entropy action.

GenerateCsrParams

Params for generate_csr action.

GenerateKeyParams

Params for generate_key action.

ImportKeyParams

Params for import_key action.

IssueCertificateParams

Params for issue_certificate action.

KeyPolicyParams

The policy: block, mirroring KeyPolicy field for field.

KeyUsage

One name under policy: { usages: [...] }, a PKCS#11 usage.

MachineInfoParams

Params for machine_info action.

OralReadbackParams

Params for oral_readback action.

ParamError

A with: value an action cannot accept.

PivReadCertificateParams

Parameters for the piv_read_certificate action.

PivSignParams

Parameters for the piv_sign action.

RevealParams

Params for reveal action.

SignDataParams

Params for sign_data action.

SplitSecretParams

Params for split_secret action.

UnwrapKeyParams

Params for unwrap_key action.

VerifySignatureParams

Params for verify_signature action.

WrapKeyParams

Params for wrap_key action.

Enums

FormatSpec

format: as a step writes it: the name of a Format, or a pattern.

ReadbackFormat

Display format for the oral_readback action.

Constants

KEYWORDS

The keywords a generated schema may use: the ones that constrain a value, the ones that combine schemas, and the annotations.

PIV_SIGN_ALGORITHMS

The signature algorithms a PIV card performs. RSA-PSS is absent because PIV cards apply a raw RSA operation and the client-side PSS encoding is not implemented; Ed25519 and ML-DSA because no PIV card does them.

PIV_SLOT

A PIV slot as a step names it: 9a, 9c, 9d, 9e, or a retired slot by its key reference in hex, 82 to 95, optionally after piv:.

Functions

cross_field

The rules over a step’s with: values that a schema cannot say: one value compared with another, and a pattern that must compile in the dialect the runtime uses.

generator

A generator with the settings every params schema is made with.

with_schema

The whole schema of action’s with: block, with the definitions it refers to.