Struct sheesy_vault::Vault

pub struct Vault {
    pub name: Option<String>,
    pub kind: VaultKind,
    pub index: usize,
    pub partitions: Vec<Vault>,
    pub resolved_at: PathBuf,
    pub vault_path: Option<PathBuf>,
    pub auto_import: Option<bool>,
    pub trust_model: Option<TrustModel>,
    pub secrets: PathBuf,
    pub gpg_keys: Option<PathBuf>,
    pub recipients: PathBuf,
}

Fields

name: Option<String>

kind: VaultKind

index: usize

partitions: Vec<Vault>

resolved_at: PathBuf

vault_path: Option<PathBuf>

auto_import: Option<bool>

trust_model: Option<TrustModel>

secrets: PathBuf

gpg_keys: Option<PathBuf>

recipients: PathBuf

Implementations

impl Vault

pub fn from_file(path: &Path) -> Result<Vec<Vault>, Error>

pub fn set_resolved_at(self, vault_file: &Path) -> Result<Self, Error>

pub fn validate(&self) -> Result<(), Error>

pub fn to_file(&self, path: &Path, mode: WriteMode) -> Result<(), VaultError>

pub fn absolute_path(&self, path: &Path) -> PathBuf

pub fn secrets_path(&self) -> PathBuf

pub fn url(&self) -> String

pub fn print_resources(&self, w: &mut dyn Write) -> Result<(), Error>

pub fn write_recipients_list(
    &self,
    recipients: &mut Vec<String>
) -> Result<PathBuf, Error>

pub fn recipients_path(&self) -> PathBuf

pub fn recipients_list(&self) -> Result<Vec<String>, Error>

pub fn keys_by_ids(
    &self,
    ctx: &mut Context,
    ids: &[String],
    type_of_ids_for_errors: &str,
    gpg_keys_dir: Option<&Path>,
    output: &mut dyn Write
) -> Result<Vec<Key>, Error>

pub fn recipient_keys(
    &self,
    ctx: &mut Context,
    gpg_keys_dir: Option<&Path>,
    output: &mut dyn Write
) -> Result<Vec<Key>, Error>

pub fn find_gpg_keys_dir(&self) -> Result<PathBuf, Error>

TODO: change this to be similar to find_trust_model() as it's OK to let partitions override the master vault settings

pub fn gpg_keys_dir_for_auto_import(&self, partition: &Vault) -> Option<PathBuf>

pub fn gpg_keys_dir(&self) -> Result<PathBuf, Error>

impl Vault

pub fn init(
    secrets: &Path,
    gpg_key_ids: &[String],
    gpg_keys_dir: &Path,
    recipients_file: &Path,
    vault_path: &Path,
    name: Option<String>,
    trust_model: Option<TrustModel>,
    auto_import: Option<bool>,
    output: &mut dyn Write
) -> Result<Self, Error>

impl Vault

pub fn all_in_order(&self) -> Vec<&Vault>

pub fn serialize(&self) -> Result<(), Error>

pub fn partition_index<'a, I>(
    selector: &str,
    partitions: I,
    leader_index: Option<usize>
) -> Result<usize, Error> where
    I: IntoIterator<Item = &'a Vault>, 

pub fn remove_partition(
    &mut self,
    selector: &str,
    output: &mut dyn Write
) -> Result<(), Error>

pub fn add_partition(
    &mut self,
    path: &Path,
    name: Option<&str>,
    gpg_key_ids: &[String],
    recipients_file: Option<&Path>,
    output: &mut dyn Write
) -> Result<(), Error>

impl Vault

pub fn add_recipients(
    &self,
    gpg_key_ids: &[String],
    sign: SigningMode,
    signing_key_id: Option<&str>,
    partitions: &[String],
    output: &mut dyn Write
) -> Result<(), Error>

pub fn find_trust_model(&self, partition: &Vault) -> TrustModel

pub fn partitions_by_name_or_path(
    &self,
    partitions: &[String]
) -> Result<Vec<&Vault>, Error>

impl Vault

pub fn init_recipients(
    &self,
    gpg_key_ids: &[String],
    output: &mut dyn Write
) -> Result<(), Error>

pub fn print_recipients(
    &self,
    output: &mut dyn Write,
    error: &mut dyn Write
) -> Result<(), Error>

impl Vault

pub fn remove_recipients(
    &self,
    gpg_key_ids: &[String],
    partitions: &[String],
    output: &mut dyn Write
) -> Result<(), Error>

impl Vault

pub fn import_keys(
    &self,
    gpg_ctx: &mut Context,
    gpg_keys_dir: &Path,
    gpg_key_ids: &[String],
    output: &mut dyn Write
) -> Result<Vec<String>, Error>

pub fn find_signing_key(
    &self,
    ctx: &mut Context,
    signing_key_id: Option<&str>
) -> Result<Key, Error>

pub fn read_fingerprint_file(
    &self,
    fpr: &str,
    gpg_keys_dir: &Path
) -> Result<(PathBuf, Vec<u8>), Error>

pub fn reencrypt(
    &self,
    ctx: &mut Context,
    model: &TrustModel,
    gpg_keys_dir: Option<&Path>,
    has_multiple_partitions: bool,
    output: &mut dyn Write
) -> Result<(), Error>

impl Vault

pub fn edit(
    &self,
    path: &Path,
    editor: &Path,
    mode: CreateMode,
    try_encrypt: bool,
    output: &mut dyn Write
) -> Result<(), Error>

pub fn decrypt(&self, path: &Path, w: &mut dyn Write) -> Result<PathBuf, Error>

pub fn remove(
    &self,
    specs: &[PathBuf],
    output: &mut dyn Write
) -> Result<(), Error>

pub fn encrypt_buffer(
    &self,
    input: &[u8],
    gpg_keys_dir: Option<&Path>,
    output: &mut dyn Write
) -> Result<Vec<u8>, Error>

pub fn partition_by_owned_path(
    &self,
    path: PathBuf
) -> Result<(&Vault, PathBuf), Error>

pub fn partition_by_owned_spec(
    &self,
    spec: VaultSpec
) -> Result<(&Vault, VaultSpec), Error>

pub fn partition_by_spec(
    &self,
    spec: &VaultSpec
) -> Result<(&Vault, VaultSpec), Error>

pub fn encrypt(
    &self,
    specs: &[VaultSpec],
    mode: WriteMode,
    dst_mode: Destination,
    output: &mut dyn Write
) -> Result<(), Error>

Trait Implementations

impl Clone for Vault

fn clone(&self) -> Vault

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Vault

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

Formats the value using the given formatter.

impl Default for Vault

fn default() -> Self

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for Vault

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Eq for Vault

impl Hash for Vault

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl PartialEq<Vault> for Vault

fn eq(&self, other: &Vault) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Vault) -> bool

This method tests for !=.

impl Serialize for Vault

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralEq for Vault

impl StructuralPartialEq for Vault