Skip to main content

MemberKeys

Struct MemberKeys 

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

A member’s Ed25519 signing pair and independent X25519 sealing pair (Appendix D). Both secrets erase on drop. Clone is needed by in-memory custody to keep its keys while returning an independently owned unlocked pair.

Implementations§

Source§

impl MemberKeys

Source

pub const SECRET_LEN: usize = MEMBER_KEYS_LENGTH

The length of to_secret_bytes.

Source

pub fn from_seed(seed: u8) -> Self

A pair whose signing and sealing seeds are both seed: public test data, never a person’s keys.

Source

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

Make both member key pairs using the operating system’s randomness.

Source

pub fn public_keys(&self) -> MemberPublicKeys

The public pair admin entries bind to a stable member id (§10).

Source

pub fn sign(&self, bytes: &[u8]) -> Signature

Sign bytes with the member’s Ed25519 pair (§12).

Source

pub fn sign_object(&self, path: &str, digest: &ObjectDigest) -> Signature

Sign the digest of every object byte before the signature (Appendix D.3). Feed the prefix, length fields and sealed chunks to crate::ObjectHasher in storage order. The signed message binds its domain, path and digest. Panics if the storage path is empty.

A file’s content hash cannot stand in for an object’s digest.

ⓘ
use coven_crypto::{ContentHasher, MemberKeys};
let member = MemberKeys::generate().unwrap();
member.sign_object("10101010-1010-1010-1010-101010101010/seq/1", &ContentHasher::new().finish());
Source

pub fn sign_prefix(&self, path: &str, prefix: &[u8]) -> Signature

Sign a snapshot’s exact kind, version and routing fields (D9). The prefix domain and path are bound separately from whole-object signing. Panics if the storage path is empty.

Source

pub fn sign_write_header( &self, path: &str, prefix: &[u8], header: &[u8], roots: &[[u8; 32]], ) -> Signature

Sign a write’s cleartext prefix, sealed header chunk and part roots (D9), separately from the whole-object signature. Panics if the storage path is empty.

Source

pub fn to_secret_bytes(&self) -> SecretBytes

Encode both private seeds for custody or the person’s restore code (§13.1).

Source

pub fn from_secret_bytes(bytes: &[u8]) -> Result<Self, MaterialError>

Restore both pairs from custody or the person’s restore code (§13.1).

Source

pub fn open_store_key( &self, path: &str, prefix: &[u8], sealed: &[u8], ) -> Result<StoreKey, CryptoError>

Open a store-key box, authenticating the exact path and opaque clear prefix. Format checks the recipient and opened identity; the caller checks the introduction commitment before accepting the candidate key. Panics if the storage path is empty.

Source

pub fn open_circle_key( &self, path: &str, prefix: &[u8], sealed: &[u8], ) -> Result<CircleKey, CryptoError>

Open a circle-key box, authenticating the exact path and opaque clear prefix. Format checks the recipient and opened identity; the caller checks the introduction commitment before accepting the candidate key. Panics if the storage path is empty.

Source

pub fn open_own_circle_key( &self, binding: &[u8], sealed: &[u8], ) -> Result<CircleKey, CryptoError>

Open the copy of a circle key a joining request carries for its own member, sealed by seal_own_circle_key with the same binding (D11). It binds no slot path, so it opens wherever its bytes are found, and only for the sealing key it was sealed to.

Source

pub fn open_handover( &self, path: &str, prefix: &[u8], sealed: &[u8], ) -> Result<Zeroizing<Vec<u8>>, CryptoError>

Open a pairing’s handover: the ephemeral key, nonce, ciphertext and tag seal_handover returned, at the exact path and clear prefix it was sealed for, with the private half of the sealing key it was sealed to (D11). The plaintext is erased on drop. Panics if the storage path is empty.

Trait Implementations§

Source§

impl Clone for MemberKeys

Source§

fn clone(&self) -> Self

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 MemberKeys

Source§

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

Formats the value using the given formatter. 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> 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
§

impl<T> ErasedDestructor for T
where T: 'static,

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 = !

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

fn try_from(value: U) -> Result<T, !>

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