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 dataset_id.
CreateClientResponse: Response message to a CreateClientRequest.
CreateDatasetRequest: Request message to create a new Dataset with the given name and description.
Dataset: Struct representing a dataset. This is the response to a CreateDatasetRequest and a in a vector in the response to a ListDatasetRequest.
DatasetClient: Response type for a ListClientRequest.
DeleteClientRequest: Request message to delete a client and all associated authority keys.
DeleteClientResponse
DisableDatasetRequest: Request message to disable a dataset. Requires the dataset:disable scope. Response is an EmptyResponse.
EmptyResponse: Represents an empty response for requests that don’t return any data.
EnableDatasetRequest: Request message to enable a dataset 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 dataset.
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.
GrantDatasetRequest: Request message to grant a client access to a dataset. Requires the dataset:grant scope.
KeyId
ListClientRequest: Request message to list all clients.
ListDatasetRequest: Request message to list all Datasets.
LoadDatasetRequest: Request to load a dataset 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.
LoadDatasetResponse: Response to a LoadDatasetRequest. The response includes the key material required to derive data keys. It is analogous to a RetrieveKeyResponse but where the server generated the key.
ModifyDatasetRequest: Request message to modify a dataset with the given dataset_id. name and description are optional and will be updated if provided.
RetrieveKeyRequest: Request to retrieve a data key on behalf of a client in the given dataset. 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 dataset. 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.
RevokeDatasetRequest: Request message to revoke a client’s access to a dataset. Requires the dataset:revoke scope. Response is an EmptyResponse.
ViturKeyMaterial: Key material type used in GenerateKeyRequest and RetrieveKeyRequest as well as CreateClientResponse.
ViturRequestError: Re-exports

Enums§

ClientDatasetId: Struct representing the dataset ids associated with a client which could be a single dataset or multiple datasets.
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.
ViturRequestErrorKind: Re-exports

Traits§

RetryableError: Re-exports
ViturConnection
ViturRequest
ViturResponse