API reference¶
Every public type of CryptoService.Sdk, rendered from the XML documentation
comments by scripts/api_docs.py. The same comments ship in the
package for IDE tooltips.
| Type | Summary |
|---|---|
AlgorithmCatalog |
The algorithms the v2 API supports, by category (GET /v2/algorithms). |
Argon2Parameters |
Argon2id parameters as the server reports and accepts them. |
CbomComponent |
One CBOM component. |
CbomDocument |
The CycloneDX 1.6 Cryptographic Bill of Materials (GET /v2/compliance/cbom), informational input for CRA and DORA work. |
CbomProperty |
One CBOM name and value pair. |
CiphertextResult |
A ciphertext and the algorithm that produced it. |
CryptoApiException |
The server answered with a status outside 2xx. CryptoApiException.Problem is its RFC 9457 problem; an answer without one (a proxy's HTML page, an empty body) becomes an about:blank problem for the status. |
CryptoServiceClient |
A typed client for the Crypto Service v2 REST API (crypto-server). It performs no cryptography: every method is one HTTP call to the server, which holds the keys and does the work. |
CryptoServiceClientOptions |
Where crypto-server is, how to authenticate to it, and how long and how often to try. The client copies these values when it is constructed; changing the options afterwards does not affect it. |
CryptoServiceException |
The base of every error the client raises for a call that did not succeed: CryptoApiException when the server answered outside 2xx, CryptoTransportException when no usable answer arrived. |
CryptoTransportException |
No usable answer arrived: the connection failed, an attempt or the call's deadline timed out, the server tried to redirect, or a 2xx answer could not be decoded. The cause is in InnerException. |
DecryptRequest |
The body of POST /v2/decrypt. |
DeleteKeyResult |
A deleted key. |
DoraCompliance |
The DORA cryptographic inventory (GET /v2/compliance/dora): a self-assessment, not a compliance verdict under Regulation (EU) 2022/2554. |
DoraDeprecation |
A recommended sunset date for one algorithm. |
DoraInventoryItem |
One cryptographic package in the DORA inventory. |
EncryptRequest |
The body of POST /v2/encrypt (XChaCha20-Poly1305). |
ExportKeyResult |
An exported key: the private parts of a server-held key pair. |
GenerateKeyRequest |
The body of POST /v2/keys/generate. |
GenerateKeyResult |
A key pair the server generated and holds. |
HashRequest |
The body of POST /v2/hash. |
HashResult |
A digest. |
HealthStatus |
What GET /health answers. |
HmacRequest |
The body of POST /v2/hmac. |
HmacResult |
An HMAC. |
HmacVerifyRequest |
The body of POST /v2/hmac/verify. |
HpkeKeygenRequest |
The body of POST /v2/hpke/keygen. |
HpkeOpenRequest |
The body of POST /v2/hpke/open. |
HpkeOpenResult |
A plaintext as text and as bytes. |
HpkeSealRequest |
The body of POST /v2/hpke/seal (RFC 9180). |
HpkeSealResult |
An HPKE ciphertext. |
HybridDecapsulateRequest |
The body of POST /v2/pq/hybrid/decapsulate. |
HybridEncapsulateRequest |
The body of POST /v2/pq/hybrid/encapsulate. |
HybridEncapsulateResult |
A hybrid encapsulation. |
HybridKeyPairResult |
A hybrid X25519 and ML-KEM-768 key pair the server holds. |
Iso20022Envelope |
An ISO 20022 dual-signature envelope. |
Iso20022Signature |
One signature of an ISO 20022 envelope. |
Iso20022TrustedKeys |
The public keys an ISO 20022 envelope is checked against. |
Iso20022VerifyRequest |
The body of POST /v2/stream/iso20022: an ISO 20022 dual-signature envelope to verify. |
Iso20022VerifyResult |
The verdicts on an ISO 20022 envelope. |
KdfParameters |
KDF parameters; the server enforces OWASP floors. |
KdfRequest |
The body of POST /v2/kdf. |
KdfResult |
A derived key. |
KeyIdRequest |
A body naming one server-held key. |
KeyMetadata |
JWK-style key metadata. |
KeyPairResult |
A key pair the server generated and holds, without metadata. |
KeyUnwrapRequest |
The body of POST /v2/keys/unwrap. |
KeyWrapRequest |
The body of POST /v2/keys/wrap (AES-KW, RFC 3394, or AES-KWP, RFC 5649). |
KeyWrapResult |
A wrapped key. |
KmsCreateKeyRequest |
The body of POST /v2/kms/create-key. |
KmsDataKey |
A data encryption key, in the clear and wrapped. |
KmsDecryptRequest |
The body of POST /v2/kms/decrypt. |
KmsDecryptResult |
A KMS plaintext, as text and as bytes. |
KmsEncryptRequest |
The body of POST /v2/kms/encrypt. Build it with KmsEncryptRequest.FromText or KmsEncryptRequest.FromBytes, which state the encoding; the server never guesses it. |
KmsEncryptResult |
A KMS ciphertext. |
KmsGenerateDataKeyRequest |
The body of POST /v2/kms/generate-data-key. |
KmsKey |
A managed KMS key. |
KmsUnwrapRequest |
The body of POST /v2/kms/unwrap. |
KmsUnwrapResult |
A key unwrapped by a managed key. |
KmsWrapRequest |
The body of POST /v2/kms/wrap. |
KmsWrapResult |
A key wrapped by a managed key. |
LiveStatus |
What GET /live answers. |
MlDsaKeygenRequest |
The body of POST /v2/pq/dsa/keygen. |
MlDsaVerifyRequest |
The body of POST /v2/pq/dsa/verify. |
MlKemDecapsulateRequest |
The body of POST /v2/pq/decapsulate. |
MlKemEncapsulateRequest |
The body of POST /v2/pq/encapsulate (ML-KEM-768). |
MlKemEncapsulateResult |
An ML-KEM encapsulation. |
MultiRecipient |
One recipient of a multi-recipient envelope. |
MultiRecipientEncryptRequest |
The body of POST /v2/multi-recipient/encrypt. |
MultiRecipientEncryptResult |
A multi-recipient envelope. |
OpaqueLoginFinishRequest |
The body of POST /v2/opaque/login/finish. |
OpaqueLoginFinishResult |
The session key of a finished login. |
OpaqueLoginInitRequest |
The body of POST /v2/opaque/login/init. |
OpaqueLoginInitResult |
The server's KE2 message and the login session. |
OpaqueRegisterFinishRequest |
The body of POST /v2/opaque/register/finish. |
OpaqueRegisterFinishResult |
A stored registration. |
OpaqueRegisterInitRequest |
The body of POST /v2/opaque/register/init. |
OpaqueRegisterInitResult |
The server's registration response. |
PasswordDecryptRequest |
The body of POST /v2/password/decrypt. |
PasswordEncryptRequest |
The body of POST /v2/password/encrypt (Argon2id and XChaCha20-Poly1305). |
PasswordEncryptResult |
A password-encrypted envelope. |
PasswordHashRequest |
The body of POST /v2/password/hash (Argon2id). |
PasswordHashResult |
An Argon2id password hash. |
PasswordVerifyRequest |
The body of POST /v2/password/verify. |
PasswordVerifyResult |
Whether a password matched. |
PlaintextResult |
A recovered plaintext. |
ProblemDetails |
An RFC 9457 problem (application/problem+json), as crypto-server answers every error. |
RawResponse |
An answer as it arrived, whatever its status: what CryptoServiceClient.RequestAsync returns. |
ReadyStatus |
What GET /ready answers. |
RetryOptions |
How the client retries a failed attempt. The same contract holds in every Crypto Service SDK. |
SealResult |
A sealed box and the algorithm that sealed it. |
SealedboxOpenRequest |
The body of POST /v2/sealedbox/open and /v2/sealedbox/open-pq. |
SealedboxSealPqRequest |
The body of POST /v2/sealedbox/seal-pq (X25519 and ML-KEM-768). |
SealedboxSealRequest |
The body of POST /v2/sealedbox/seal (X25519, anonymous sender). |
SecretboxOpenRequest |
The body of POST /v2/secretbox/open. |
SecretboxSealRequest |
The body of POST /v2/secretbox/seal. |
ServiceInfo |
The service metadata GET / answers. |
SharedSecretResult |
A recovered shared secret. |
SignRequest |
The body of the signing routes that take a server-held key. |
SignResult |
A signature. |
SlhDsaKeygenRequest |
The body of POST /v2/pq/slh-dsa/keygen. |
SlhDsaVerifyRequest |
The body of POST /v2/pq/slh-dsa/verify. |
StreamMultiPqDecryptRequest |
The body of POST /v2/stream/multi-pq-decrypt. |
StreamMultiPqDecryptResult |
A plaintext recovered from a multi-recipient stream. |
StreamMultiPqEncryptRequest |
The body of POST /v2/stream/multi-pq-encrypt. |
StreamMultiPqEncryptResult |
A multi-recipient stream ciphertext. |
StreamPqDecryptRequest |
The body of POST /v2/stream/pq-decrypt. |
StreamPqEncryptRequest |
The body of POST /v2/stream/pq-encrypt. |
StreamRecipient |
One recipient of a multi-recipient stream. |
StreamSignItem |
One message to sign in a batch. |
StreamSignRequest |
The body of POST /v2/stream/sign: a batch of Ed25519 signatures. |
StreamSignResult |
The signatures of a batch. |
StreamSignature |
One signature of a batch. |
StreamVerdict |
One verdict of a batch. |
StreamVerifyItem |
One signature to verify in a batch. |
StreamVerifyRequest |
The body of POST /v2/stream/verify: a batch of Ed25519 verifications. |
StreamVerifyResult |
The verdicts of a batch. |
ValidationError |
One field that failed validation. |
VerifyRequest |
The body of POST /v2/verify (Ed25519). |
VerifyResult |
A verification verdict. |
WrappedRecipientKey |
The content key wrapped for one recipient. |