Struct mls_rs::CipherSuite

pub struct CipherSuite(/* private fields */);

Wrapper type representing a ciphersuite identifier along with default values defined by the MLS RFC. Custom ciphersuites can be defined using a custom CryptoProvider.

Default Ciphersuites

Note: KEM values are defined by the HPKE standard (RFC 9180).

ID	KEM	AEAD	Hash Function	Signature Scheme
1	DHKEMX25519	AES 128	SHA 256	Ed25519
2	DHKEMP256	AES 128	SHA 256	P256
3	DHKEMX25519	ChaCha20Poly1305	SHA 256	Ed25519
4	DHKEMX448	AES 256	SHA 512	Ed448
5	DHKEMP521	AES 256	SHA 512	P521
6	DHKEMX448	ChaCha20Poly1305	SHA 512	Ed448
7	DHKEMP384	AES 256	SHA 512	P384

Implementations

impl CipherSuite

pub const CURVE25519_AES128: CipherSuite = _

MLS_128_DHKEMX25519_AES128GCM_SHA256_Ed25519

pub const P256_AES128: CipherSuite = _

MLS_128_DHKEMP256_AES128GCM_SHA256_P256

pub const CURVE25519_CHACHA: CipherSuite = _

MLS_128_DHKEMX25519_CHACHA20POLY1305_SHA256_Ed25519

pub const CURVE448_AES256: CipherSuite = _

MLS_256_DHKEMX448_AES256GCM_SHA512_Ed448

pub const P521_AES256: CipherSuite = _

MLS_256_DHKEMP521_AES256GCM_SHA512_P521

pub const CURVE448_CHACHA: CipherSuite = _

MLS_256_DHKEMX448_CHACHA20POLY1305_SHA512_Ed448

pub const P384_AES256: CipherSuite = _

MLS_256_DHKEMP384_AES256GCM_SHA384_P384

pub const fn new(value: u16) -> CipherSuite

Ciphersuite from a raw value.

pub const fn raw_value(&self) -> u16

Raw numerical value wrapped value.

pub fn all() -> impl Iterator<Item = CipherSuite>

An iterator over all of the default MLS ciphersuites.

Methods from Deref<Target = u16>

pub const MIN: u16 = 0u16

pub const MAX: u16 = 65_535u16

pub const BITS: u32 = 16u32

Trait Implementations

impl Clone for CipherSuite

fn clone(&self) -> CipherSuite

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CipherSuite

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

Formats the value using the given formatter.

impl Deref for CipherSuite

type Target = u16

The resulting type after dereferencing.

fn deref(&self) -> &<CipherSuite as Deref>::Target

Dereferences the value.

impl From<CipherSuite> for u16

fn from(val: CipherSuite) -> u16

Converts to this type from the input type.

impl From<u16> for CipherSuite

fn from(value: u16) -> CipherSuite

Converts to this type from the input type.

impl MlsDecode for CipherSuite

fn mls_decode(reader: &mut &[u8]) -> Result<CipherSuite, Error>

impl MlsEncode for CipherSuite

fn mls_encode(&self, writer: &mut Vec<u8>) -> Result<(), Error>

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

impl MlsSize for CipherSuite

fn mls_encoded_len(&self) -> usize

impl Ord for CipherSuite

fn cmp(&self, other: &CipherSuite) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for CipherSuite

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

fn partial_cmp(&self, other: &CipherSuite) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for CipherSuite

impl Eq for CipherSuite

impl StructuralPartialEq for CipherSuite