Struct KeyPackage

pub struct KeyPackage { /* private fields */ }

The key package struct.

Implementations

impl KeyPackage

pub fn builder() -> KeyPackageBuilder

Create a key package builder.

This is provided for convenience. You can also use [KeyPackageBuilder::new].

pub async fn delete<KeyStore>( &self, backend: &impl OpenMlsCryptoProvider<KeyStoreProvider = KeyStore>, ) -> Result<(), KeyPackageDeleteError<<KeyStore as OpenMlsKeyStore>::Error>>

where KeyStore: OpenMlsKeyStore,

Delete this key package and its private key from the key store.

pub fn extensions(&self) -> &Extensions

Get a reference to the extensions of this key package.

pub fn check_extension_support( &self, required_extensions: &[ExtensionType], ) -> Result<(), KeyPackageExtensionSupportError>

Check whether the this key package supports all the required extensions in the provided list.

pub fn hash_ref( &self, backend: &impl OpenMlsCrypto, ) -> Result<HashReference, LibraryError>

Compute the KeyPackageRef of this KeyPackage. The KeyPackageRef is used to identify a new member that should get added to a group.

pub fn ciphersuite(&self) -> Ciphersuite

Get the Ciphersuite.

pub fn leaf_node(&self) -> &LeafNode

Get the [LeafNode] reference.

pub fn hpke_init_key(&self) -> &VLBytes

Get the public HPKE init key of this key package.

impl KeyPackage

This impl block contains no items.

Crate visible KeyPackage functions.

Trait Implementations

impl Clone for KeyPackage

fn clone(&self) -> KeyPackage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KeyPackage

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for KeyPackage

fn deserialize<__D>( __deserializer: __D, ) -> Result<KeyPackage, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<KeyPackage> for KeyPackageIn

fn from(value: KeyPackage) -> KeyPackageIn

Converts to this type from the input type.

impl From<KeyPackageIn> for KeyPackage

fn from(value: KeyPackageIn) -> KeyPackage

Converts to this type from the input type.

impl MlsEntity for KeyPackage

const ID: MlsEntityId = MlsEntityId::KeyPackage

Identifier used to downcast the actual entity within an [OpenMlsKeyStore] method. In case for example you need to select a SQL table depending on the entity type

fn downcast<T>(&self) -> Option<&T>

where T: MlsEntity,

impl PartialEq for KeyPackage

fn eq(&self, other: &KeyPackage) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for &KeyPackage

fn tls_serialize<W>(&self, writer: &mut W) -> Result<usize, Error>

where W: Write,

Serialize self and write it to the writer. The function returns the number of bytes written to writer.

fn tls_serialize_detached(&self) -> Result<Vec<u8>, Error>

Serialize self and return it as a byte vector.

impl Serialize for KeyPackage

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Serialize for KeyPackage

fn tls_serialize<W>(&self, writer: &mut W) -> Result<usize, Error>

where W: Write,

Serialize self and write it to the writer. The function returns the number of bytes written to writer.

fn tls_serialize_detached(&self) -> Result<Vec<u8>, Error>

Serialize self and return it as a byte vector.

impl SignedStruct<KeyPackageTbs> for KeyPackage

fn from_payload(payload: KeyPackageTbs, signature: Signature) -> KeyPackage

Build a signed struct version from the payload struct.

impl Size for &KeyPackage

fn tls_serialized_len(&self) -> usize

impl Size for KeyPackage

fn tls_serialized_len(&self) -> usize

impl VerifiedStruct<VerifiableKeyPackage> for KeyPackage

type SealingType = Seal

This type is used to prevent users of the trait from bypassing verify by simply calling from_verifiable. Seal should be a dummy type defined in a private module as follows: