All Classes and Interfaces
Class
Description
What
POST /v2/encrypt answers: encrypt with XChaCha20-Poly1305.The server answered with a status outside 2xx.
The
params member.The two binary encodings the API uses, so callers can pass and read
byte[] without
guessing: lowercase hex for keys, signatures, digests, MACs, shared secrets, KEM ciphertexts and
HPKE output; standard base64 with padding for AEAD, secretbox, sealed-box, stream,
password-encryption and AES-KW output.One element of
components.What
GET /v2/compliance/cbom answers: cryptographic Bill of Materials (CBOM) in CycloneDX
1.6 format.One element of
properties.The
classical member.A client for the Crypto Service REST API (crypto-server).
Builds a
CryptoServiceClient.The base of every error the client raises for a call:
ApiError when the server answered
with an error status, TransportError when no usable answer arrived.The body of
POST /v2/decrypt.What
POST /v2/decrypt answers: decrypt with XChaCha20-Poly1305.One element of
algorithmDeprecationSchedule.One element of
cryptographicInventory.What
GET /v2/compliance/dora answers: DORA cryptographic inventory (self-assessment).The body of
POST /v2/encrypt.A hash algorithm accepted by
POST /v2/hash.The body of
POST /v2/hash.What
POST /v2/hash answers: compute a cryptographic hash.What
GET /health answers: health check.An HMAC hash accepted by
POST /v2/hmac and /v2/hmac/verify.An HPKE AEAD.
An HPKE key-encapsulation mechanism (RFC 9180, plus the X-Wing and X25519 + ML-KEM-768 hybrids).
The body of
POST /v2/hpke/keygen.What
POST /v2/hpke/keygen answers: generate a server-held HPKE key pair (classical or
post-quantum hybrid).The body of
POST /v2/hpke/open.What
POST /v2/hpke/open answers: decrypt (open) an HPKE ciphertext with a server-held
key.The body of
POST /v2/hpke/seal.What
POST /v2/hpke/seal answers: encrypt (seal) a message using HPKE (RFC 9180).The body of
POST /v2/pq/hybrid/decapsulate.What
POST /v2/pq/hybrid/decapsulate answers: hybrid decapsulate (X25519 + ML-KEM-768).The body of
POST /v2/pq/hybrid/encapsulate.What
POST /v2/pq/hybrid/encapsulate answers: hybrid encapsulate (X25519 + ML-KEM-768).What
POST /v2/pq/hybrid/keygen answers: generate a server-held hybrid X25519 + ML-KEM-768
key pair.The
envelope member.The body of
POST /v2/stream/iso20022.What
POST /v2/stream/iso20022 answers: verify ISO 20022 post-quantum dual-signature
envelope.A key-derivation function accepted by
POST /v2/kdf.The
params member.The body of
POST /v2/kdf.What
POST /v2/kdf answers: derive a key from a password.What
POST /v2/pq/decapsulate answers: ML-KEM decapsulate.A key-pair algorithm accepted by
POST /v2/keys/generate.What
POST /v2/keys/delete answers: delete a server-held key.What
POST /v2/keys/export answers: export a server-held private key.The body of
POST /v2/keys/generate.What
POST /v2/keys/generate answers: generate a server-held key pair for any supported
algorithm.The body of
POST /v2/keys/export.The
metadata member.The body of
POST /v2/keys/unwrap.An AES key-wrap mode accepted by
POST /v2/keys/wrap and /v2/keys/unwrap.The body of
POST /v2/keys/wrap.What
POST /v2/keys/wrap answers: wrap a key using AES-KW or AES-KWP (RFC 3394/5649).The body of
POST /v2/kms/create-key.What
POST /v2/kms/generate-data-key answers: generate a Data Encryption Key (DEK) via KMS
provider.The body of
POST /v2/kms/decrypt.What
POST /v2/kms/decrypt answers: decrypt ciphertext with a managed KMS key.How
POST /v2/kms/encrypt reads its plaintext; never guessed from the content.The body of
POST /v2/kms/encrypt.What
POST /v2/kms/encrypt answers: encrypt plaintext with a managed KMS key.The body of
POST /v2/kms/generate-data-key.What
POST /v2/kms/create-key answers: create a managed key in the designated KMS
provider.What a KMS key is created for.
The body of
POST /v2/kms/unwrap.What
POST /v2/kms/unwrap answers: unwrap a wrapped key using a managed KMS key.The body of
POST /v2/kms/wrap.What
POST /v2/kms/wrap answers: wrap an existing key using a managed KMS key.What
GET /live answers: liveness probe.The body of
POST /v2/hmac.What
POST /v2/hmac answers: compute an HMAC.The body of
POST /v2/hmac/verify.What
POST /v2/hmac/verify answers: verify an HMAC.The body of
POST /v2/pq/dsa/keygen.What
POST /v2/pq/dsa/keygen answers: generate a server-held ML-DSA key pair (FIPS 204).An ML-DSA (FIPS 204) security level.
What
POST /v2/pq/dsa/sign answers: sign with ML-DSA (FIPS 204).The body of
POST /v2/pq/dsa/verify.What
POST /v2/pq/dsa/verify answers: verify with ML-DSA (FIPS 204).The body of
POST /v2/pq/decapsulate.The body of
POST /v2/pq/encapsulate.What
POST /v2/pq/encapsulate answers: ML-KEM encapsulate.What
POST /v2/pq/keygen answers: generate a server-held ML-KEM-768 key pair.The body of
POST /v2/multi-recipient/encrypt.What
POST /v2/multi-recipient/encrypt answers: encrypt for multiple recipients (hybrid
key wrapping).The body of
POST /v2/opaque/login/finish.What
POST /v2/opaque/login/finish answers: finish OPAQUE login handshake.The body of
POST /v2/opaque/login/init.What
POST /v2/opaque/login/init answers: initiate OPAQUE login handshake.The body of
POST /v2/opaque/register/finish.What
POST /v2/opaque/register/finish answers: finish OPAQUE credential registration.The body of
POST /v2/opaque/register/init.What
POST /v2/opaque/register/init answers: initiate OPAQUE credential registration.An OPAQUE cipher suite.
The body of
POST /v2/password/decrypt.The body of
POST /v2/password/encrypt.What
POST /v2/password/encrypt answers: encrypt with password (Argon2id +
XChaCha20-Poly1305).The body of
POST /v2/password/hash.What
POST /v2/password/hash answers: hash a password with Argon2id.The body of
POST /v2/password/verify.What
POST /v2/password/verify answers: verify a password against an Argon2id hash.The
postQuantum member.An RFC 9457 problem: the body of every error the server sends (
application/problem+json).The answer to
CryptoServiceClient.request(java.lang.String, java.lang.String, byte[], java.lang.String), whatever its status: the low-level escape
hatch for routes the typed methods do not cover.What
GET /ready answers: readiness probe.One element of
recipients.One element of
recipients.A recipient kind for
POST /v2/multi-recipient/encrypt.What a
ResponseListener learns about one HTTP response: never a body.Observes every HTTP response the client receives, retried attempts included: for metrics, quota
tracking (
X-Tenant-RateLimit-*) or tests.Automatic retries of transient failures; off by default (
maxRetries = 0).The body of
POST /v2/sealedbox/open.The body of
POST /v2/sealedbox/seal-pq.The body of
POST /v2/sealedbox/seal.What
POST /v2/sealedbox/seal answers: anonymous public-key encryption (X25519 sealed
box).The body of
POST /v2/secretbox/open.The body of
POST /v2/secretbox/seal.What
POST /v2/secretbox/seal answers: encrypt with XChaCha20-Poly1305 (secretbox seal).What
GET / answers: service metadata.The body of
POST /v2/sign.What
POST /v2/sign answers: sign with Ed25519.The body of
POST /v2/pq/slh-dsa/keygen.What
POST /v2/pq/slh-dsa/keygen answers: generate a server-held SLH-DSA key pair (FIPS
205).What
POST /v2/pq/slh-dsa/sign answers: sign with SLH-DSA (FIPS 205).An SLH-DSA (FIPS 205) parameter set.
The body of
POST /v2/pq/slh-dsa/verify.What
POST /v2/pq/slh-dsa/verify answers: verify with SLH-DSA (FIPS 205).The body of
POST /v2/stream/multi-pq-decrypt.What
POST /v2/stream/multi-pq-decrypt answers: decrypt multi-recipient stream with
server-held hybrid post-quantum key.The body of
POST /v2/stream/multi-pq-encrypt.What
POST /v2/stream/multi-pq-encrypt answers: encrypt stream for multiple recipients
with hybrid post-quantum AEAD.The body of
POST /v2/stream/pq-decrypt.What
POST /v2/stream/pq-decrypt answers: decrypt stream with server-held hybrid
post-quantum key.The body of
POST /v2/stream/pq-encrypt.What
POST /v2/stream/pq-encrypt answers: encrypt stream with hybrid post-quantum AEAD.One element of
recipients.One element of
signatures.One element of
items.The body of
POST /v2/stream/sign.What
POST /v2/stream/sign answers: batch sign messages with sub-millisecond throughput.One element of
items.One element of
results.The body of
POST /v2/stream/verify.What
POST /v2/stream/verify answers: batch verify digital signatures.No usable answer arrived: the connection failed, an attempt or the overall deadline timed out,
the calling thread was interrupted, or a 2xx body could not be decoded.
The
trustedKeys member.One field that failed validation, in a
validation-failed problem.The body of
POST /v2/verify.What
POST /v2/verify answers: verify an Ed25519 signature.