Struct KeyVersionStatus 

pub struct KeyVersionStatus {
    pub active: i32,
    pub configured: Vec<i32>,
    pub in_use: Vec<i32>,
    pub missing: Vec<i32>,
    pub retirable: Vec<i32>,
}

How the configured key ring lines up with what the stored secrets use.

This is what tells an operator whether an old key can be dropped from the configuration, without having to guess.

Examples

use ironflow_store::entities::KeyVersionStatus;

let status = KeyVersionStatus {
    active: 2,
    configured: vec![1, 2],
    in_use: vec![2],
    missing: vec![],
    retirable: vec![1],
};
assert!(status.is_consistent());

Fields

active: i32

Version used to encrypt new secrets.

configured: Vec<i32>

Versions present in the configured key ring, ascending.

in_use: Vec<i32>

Versions actually used by stored secrets, ascending.

missing: Vec<i32>

Versions used by stored secrets but absent from the key ring.

Non-empty means some secrets are unreadable: the server refuses to start in that state.

retirable: Vec<i32>

Versions that can be removed from the key ring safely: configured, not active, and unused by any secret.

Implementations

impl KeyVersionStatus

pub fn is_consistent(&self) -> bool

Whether every stored secret can be decrypted with the current ring.

Examples

use ironflow_store::entities::KeyVersionStatus;

let broken = KeyVersionStatus {
    active: 1,
    configured: vec![1],
    in_use: vec![1, 2],
    missing: vec![2],
    retirable: vec![],
};
assert!(!broken.is_consistent());

Trait Implementations

impl Clone for KeyVersionStatus

fn clone(&self) -> KeyVersionStatus

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KeyVersionStatus

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for KeyVersionStatus

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for KeyVersionStatus

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

where __S: Serializer,

Serialize this value into the given Serde serializer.