Struct HighEntropySecret 

pub struct HighEntropySecret {
    secret: Zeroizing<Vec<u8>>,
}

A secret that is guaranteed to be high-entropy, and therefore safe to use as input keying material for a cheap KDF.

Fields

secret: Zeroizing<Vec<u8>>

Implementations

impl HighEntropySecret

pub fn from<T: HighEntropySecretSource>(secret: T) -> Self

Constructs a HighEntropySecret from any HighEntropySecretSource, whose implementation guarantees the provided bytes are high-entropy.

pub(crate) fn from_internal(secret: &[u8]) -> Self

pub fn make(desired_size: usize) -> Result<Self, HighEntropySecretError>

Generates a new high-entropy secret of the desired size, using cryptographically secure random bytes. The generated bytes are high-entropy by construction.

desired_size should be at least 16 bytes to provide adequate security headroom.

pub(crate) fn as_bytes(&self) -> SensitiveSlice<'_>

Returns the secret bytes as a redacted [SensitiveSlice]. Not public since callers should not handle the raw secret material directly.

Trait Implementations

impl Clone for HighEntropySecret

fn clone(&self) -> HighEntropySecret

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<UT> ConvertError<UT> for HighEntropySecret

fn try_convert_unexpected_callback_error( e: UnexpectedUniFFICallbackError, ) -> Result<Self>

impl Debug for HighEntropySecret

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

Formats the value using the given formatter.

impl<UT> FfiConverter<UT> for HighEntropySecret

const TYPE_ID_META: MetadataBuffer

Type ID metadata, serialized into a [MetadataBuffer].

type FfiType = <Vec<u8> as Lower<UniFfiTag>>::FfiType

The low-level type used for passing values of this type over the FFI.

fn lower(obj: HighEntropySecret) -> Self::FfiType

Lower a rust value of the target type, into an FFI value of type Self::FfiType.

fn try_lift(v: Self::FfiType) -> Result<HighEntropySecret>

Lift a rust value of the target type, from an FFI value of type Self::FfiType.

fn write(obj: HighEntropySecret, buf: &mut Vec<u8>)

Write a rust value into a buffer, to send over the FFI in serialized form.

fn try_read(buf: &mut &[u8]) -> Result<HighEntropySecret>

Read a rust value from a buffer, received over the FFI in serialized form.

impl FromWasmAbi for HighEntropySecret

Available on crate feature wasm only.

type Abi = <String as FromWasmAbi>::Abi

The Wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(abi: Self::Abi) -> Self

Recover a Self from Self::Abi.

impl IntoWasmAbi for HighEntropySecret

Available on crate feature wasm only.

type Abi = <String as IntoWasmAbi>::Abi

The Wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl<UT> Lift<UT> for HighEntropySecret

type FfiType = <HighEntropySecret as FfiConverter<UT>>::FfiType

fn try_lift(v: Self::FfiType) -> Result<Self>

fn try_read(buf: &mut &[u8]) -> Result<Self>

fn try_lift_from_rust_buffer(v: RustBuffer) -> Result<Self, Error>

Convenience method

impl<UT> LiftRef<UT> for HighEntropySecret

type LiftType = HighEntropySecret

impl<UT> LiftReturn<UT> for HighEntropySecret

type ReturnType = <HighEntropySecret as Lift<UT>>::FfiType

FFI return type for trait interfaces

fn try_lift_successful_return(v: Self::ReturnType) -> Result<Self>

Lift a successfully returned value from a trait interface

fn lift_foreign_return( ffi_return: Self::ReturnType, call_status: RustCallStatus, ) -> Self

Lift a foreign returned value from a trait interface

fn lift_error(_buf: RustBuffer) -> Self

Lift a Rust value for a callback interface method error result

fn handle_callback_unexpected_error(e: UnexpectedUniFFICallbackError) -> Self

Lift a Rust value for an unexpected callback interface error

impl<UT> Lower<UT> for HighEntropySecret

type FfiType = <HighEntropySecret as FfiConverter<UT>>::FfiType

fn lower(obj: Self) -> Self::FfiType

fn write(obj: Self, buf: &mut Vec<u8>)

fn lower_into_rust_buffer(obj: Self) -> RustBuffer

Convenience method

impl<UT> LowerError<UT> for HighEntropySecret

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for HighEntropySecret

type ReturnType = <HighEntropySecret as Lower<UT>>::FfiType

The type that should be returned by scaffolding functions for this type.

fn lower_return(v: Self) -> Result<Self::ReturnType, RustCallError>

Lower the return value from an scaffolding call

fn handle_failed_lift( error: LiftArgsError, ) -> Result<Self::ReturnType, RustCallError>

Lower the return value for failed argument lifts

impl OptionFromWasmAbi for HighEntropySecret

Available on crate feature wasm only.

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl<UT> TypeId<UT> for HighEntropySecret

const TYPE_ID_META: MetadataBuffer

impl WasmDescribe for HighEntropySecret

Available on crate feature wasm only.

fn describe()