pub struct LocalVaultKeyStorage { /* private fields */ }
Expand description

Stores vault key locally on disk. This is in general considered insecure, and shouldn’t be used without careful consideration.

The primary goal of encryption within BonsaiDb is to offer limited encryption at-rest. Within these goals, the primary attack vector being protected against is an attacker being able to copy the data off of the disks, either by physically gaining access to the drives or having filesystem access. By storing the vault key on the same physical media, the encryption should be considered insecure because if you can gain access to the data, you have access to the keys as well.

For production environments, it is much more secure to store the vault key in a separate location. We recommand any S3-compatible backend.

Implementations§

source§

impl LocalVaultKeyStorage

source

pub fn new<P: AsRef<Path>>(path: P) -> Result<Self, Error>

Creates a new file-based vaultr key storage, storing files within path. The path provided shouod be a directory. If it doesn’t exist, it will be created.

Trait Implementations§

source§

impl Clone for LocalVaultKeyStorage

source§

fn clone(&self) -> LocalVaultKeyStorage

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for LocalVaultKeyStorage

source§

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

Formats the value using the given formatter. Read more
source§

impl VaultKeyStorage for LocalVaultKeyStorage

§

type Error = LocalVaultKeyStorageError

The error type that the functions return.
source§

fn vault_key_for( &self, server_id: StorageId ) -> Result<Option<KeyPair>, Self::Error>

Retrieve all previously stored vault key for a given storage id.
source§

fn set_vault_key_for( &self, server_id: StorageId, key: KeyPair ) -> Result<(), Self::Error>

Store a key. Each server id should have unique storage.

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> AnyVaultKeyStorage for T
where T: VaultKeyStorage + 'static,

source§

fn vault_key_for(&self, server_id: StorageId) -> Result<Option<KeyPair>, Error>

Retrieve all previously stored master keys for a given storage id.
source§

fn set_vault_key_for( &self, server_id: StorageId, key: KeyPair ) -> Result<(), Error>

Store a key. Each server id should have unique storage. The keys are uniquely encrypted per storage id and can only be decrypted by keys contained in the storage itself.
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more