Struct Credential

pub struct Credential { /* private fields */ }

Credential.

OpenMLS does not look into credentials and only passes them along. As such they are opaque to the code in OpenMLS and only the basic necessary checks and operations are done.

OpenMLS provides an implementation of the BasicCredential.

This struct contains MLS credential data, where the data depends on the type.

Note: While the credential is opaque to OpenMLS, the library must know how to deserialize it. The implementation only works with credentials that are encoded as variable-sized vectors. Other credentials will cause OpenMLS either to crash or exhibit unexpected behaviour.

struct {
    CredentialType credential_type;
    select (Credential.credential_type) {
        case basic:
            opaque identity<V>;

        case x509:
            Certificate chain<V>;
    };
} Credential;

Implementations

impl Credential

pub fn credential_type(&self) -> CredentialType

Returns the credential type.

pub fn new( credential_type: CredentialType, serialized_credential: Vec<u8>, ) -> Self

Creates and returns a new Credential of the given CredentialType.

pub fn serialized_content(&self) -> &[u8]

Get this serialized credential content.

This is the content of the select statement. It is a TLS serialized vector.

pub fn deserialized<T: Size + Deserialize>(&self) -> Result<T, Error>

Get the credential, deserialized.

Trait Implementations

impl Clone for Credential

fn clone(&self) -> Credential

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Credential

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Credential

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Deserialize for Credential

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.

fn tls_deserialize_exact(bytes: impl AsRef<[u8]>) -> Result<Self, Error>

where Self: Sized,

This function deserializes the provided bytes and returns the populated struct. All bytes must be consumed.

impl DeserializeBytes for Credential

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

This function deserializes the bytes from the provided a &[u8] and returns the populated struct, as well as the remaining slice.

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

where Self: Sized,

This function deserializes the provided bytes and returns the populated struct. All bytes must be consumed.

impl From<BasicCredential> for Credential

fn from(credential: BasicCredential) -> Self

Converts to this type from the input type.

impl PartialEq for Credential

fn eq(&self, other: &Credential) -> 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 &Credential

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

Serialize self and return it as a byte vector.

impl Serialize for Credential

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 Credential

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

Serialize self and return it as a byte vector.

impl Size for &Credential

fn tls_serialized_len(&self) -> usize

impl Size for Credential

fn tls_serialized_len(&self) -> usize

impl TryFrom<Credential> for BasicCredential

type Error = BasicCredentialError

The type returned in the event of a conversion error.

fn try_from(credential: Credential) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Credential

impl StructuralPartialEq for Credential