Struct openmls::key_packages::KeyPackage

pub struct KeyPackage { /* private fields */ }

The key package struct.

Implementations

impl KeyPackage

pub fn verify(
    &self,
    backend: &impl OpenMlsCryptoProvider
) -> Result<(), KeyPackageVerifyError>

Verify that this key package is valid:

• verify that the signature on this key package is valid
• verify that all mandatory extensions are present
• make sure that the lifetime is valid Returns Ok(()) if all checks succeed and KeyPackageError otherwise

pub fn external_key_id(&self) -> Result<&[u8], ExtensionError>

Get the external ID of this key package as byte slice. See ExternalKeyIdExtension for more details on the external key ID extension.

Returns a ExtensionError if no external key ID extension is present.

pub fn extensions(&self) -> &[Extension]

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 credential(&self) -> &Credential

Get a reference to the Credential.

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

Compute the KeyPackageRef of this KeyPackage. The KeyPackageRef is used to identify a member in a group (leaf in the tree) within MLS.

pub fn ciphersuite(&self) -> Ciphersuite

Get the Ciphersuite.

impl KeyPackage

This impl block contains no items.

Private KeyPackage functions.

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

Formats the value using the given formatter.

impl Deserialize for KeyPackage

fn tls_deserialize<R: Read>(bytes: &mut R) -> Result<Self, Error>

This function deserializes the bytes from the provided a std::io::Read and returns the populated struct.

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 LeafNode

fn from(key_package: KeyPackage) -> Self

Converts to this type from the input 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 !=.

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 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 Size for KeyPackage

fn tls_serialized_len(&self) -> usize

impl Size for &KeyPackage

fn tls_serialized_len(&self) -> usize

impl TryFrom<&'_ [u8]> for KeyPackage

type Error = Error

The type returned in the event of a conversion error.

fn try_from(bytes: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl Verifiable for KeyPackage

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

Return the unsigned, serialized payload that should be verified.

fn signature(&self) -> &Signature

A reference to the signature to be verified.

fn verify<T>(
    self,
    backend: &impl OpenMlsCryptoProvider,
    credential: &Credential
) -> Result<T, CredentialError> where
    T: VerifiedStruct<Self>, 

Verifies the payload against the given credential. The signature is fetched via the Verifiable::signature() function and the payload via Verifiable::unsigned_payload().

fn verify_with_key<T>(
    self,
    backend: &impl OpenMlsCryptoProvider,
    signature_public_key: &SignaturePublicKey
) -> Result<T, CredentialError> where
    T: VerifiedStruct<Self>, 

Verifies the payload against the given SignatureKey. The signature is fetched via the Verifiable::signature() function and the payload via Verifiable::unsigned_payload().

fn verify_no_out(
    &self,
    backend: &impl OpenMlsCryptoProvider,
    credential: &Credential
) -> Result<(), CredentialError>

Verifies the payload against the given credential. The signature is fetched via the Verifiable::signature() function and the payload via Verifiable::unsigned_payload().