Struct ZeroKMSBuilder 

pub struct ZeroKMSBuilder<C, ClientKeyState = ()>
where
    C: Credentials<Token = ServiceToken>,
{ /* private fields */ }

A builder for creating ZeroKMS and ZeroKMSWithClientKey clients.

This provides an ergonomic API for constructing ZeroKMS clients with various configuration options.

Examples

Basic usage

use cipherstash_client::zerokms::ZeroKMSBuilder;
use cipherstash_client::credentials::{StaticCredentials, ServiceToken};
use cts_common::Crn;

let token = ServiceToken::new("your-token".to_string(), 3600);
let credentials = StaticCredentials::new(token);
let crn = Crn::try_from("crn:us-east-1.aws:DCMBTGHEX5R2RMR4")?;

let zerokms = ZeroKMSBuilder::new(crn, credentials)?
    .with_request_timeout(30)
    .with_max_concurrent_reqs(20)
    .build()?;

With client key for encryption/decryption

use cipherstash_client::zerokms::{ZeroKMSBuilder, ClientKey};
use cipherstash_client::credentials::{StaticCredentials, ServiceToken};
use cts_common::Crn;
use uuid::Uuid;

let token = ServiceToken::new("your-token".to_string(), 3600);
let credentials = StaticCredentials::new(token);
let crn = Crn::try_from("crn:us-east-1.aws:DCMBTGHEX5R2RMR4")?;
let client_id = Uuid::parse_str("550e8400-e29b-41d4-a716-446655440000")?;
let client_key = ClientKey::from_hex_v1(client_id, "a4627031...")?;

let zerokms = ZeroKMSBuilder::new(crn, credentials)?
    .with_client_key(client_key)
    .build()?;

Implementations

impl<C> ZeroKMSBuilder<C, ()>

where C: Credentials<Token = ServiceToken>,

pub fn new<T>(crn: T, credentials: C) -> Result<Self, ZeroKMSBuilderError>

where T: TryInto<Crn>, ZeroKMSBuilderError: From<T::Error>,

Create a new ZeroKMSBuilder.

Arguments

• crn - The CRN (CipherStash Resource Name) identifying the workspace and region
• credentials - Credentials provider for obtaining access tokens

Examples

use cipherstash_client::zerokms::ZeroKMSBuilder;
use cipherstash_client::credentials::{StaticCredentials, ServiceToken};
use cts_common::Crn;

let token = ServiceToken::new("your-token".to_string(), 3600);
let credentials = StaticCredentials::new(token);
let crn = "crn:us-east-1.aws:DCMBTGHEX5R2RMR4";

let builder = ZeroKMSBuilder::new(crn, credentials)?;

pub fn with_request_timeout(self, timeout_secs: u64) -> Self

Set the request timeout in seconds.

If not set, defaults to 10 seconds.

Examples

let builder = ZeroKMSBuilder::new(crn, credentials)?
    .with_request_timeout(30);

pub fn with_max_keys_per_req(self, max_keys: usize) -> Self

Set the maximum number of keys per request.

Defaults to 500 if not set.

Examples

let builder = ZeroKMSBuilder::new(crn, credentials)?
    .with_max_keys_per_req(50);

pub fn with_max_concurrent_reqs(self, max_concurrent: usize) -> Self

Set the maximum number of concurrent requests.

Defaults to 5 if not set.

Examples

let builder = ZeroKMSBuilder::new(crn, credentials)?
    .with_max_concurrent_reqs(20);

pub fn with_base_url(self, base_url: Url) -> Self

Override the base URL for the ZeroKMS service.

This bypasses the default service discovery mechanism and connects directly to the specified URL. Useful for:

• Connecting to local development servers
• Testing against non-production environments
• Custom deployment configurations

Examples

let builder = ZeroKMSBuilder::new(crn, credentials)?
    .with_base_url(Url::parse("http://localhost:3000")?);

pub fn with_client_key( self, client_key: ClientKey, ) -> ZeroKMSBuilder<C, ClientKey>

Add a client key to enable encryption and decryption operations.

This transforms the builder into one that will build a ZeroKMSWithClientKey instead of a plain ZeroKMS.

Examples

let client_id = Uuid::parse_str("550e8400-e29b-41d4-a716-446655440000")?;
let client_key = ClientKey::from_hex_v1(client_id, "a4627031...")?;

let builder = ZeroKMSBuilder::new(crn, credentials)?
    .with_client_key(client_key);

pub fn build(self) -> Result<ZeroKMS<C>, ZeroKMSBuilderError>

Build a ZeroKMS client.

Examples

let zerokms = ZeroKMSBuilder::new(crn, credentials)?
    .with_request_timeout(30)
    .build()?;

impl<C> ZeroKMSBuilder<C, ClientKey>

where C: Credentials<Token = ServiceToken>,

pub fn build(self) -> Result<ZeroKMSWithClientKey<C>, ZeroKMSBuilderError>

Build a ZeroKMSWithClientKey client.

This is only available after calling with_client_key.

Examples

let client_id = Uuid::parse_str("550e8400-e29b-41d4-a716-446655440000")?;
let client_key = ClientKey::from_hex_v1(client_id, "a4627031...")?;

let zerokms = ZeroKMSBuilder::new(crn, credentials)?
    .with_client_key(client_key)
    .build()?;