Struct openmls::schedule::psk::PreSharedKeyId

pub struct PreSharedKeyId { /* private fields */ }

A PreSharedKeyID is used to uniquely identify the PSKs that get injected in the key schedule.

// draft-ietf-mls-protocol-19
struct {
  PSKType psktype;
  select (PreSharedKeyID.psktype) {
    case external:
      opaque psk_id<V>;

    case resumption:
      ResumptionPSKUsage usage;
      opaque psk_group_id<V>;
      uint64 psk_epoch;
  };
  opaque psk_nonce<V>;
} PreSharedKeyID;

Implementations

impl PreSharedKeyId

pub fn new( ciphersuite: Ciphersuite, rand: &impl OpenMlsRand, psk: Psk ) -> Result<Self, CryptoError>

Construct a PreSharedKeyID with a random nonce.

pub fn external(psk_id: Vec<u8>, psk_nonce: Vec<u8>) -> Self

Construct an external PreSharedKeyID.

pub fn resumption( usage: ResumptionPskUsage, psk_group_id: GroupId, psk_epoch: GroupEpoch, psk_nonce: Vec<u8> ) -> Self

Construct a resumption PreSharedKeyID.

pub fn psk(&self) -> &Psk

Return the PSK.

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

Return the PSK nonce.

pub fn write_to_key_store<KeyStore: OpenMlsKeyStore>( &self, backend: &impl OpenMlsCryptoProvider<KeyStoreProvider = KeyStore>, ciphersuite: Ciphersuite, psk: &[u8] ) -> Result<(), PskError>

Save this PreSharedKeyId in the keystore.

Note: The nonce is not saved as it must be unique for each time it’s being applied.

Trait Implementations

impl Clone for PreSharedKeyId

fn clone(&self) -> PreSharedKeyId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PreSharedKeyId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PreSharedKeyId

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

Deserialize this value from the given Serde deserializer.

impl Deserialize for PreSharedKeyId

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.

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

This function deserializes the provided bytes and returns the populated struct.

impl Ord for PreSharedKeyId

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<PreSharedKeyId> for PreSharedKeyId

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

fn partial_cmp(&self, other: &PreSharedKeyId) -> 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 Serialize for &PreSharedKeyId

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 PreSharedKeyId

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 PreSharedKeyId

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 &PreSharedKeyId

fn tls_serialized_len(&self) -> usize

impl Size for PreSharedKeyId

fn tls_serialized_len(&self) -> usize

impl Eq for PreSharedKeyId

impl StructuralEq for PreSharedKeyId

impl StructuralPartialEq for PreSharedKeyId