Skip to main content

RawKey

Struct RawKey 

Source
pub struct RawKey { /* private fields */ }
Expand description

Container for raw key material returned by a KeyFetch implementation.

RawKey deliberately exposes no method that returns a borrowed &[u8] to outside the crate. The only consumers of the inner bytes are the fragmentation pipeline and (eventually) the zero-on-drop wrapper introduced in Phase 0.3. From outside key-vault you can construct a RawKey, hand it to the vault, and never see it again.

§Layout

In this phase RawKey stores the bytes in a plain Vec<u8>. Phase 0.3 will swap this for Zeroizing<Vec<u8>> from the zeroize crate without a public API change.

Implementations§

Source§

impl RawKey

Source

pub fn new(bytes: Vec<u8>) -> Self

Wrap a freshly-acquired byte buffer.

Callers are expected to overwrite the original buffer immediately after constructing the RawKey if they kept a copy (for example a stack buffer from read_exact). The vault itself never holds a separate borrow.

Source

pub fn len(&self) -> usize

Number of raw key bytes.

Not redacted — the length of a key does not by itself compromise the secret.

Source

pub fn is_empty(&self) -> bool

Returns true if the key contains zero bytes. A zero-length key is almost always a configuration error; the vault rejects such keys at registration.

Trait Implementations§

Source§

impl Debug for RawKey

Source§

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

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

impl Drop for RawKey

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more

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> 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.

Source§

impl<T> Instrument for T

Source§

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

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

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, U> TryFrom<U> for T
where U: Into<T>,

Source§

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>,

Source§

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.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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