Struct ZeroKMSConfig 

pub struct ZeroKMSConfig<ClientKeyState = ()> { /* private fields */ }

Configuration for the ZeroKMS client library.

The ClientKeyState generic is used to specify whether the config has a client key or not. If the client doesn’t have a ClientKey it can’t be used to encrypt or decrypt data.

use cipherstash_client::config::EnvSource;

let config = ZeroKMSConfig::builder()
  .add_source(EnvSource::default())
  .build()
  .expect("failed to build config");

let client = config.create_client();

Implementations

impl ZeroKMSConfig

pub fn builder() -> ZeroKMSConfigBuilder

Create a new ZeroKMSConfigBuilder to build a ZeroKMS used to configure access to ZeroKMS.

use cipherstash_client::{ZeroKMSConfig, config::EnvSource};

let config = ZeroKMSConfig::builder()
    .add_source(EnvSource::default())
    .build()
    .expect("failed to build config");

let client = config.create_client();

In situations where a ClientKey has been configured in the environment. You can use ZeroKMSConfigBuilder::build_with_client_key.

use cipherstash_client::config::EnvSource;

let config = ZeroKMSConfig::builder()
    .add_source(EnvSource::default())
    .build_with_client_key()
    .expect("failed to build config");

let client = config.create_client();

pub fn clone_with_client_key( &self, client_key: ClientKey, ) -> ZeroKMSConfigWithClientKey

Clone the current config and add in a ClientKey.

A ClientKey is required to create a ZeroKMS instance that can be used for encryption and decryption.

pub fn create_client_with_credentials<C>(&self, credentials: C) -> ZeroKMS<C>

where C: Credentials<Token = ServiceToken>,

Create a new ZeroKMS client instance with the provided credentials.

Manually specifying a Service Token

use cipherstash_client::{ZeroKMSConfig, config::EnvSource};
use cipherstash_client::credentials::{ServiceToken, StaticCredentials};

// A service token returned by CTS federation
let token = ServiceToken::new("my-token", 100);

let config = ZeroKMSConfig::builder()
    .add_source(EnvSource::default())
    .build()
    .expect("failed to build config")
    .create_client_with_credentials(StaticCredentials::new(token));

pub fn create_client(&self) -> ZeroKMS<ServiceCredentials>

Create a new ZeroKMS client instance without a client key.

In order to encrypt and decrypt data use ZeroKMS<ClientKey>.

impl ZeroKMSConfig<ClientKey>

pub fn create_client(&self) -> ZeroKMSWithClientKey<ServiceCredentials>

Create a new ZeroKMS client instance that can be used for encryption and decryption.

pub fn create_client_with_credentials<C>( &self, credentials: C, ) -> ZeroKMSWithClientKey<C>

where C: Credentials<Token = ServiceToken>,

impl<T> ZeroKMSConfig<T>

pub fn workspace_dir(&self) -> PathBuf

The configuration directory for the current workspace.

pub fn workspace_id(&self) -> WorkspaceId

The ID of the current workspace.

pub fn token_path(&self) -> PathBuf

The path where the cached service token is stored.

pub fn decryption_log_path(&self) -> Option<PathBuf>

The path to the decryption log file - if enabled.

pub fn base_url(&self) -> &str

The base URL of the ZeroKMS API.

pub fn credentials(&self) -> ServiceCredentials

Return a crate::credentials::Credentials provider that can retrieve an access token to the ZeroKMS API.

Trait Implementations

impl<ClientKeyState: Clone> Clone for ZeroKMSConfig<ClientKeyState>

fn clone(&self) -> ZeroKMSConfig<ClientKeyState>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<ClientKeyState: Debug> Debug for ZeroKMSConfig<ClientKeyState>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.