Struct Capabilities 

pub struct Capabilities { /* private fields */ }

Available on 32-bit or 64-bit only.

Capabilities of LeafNodes.

struct {
    ProtocolVersion versions<V>;
    CipherSuite ciphersuites<V>;
    ExtensionType extensions<V>;
    ProposalType proposals<V>;
    CredentialType credentials<V>;
} Capabilities;

Implementations

impl Capabilities

pub fn new( versions: Option<&[ProtocolVersion]>, ciphersuites: Option<&[Ciphersuite]>, extensions: Option<&[ExtensionType]>, proposals: Option<&[ProposalType]>, credentials: Option<&[CredentialType]>, ) -> Self

Create a new Capabilities struct with the given configuration. Any argument that is None is filled with the default values from the global configuration.

pub fn empty() -> Self

Create new empty Capabilities.

pub fn builder() -> CapabilitiesBuilder

Creates a new CapabilitiesBuilder for constructing Capabilities

pub fn versions(&self) -> &[ProtocolVersion]

Get a reference to the list of versions in this extension.

pub fn ciphersuites(&self) -> &[VerifiableCiphersuite]

Get a reference to the list of ciphersuites in this extension.

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

Get a reference to the list of supported extensions.

pub fn proposals(&self) -> &[ProposalType]

Get a reference to the list of supported proposals.

pub fn credentials(&self) -> &[CredentialType]

Get a reference to the list of supported credential types.

pub fn with_grease(self, rand: &impl OpenMlsRand) -> Self

Add random GREASE values to the capabilities to ensure extensibility.

This adds one random GREASE value to each capability list if no GREASE value is already present:

• Ciphersuites
• Extensions
• Proposals
• Credentials

GREASE values are used per RFC 9420 Section 13.5 to help prevent extensibility failures by ensuring implementations properly handle unknown values.

Example

use openmls::prelude::*;
use openmls_rust_crypto::OpenMlsRustCrypto;

let provider = OpenMlsRustCrypto::default();

// Create capabilities with GREASE values injected
let capabilities = Capabilities::builder()
    .build()
    .with_grease(provider.rand());

// Verify GREASE values were added
assert!(capabilities.ciphersuites().iter().any(|cs| cs.is_grease()));
assert!(capabilities.extensions().iter().any(|ext| ext.is_grease()));
assert!(capabilities.proposals().iter().any(|prop| prop.is_grease()));
assert!(capabilities.credentials().iter().any(|cred| cred.is_grease()));

Trait Implementations

impl Clone for Capabilities

fn clone(&self) -> Capabilities

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Capabilities

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

Formats the value using the given formatter.

impl Default for Capabilities

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Capabilities

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Deserialize for Capabilities

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

Available on crate feature std only.

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,

Available on crate feature std only.

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

impl DeserializeBytes for Capabilities

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 PartialEq for Capabilities

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

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

Available on crate feature std only.

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>

Available on crate feature std only.

Serialize self and return it as a byte vector.

impl Serialize for Capabilities

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 Capabilities

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

Available on crate feature std only.

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>

Available on crate feature std only.

Serialize self and return it as a byte vector.

impl Size for &Capabilities

fn tls_serialized_len(&self) -> usize

impl Size for Capabilities

fn tls_serialized_len(&self) -> usize

impl Eq for Capabilities

impl StructuralPartialEq for Capabilities