Struct GroupKey 

pub struct GroupKey { /* private fields */ }

Group Key is used to join a group and authorize membership.

Notes:

• Currently only secret-based authentication is implemented.

• Group Id is derived by hashing the secret bytes with the group configuration and the state machine identifier. See GroupId for more details on how the group id is derived.

• During handshake, peers prove knowledge of the secret without revealing the secret itself by generating a proof of knowledge derived from the secret and the shared random value for the link.

Implementations

impl GroupKey

pub const fn new(secret: Digest) -> Self

Creates a new GroupKey from the given secret Digest.

pub fn from_secret(secret: impl Into<Digest>) -> Self

Create a new GroupKey from the given secret UniqueId.

pub fn random() -> Self

Creates a new GroupKey with a randomly generated secret.

pub const fn secret(&self) -> &Digest

Gets the underlying secret UniqueId.

This should never be transmitted over the network, only proofs of knowledge should be sent.

pub fn validate_proof( &self, link: &Link<Groups>, proof: Digest, group_id: GroupId, ) -> bool

Validates the validity of the authentication proof contained in this handshake message against the provided group key and link.

pub fn generate_proof( &self, link: &Link<Groups>, peer_id: PeerId, group_id: GroupId, ) -> Digest

Generates a proof of knowledge of the secret key for the given peer and link.

Trait Implementations

impl Clone for GroupKey

fn clone(&self) -> GroupKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GroupKey

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GroupKey

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for GroupKey

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

Formats the value using the given formatter.

impl From<&Digest> for GroupKey

fn from(secret: &Digest) -> Self

Converts to this type from the input type.

impl<T: TicketValidator + ?Sized> From<&T> for GroupKey

fn from(validator: &T) -> Self

Converts to this type from the input type.

impl From<Digest> for GroupKey

fn from(secret: Digest) -> Self

Converts to this type from the input type.

impl Hash for GroupKey

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for GroupKey

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for GroupKey

impl Eq for GroupKey

impl StructuralPartialEq for GroupKey