Struct EncKeys

pub struct EncKeys {
    pub enc_key_active: String,
    pub enc_keys: Vec<(String, Vec<u8>)>,
}

Encryption keys used for all operations

These can be either used statically initialized for ease of use, or given dynamically each time. You just need to use the appropriate functions for the EncValue.

Fields

enc_key_active: String

enc_keys: Vec<(String, Vec<u8>)>

Implementations

impl EncKeys

pub fn re_key_id() -> &'static Regex

pub fn try_parse( enc_key_active: String, enc_keys_unparsed: Vec<String>, ) -> Result<Self, CryptrError>

pub fn append_new_random(&mut self) -> Result<(), CryptrError>

Generates and appends a new random encryption key

pub fn append_new_random_with_id( &mut self, id: String, ) -> Result<(), CryptrError>

Generates and appends a new random encryption key with a specific ID

pub async fn config_path() -> Result<String, CryptrError>

Returns the default config path.

Available with feature cli only

pub fn delete(&mut self, enc_key_id: &str) -> Result<(), CryptrError>

Mutate the keys and deletes the key with the given ID, if it exists

pub fn fmt_enc_keys_str_for_config(enc_keys: &str) -> (String, String)

Formats a converted ENC_KEYS string in the correct format for config / K8s secret

This is useful for generating keys somewhere else to paste them into K8s / Docker definitions later on.

Returns 2 values:

1. ENC_KEYS= value for a config or environment variable
2. ENC_KEYS: with an additional base64 encoding which can be used inside a K8s secret directly

pub async fn read_from_config() -> Result<Self, CryptrError>

Reads the keys from the default config

Available with feature cli only

pub fn read_from_file(path: &str) -> Result<Self, CryptrError>

Reads the keys from a given file location on disk

pub fn from_env() -> Result<Self, CryptrError>

Builds the keys from environment variables

Expects 2 values:

1. ENC_KEY_ACTIVE which indicates the active, default key
2. ENC_KEYS with the available keys in the korrect format, for instance:

ENC_KEYS="
z8ycdOXnOv7E/nxOhIuLo1oiQBpcg6lYz2Jkc3TgAYoD7h4+orRdlYAk=
test1337/HQyncjvJUNLTv2YvoTWeVmMKQLBe7+xVSHMXUVES8qE=
"

pub fn keys_as_b64(&self) -> Result<String, CryptrError>

All keys merged into a single String for usage via ENV vars

pub fn keys_as_b64_vec(&self) -> Vec<String>

All keys converted to b64 inside a Vec<_>.

pub async fn save_to_file(&self, file: &str) -> Result<(), CryptrError>

pub async fn save_to_file_with_path( &self, path: &str, file_name: &str, ) -> Result<(), CryptrError>

pub fn get_key(&self, enc_key_id: &str) -> Result<&[u8], CryptrError>

Returns a reference to specified EncKey

pub fn get_static<'a>() -> &'a Self

Returns a reference to the initialized EncKeys.

init() must have been called at application startup for this to succeed.

Panics

If the EncKeys have not been set up at startup with init()

pub fn get_static_key<'a>(enc_key_id: &str) -> Result<&'a [u8], CryptrError>

Returns a reference to specified EncKey

init() must have been called at application startup for this to succeed.

pub fn get_key_active<'a>() -> Result<&'a [u8], CryptrError>

Returns a reference to currently active EncKey

init() must have been called at application startup for this to succeed.

pub fn init(self) -> Result<(), CryptrError>

Initialize the encryption keys statically for ease of use.

This function must be called before accessing EncKeys::get(), or basically with any function that uses the static keys.

Throws an error if called more than once.

pub fn generate() -> Result<Self, CryptrError>

Generates a new random encryption key

pub fn generate_multiple(number_of_keys: u16) -> Result<Self, CryptrError>

Generates a new random set of encryption keys

pub fn generate_with_id(id: String) -> Result<Self, CryptrError>

Generates a new random encryption key with a specific ID

pub fn try_convert_legacy_keys(keys: &str) -> Result<String, CryptrError>

Used for compatibility with the older system

This will convert the old encryption key format into the new one

Trait Implementations

impl<'__de, __Context> BorrowDecode<'__de, __Context> for EncKeys

fn borrow_decode<__D: BorrowDecoder<'__de, Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given BorrowDecode.

impl Debug for EncKeys

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

Formats the value using the given formatter.

impl<__Context> Decode<__Context> for EncKeys

fn decode<__D: Decoder<Context = __Context>>( decoder: &mut __D, ) -> Result<Self, DecodeError>

Attempt to decode this type with the given Decode.

impl Default for EncKeys

fn default() -> EncKeys

Returns the “default value” for a type.

impl Encode for EncKeys

fn encode<__E: Encoder>(&self, encoder: &mut __E) -> Result<(), EncodeError>

Encode a given type.

impl From<KdfValue> for EncKeys

fn from(kdf: KdfValue) -> Self

Converts to this type from the input type.

impl PartialEq for EncKeys

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<&[u8]> for EncKeys

type Error = CryptrError

The type returned in the event of a conversion error.

fn try_from(value: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl StructuralPartialEq for EncKeys