Crate zerokms_protocol

Re-exports

pub use cipherstash_config;

Modules

testing

Implementations of Dummy for various types in the zerokms-protocol crate.

Structs

CreateClientRequest

Request message to create a new client with the given name, description and keyset_id.

CreateClientResponse

Response message to a CreateClientRequest.

CreateKeysetRequest

Request message to create a new Keyset with the given name and description.

DeleteClientRequest

Request message to delete a client and all associated authority keys.

DeleteClientResponse

DisableKeysetRequest

Request message to disable a keyset. Requires the dataset:disable scope. Response is an EmptyResponse.

EmptyResponse

Represents an empty response for requests that don’t return any data.

EnableKeysetRequest

Request message to enable a keyset that has was previously disabled. Requires the dataset:enable scope. Response is an EmptyResponse.

GenerateKeyRequest

A request message to generate a data key made on behalf of a client in the given keyset.

GenerateKeyResponse

Response to a GenerateKeyRequest.

GenerateKeySpec

A specification for generating a data key used in a GenerateKeyRequest.

GeneratedKey

Represents generated data key material which is used by the client to derive data keys with its own key material.

GrantKeysetRequest

Request message to grant a client access to a keyset. Requires the dataset:grant scope.

KeyId

Keyset

Struct representing a keyset. This is the response to a CreateKeysetRequest and a in a vector in the response to a ListKeysetRequest.

KeysetClient

Response type for a ListClientRequest.

ListClientRequest

Request message to list all clients.

ListKeysetRequest

Request message to list all Keysets.

LoadKeysetRequest

Request to load a keyset on behalf of a client. This is used by clients before indexing or querying data and includes key material which can be derived by the client to generate encrypted index terms.

LoadKeysetResponse

Response to a LoadKeysetRequest. The response includes the key material required to derive data keys. It is analogous to a RetrieveKeyResponse but where the server generated the key.

ModifyKeysetRequest

Request message to modify a keyset with the given keyset_id. name and description are optional and will be updated if provided.

Name

The unique name of a resource (within some scope: e.g. a workspace).

RetrieveKeyRequest

Request to retrieve a data key on behalf of a client in the given keyset. Requires the data_key:retrieve scope. Response is a RetrieveKeyResponse.

RetrieveKeyRequestFallible

Request to retrieve a data key on behalf of a client in the given keyset. Requires the data_key:retrieve scope. Response is a RetrieveKeyResponse.

RetrieveKeyResponse

Response to a RetrieveKeyRequest. Contains a list of RetrievedKeys.

RetrieveKeyResponseFallible

Response to a RetrieveKeyRequest with per-key error handling

RetrieveKeySpec

A specification for retrieving a data key used in a RetrieveKeyRequest.

RetrievedKey

Returned type from a RetrieveKeyRequest.

RevokeKeysetRequest

Request message to revoke a client’s access to a keyset. Requires the dataset:revoke scope. Response is an EmptyResponse.

UnverifiedContext

A loose, schema‑free context map that can carry scalars, arrays, and nested maps.

ViturKeyMaterial

Key material type used in GenerateKeyRequest and RetrieveKeyRequest as well as CreateClientResponse.

ViturRequestError

Re-exports

Enums

ClientKeysetId

Struct representing the keyset ids associated with a client which could be a single keyset or multiple keysets.

Context

Represents a contextual attribute for a data key which is used to “lock” the key to a specific context. Context attributes are included key tag generation which is in turn used as AAD in the final encryption step in the client. Context attributes should never include any sensitive information.

IdentifiedBy

A UUID or textual name that can uniquely identify a resource. Whereas a UUID is a global identifier, name is not implied to be globally unique, but unique within scope implied scope: e.g. a workspace.

UnverifiedContextValue

Any JSON value we need to handle.

ViturRequestErrorKind

Re-exports

Traits

RetryableError

Re-exports

ViturConnection

ViturRequest

ViturResponse