Struct openmls::key_packages::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 fn delete<KeyStore: OpenMlsKeyStore>( &self, backend: &impl OpenMlsCryptoProvider<KeyStoreProvider = KeyStore> ) -> Result<(), KeyStore::Error>

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<KeyPackageRef, 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) -> &HpkePublicKey

Get the public HPKE init key of this key package.

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

Formats the value using the given formatter.

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

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

Deserialize this value from the given Serde deserializer.

impl From<KeyPackage> for KeyPackageIn

fn from(value: KeyPackage) -> Self

Converts to this type from the input type.

impl From<KeyPackage> for LeafNode

fn from(key_package: KeyPackage) -> Self

Converts to this type from the input type.

impl From<KeyPackage> for MlsMessageOut

fn from(key_package: KeyPackage) -> Self

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

impl PartialEq<KeyPackage> for KeyPackage

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

This method tests for self and other values to be equal, and is used by ==.

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

This method 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: Write>(&self, writer: &mut W) -> Result<usize, Error>

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

Serialize self and return it as a byte vector.

impl Serialize for KeyPackage

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

Serialize this value into the given Serde serializer.

impl Serialize for KeyPackage

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

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

Serialize self and return it as a byte vector.

impl Size for &KeyPackage

fn tls_serialized_len(&self) -> usize

impl Size for KeyPackage

fn tls_serialized_len(&self) -> usize