Struct t_rust_less_lib::api::SecretVersion

pub struct SecretVersion {
    pub secret_id: String,
    pub secret_type: SecretType,
    pub timestamp: ZeroizeDateTime,
    pub name: String,
    pub tags: Vec<String>,
    pub urls: Vec<String>,
    pub properties: SecretProperties,
    pub attachments: Vec<SecretAttachment>,
    pub deleted: bool,
    pub recipients: Vec<String>,
}

SecretVersion holds all information of a specific version of a secret.

Under the hood t-rust-less only stores SecretVersion's, a Secret is no more (or less) than a group-by view over all SecretVersion's. As a rule a SecretVersion shall never be overwritten or modified once stored. To change a Secret just add a new SecretVersion for it.

Fields

secret_id: String

Identifier of the secret this version belongs to. This should be opaque (i.e. not reveal anything about the content whatsoever), e.g. a random string of sufficient length or some sort of UUID will do fine.

By the way, as UUID was mentioned: A time-based UUID will reveal the MAC address of the creator of the Secret as well as when it was created. If you are fine was that, ok, otherwise do not use this kind of UUID.

secret_type: SecretType

General type of the Secret (in this version)

timestamp: ZeroizeDateTime

Timestamp of this version. All SecretVersion's of a Secret a sorted by their timestamps, the last one will be considered the current version.

name: String

Name/title of the Secret (in this version)

tags: Vec<String>

List or arbitrary tags for filtering (or just displaying)

urls: Vec<String>

List of URLs the Secret might be associated with (most commonly the login page where the Secret is needed)

properties: SecretProperties

Generic list of secret properties. The secret_type defines a list of commonly used property-names for that type.

attachments: Vec<SecretAttachment>

List of attachments.

deleted: bool

If this version of the Secret should be marked as deleted. As a rule of thumb it is a very bad idea to just delete secret. Maybe it was deleted by accident, or you might need it for other reasons you have not thought of. Also just deleting a Secret does not make it unseen. The information that someone (or yourself) has once seen this secret might be as valuable as the secret itself.

recipients: Vec<String>

List of recipients that may see this version of the Secret. Again: Once published, it cannot be made unseen. The only safe way to remove a recipient is to change the Secret and create a new version without the recipient.

Implementations

impl SecretVersion

pub fn from_reader(reader: Reader<'_>) -> Result<Self>

pub fn to_builder(&self, builder: Builder<'_>) -> Result<()>

pub fn to_entry_builder(&self, builder: Builder<'_>) -> Result<()>

Trait Implementations

impl Clone for SecretVersion

fn clone(&self) -> SecretVersion

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SecretVersion

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SecretVersion

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

Deserialize this value from the given Serde deserializer.

impl Drop for SecretVersion

fn drop(&mut self)

Executes the destructor for this type.

impl Serialize for SecretVersion

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

Serialize this value into the given Serde serializer.

impl Zeroize for SecretVersion

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not "optimized away" by the compiler.