Skip to main content

Salter

Struct Salter 

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

Salter is Matter subclass to maintain random salt for secrets (private keys) Its .raw is random salt, .code as cipher suite for salt

To initialize with deterministic salt pass in 16 bytes for raw: salter = Salter::new(Some(b“0123456789abcdef“), None, None).unwrap();

To create a deterministic secret, seed, or private key from salt call .signer: signer = salter.signer(Some(mtr_dex::ED25519_SEED), Some(true), “”, None, false).unwrap();

Implementations§

Source§

impl Salter

Source

pub fn new( raw: Option<&[u8]>, code: Option<&str>, tier: Option<Tiers>, ) -> Result<Self, MatterError>

Initialize salter’s raw and code

Source

pub fn stretch( &self, size: usize, path: &str, tier: Option<&Tiers>, temp: bool, ) -> Result<Vec<u8>, MatterError>

Returns raw binary seed (secret) derived from path and .raw and stretched to size given by code using argon2id stretching algorithm.

Source

pub fn signer( &self, code: Option<&str>, transferable: Option<bool>, path: &str, tier: Option<&Tiers>, temp: bool, ) -> Result<Signer, MatterError>

Returns Signer instance whose .raw secret is derived from path and salter’s .raw and stretched to size given by code. The signers public key for its .verfer is derived from code and transferable.

Source

pub fn signers( &self, count: usize, start: usize, path: &str, code: Option<&str>, transferable: Option<bool>, tier: Option<&Tiers>, temp: bool, ) -> Result<Vec<Signer>, MatterError>

Returns vector of count number of Signer instances with unique derivation path made from path prefix and suffix of start plus offset for each count value from 0 to count - 1.

Source

pub fn tier(&self) -> &Tiers

Source

pub fn from_qb64_and_tier( data: &str, tier: Option<Tiers>, ) -> Result<Self, MatterError>

Trait Implementations§

Source§

impl Clone for Salter

Source§

fn clone(&self) -> Salter

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Salter

Source§

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

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

impl Matter for Salter

Source§

fn code(&self) -> &str

Returns the hard part of the derivation code
Source§

fn raw(&self) -> &[u8] ⓘ

Returns raw crypto material (without derivation code)
Source§

fn qb64(&self) -> String

Returns base64 fully qualified representation
Source§

fn qb64b(&self) -> Vec<u8> ⓘ

Returns base64 fully qualified representation
Source§

fn qb2(&self) -> Vec<u8> ⓘ

Returns binary fully qualified representation
Source§

fn soft(&self) -> &str

Soft portion of qb64 value
Source§

fn full_size(&self) -> usize

Return the full size of this Matter instance
Source§

fn size(&self) -> usize

Calculate the populated size
Source§

fn is_transferable(&self) -> bool

Returns whether the derivation code is transferable
Source§

fn is_digestive(&self) -> bool

Returns whether the code represents a digest
Source§

fn is_prefixive(&self) -> bool

Returns whether the code represents a prefix
Source§

fn is_special(&self) -> bool

Returns whether the code represents a prefix
Source§

fn as_any(&self) -> &dyn Any

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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

Source§

type Output = T

Should always be Self
Source§

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

Source§

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

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

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