Trait Driver

Source

pub trait Driver: Send + Sync {
    // Required methods
    fn name(&self) -> &str;
    fn get(&self, org: &OrgId, name: &str) -> Result<(Vec<u8>, u64)>;
    fn version(&self, org: &OrgId, name: &str) -> Result<u64>;
    fn inspect(&self, org: &OrgId, name: &str) -> Result<SecretMeta>;
    fn list(&self, org: &OrgId) -> Result<Vec<SecretMeta>>;

    // Provided methods
    fn versions(&self, org: &OrgId, names: &[&str]) -> Vec<Result<u64>> ⓘ { ... }
    fn create(
        &self,
        org: &OrgId,
        name: &str,
        _value: &[u8],
        _labels: &BTreeMap<String, String>,
    ) -> Result<SecretMeta> { ... }
    fn set(&self, org: &OrgId, name: &str, _value: &[u8]) -> Result<u64> { ... }
    fn delete(&self, org: &OrgId, name: &str) -> Result<()> { ... }
    fn refresh(&self, org: &OrgId, name: &str) -> Result<SecretMeta> { ... }
    fn reencrypt(&self, _org: Option<&OrgId>) -> Result<usize> { ... }
}

Expand description

A secret store. Drivers that cannot write (an external vault read through a read-only token) keep the default create/set/delete, which refuse.

Required Methods§

Source

fn name(&self) -> &str

The name compose files and --driver use.

Source

fn get(&self, org: &OrgId, name: &str) -> Result<(Vec<u8>, u64)>

The value and its version.

Source

fn version(&self, org: &OrgId, name: &str) -> Result<u64>

The current version only: cheap, for polling.

Source

fn inspect(&self, org: &OrgId, name: &str) -> Result<SecretMeta>

Source

fn list(&self, org: &OrgId) -> Result<Vec<SecretMeta>>

Every secret in the org this driver holds: metadata, never values.

Provided Methods§

Source

fn versions(&self, org: &OrgId, names: &[&str]) -> Vec<Result<u64>> ⓘ

The current version of each name, in order: one polling round. Drivers whose secrets share a version (every field of a 1Password item) answer each group with one lookup.

Source