Struct Invite 

pub struct Invite {
    sealed_invite_data: DataEnvelope,
    invite_key_sealed_invite_data_cek: SymmetricKeyEnvelope,
    invite_secret_sealed_invite_key: SecretProtectedKeyEnvelope,
    invite_key_sealed_organization_key: Option<SymmetricKeyEnvelope>,
    organization_key_sealed_invite_key: EncString,
}

Cryptographic invite for an organization, built around an XAES-256-GCM invite key that acts as the hub tying everything together. See the module-level docs for the overall diagram.

Fields

sealed_invite_data: DataEnvelope

The InviteData (org public-key thumbprint + invite secret) sealed with its own content-encryption key (CEK).

invite_key_sealed_invite_data_cek: SymmetricKeyEnvelope

The invite-data content-encryption key sealed with the invite key, so a holder of the invite key can recover the CEK and open Self::sealed_invite_data.

invite_secret_sealed_invite_key: SecretProtectedKeyEnvelope

The invite key sealed with the high-entropy invite secret, letting an invitee (who holds only the invite secret from the link) recover the invite key.

invite_key_sealed_organization_key: Option<SymmetricKeyEnvelope>

The organization key sealed with the invite key, letting a redeeming invitee recover the organization key once they hold the invite key. This is optional: its presence is what “confirmation” means. When confirmation is enabled the invitee can self-confirm by recovering the organization key; when disabled, this field is absent and an admin must confirm the invitee out of band.

organization_key_sealed_invite_key: EncString

The invite key sealed with the organization key, letting anyone holding the organization key recover the invite key (and thus the invite data).

Implementations

impl Invite

pub fn unseal_invite_key_with_organization_key<Ids: KeySlotIds>( &self, organization_key: Ids::Symmetric, ctx: &mut KeyStoreContext<'_, Ids>, ) -> Result<Ids::Symmetric, InviteKeyBundleError>

Recovers the invite key using the organization key

pub fn unseal_invite_key_with_invite_secret<Ids: KeySlotIds>( &self, invite_secret: &InviteSecret, ctx: &mut KeyStoreContext<'_, Ids>, ) -> Result<Ids::Symmetric, InviteKeyBundleError>

Recovers the invite key from the invite secret

fn unseal_invite_data<Ids: KeySlotIds>( &self, invite_key: Ids::Symmetric, ctx: &mut KeyStoreContext<'_, Ids>, ) -> Result<InviteDataV1, InviteKeyBundleError>

Unseals the InviteDataV1 using an invite key

pub fn get_invite_secret<Ids: KeySlotIds>( &self, invite_key: Ids::Symmetric, ctx: &mut KeyStoreContext<'_, Ids>, ) -> Result<InviteSecret, InviteKeyBundleError>

Recovers the InviteSecret using an invite key

pub fn get_public_key_thumbprint<Ids: KeySlotIds>( &self, invite_key: Ids::Symmetric, ctx: &mut KeyStoreContext<'_, Ids>, ) -> Result<CoseKeyThumbprint, InviteKeyBundleError>

Recovers the organization public-key thumbprint bound into the invite using an invite key

pub fn supports_confirmation(&self) -> bool

Whether confirmation is enabled on this invite, i.e. whether the organization key can be recovered from the invite key.

pub fn unseal_organization_key<Ids: KeySlotIds>( &self, invite_key: Ids::Symmetric, ctx: &mut KeyStoreContext<'_, Ids>, ) -> Result<Ids::Symmetric, InviteKeyBundleError>

Unseals the organization key using an invite key, storing it in the key store context and returning its id.

pub fn enable_confirmation<Ids: KeySlotIds>( &mut self, organization_key: Ids::Symmetric, ctx: &mut KeyStoreContext<'_, Ids>, ) -> Result<(), InviteKeyBundleError>

Enables confirmation

pub fn disable_confirmation(&mut self)

Disables confirmation

pub fn make_for_private_key<Ids: KeySlotIds>( organization_key: Ids::Symmetric, wrapped_organization_private_key: &EncString, ctx: &mut KeyStoreContext<'_, Ids>, ) -> Result<(InviteSecret, Invite), InviteKeyBundleError>

Generates a brand new invite around a new invite key. The invite is sealed for the provided organization key and bound to the organization’s public-key thumbprint (see Invite).

wrapped_organization_private_key is the organization’s private key wrapped with organization_key; the public-key thumbprint bound into the invite is derived from it.

Returns the raw InviteSecret (which MUST NOT be sent to the server) together with the server-safe Invite.

Trait Implementations

impl Clone for Invite

fn clone(&self) -> Invite

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Invite

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Invite

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&Invite> for String

fn from(invite: &Invite) -> Self

Converts to this type from the input type.

impl FromStr for Invite

type Err = InviteKeyBundleError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Serialize for Invite

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.