Struct X25519PublicKey 

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

A public key for X25519 key agreement operations.

X25519 is an elliptic-curve Diffie-Hellman key exchange protocol based on Curve25519 as defined in RFC 7748. It allows two parties to establish a shared secret key over an insecure channel.

The X25519 public key is generated from a corresponding private key and is designed to be:

• Compact (32 bytes)
• Fast to use in key agreement operations
• Resistant to various cryptographic attacks

This implementation provides:

• Creation of X25519 public keys from raw data
• CBOR serialization and deserialization
• Support for the Encrypter trait for key encapsulation
• Various utility and conversion methods

Implementations

impl X25519PublicKey

pub const KEY_SIZE: usize = 32usize

pub const fn from_data(data: [u8; 32]) -> Self

Restore an X25519PublicKey from a fixed-size array of bytes.

pub fn from_data_ref(data: impl AsRef<[u8]>) -> Result<Self>

Restore an X25519PublicKey from a reference to an array of bytes.

pub fn data(&self) -> &[u8; 32]

Get a reference to the fixed-size array of bytes.

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

Get the X25519 public key as a byte slice.

pub fn from_hex(hex: impl AsRef<str>) -> Self

Restore an X25519PublicKey from a hex string.

Panics

Panics if the hex string is invalid or the length is not X25519PublicKey::KEY_SIZE * 2.

pub fn hex(&self) -> String

Get the hex string representation of the X25519PublicKey.

Trait Implementations

impl AsRef<[u8]> for X25519PublicKey

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<X25519PublicKey> for X25519PublicKey

Implements AsRef<X25519PublicKey> to allow self-reference.

fn as_ref(&self) -> &X25519PublicKey

Converts this type into a shared reference of the (usually inferred) input type.

impl CBORTagged for X25519PublicKey

Implements the CBORTagged trait to provide CBOR tag information.

fn cbor_tags() -> Vec<Tag>

Returns the CBOR tags associated with this type.

impl CBORTaggedDecodable for X25519PublicKey

Implements CBORTaggedDecodable to provide CBOR decoding functionality.

fn from_untagged_cbor(untagged_cbor: CBOR) -> Result<Self>

Creates an instance of this type by decoding it from untagged CBOR.

fn from_tagged_cbor(cbor: CBOR) -> Result<Self, Error>

where Self: Sized,

Creates an instance of this type by decoding it from tagged CBOR.

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

where Self: Sized,

Creates an instance of this type by decoding it from binary encoded tagged CBOR.

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

where Self: Sized,

Creates an instance of this type by decoding it from binary encoded untagged CBOR.

impl CBORTaggedEncodable for X25519PublicKey

Implements CBORTaggedEncodable to provide CBOR encoding functionality.

fn untagged_cbor(&self) -> CBOR

Returns the untagged CBOR encoding of this instance.

fn tagged_cbor(&self) -> CBOR

Returns the tagged CBOR encoding of this instance.

fn tagged_cbor_data(&self) -> Vec<u8>

Returns the tagged value in CBOR binary representation.

impl Clone for X25519PublicKey

fn clone(&self) -> X25519PublicKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for X25519PublicKey

Implements Debug to output the key with a type label.

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

Formats the value using the given formatter.

impl Display for X25519PublicKey

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

Formats the value using the given formatter.

impl Encrypter for X25519PublicKey

Implements the Encrypter trait to support key encapsulation mechanisms.

fn encapsulation_public_key(&self) -> EncapsulationPublicKey

Returns the encapsulation public key for this encrypter.

fn encapsulate_new_shared_secret( &self, ) -> (SymmetricKey, EncapsulationCiphertext)

Encapsulates a new shared secret for the recipient.

impl<'a> From<&'a X25519PublicKey> for &'a [u8; 32]

Implements conversion from an X25519PublicKey reference to a byte array reference.

fn from(value: &'a X25519PublicKey) -> Self

Converts to this type from the input type.

impl From<&X25519PublicKey> for Vec<u8>

Implements conversion from an X25519PublicKey reference to a byte vector.

fn from(key: &X25519PublicKey) -> Self

Converts to this type from the input type.

impl From<&X25519PublicKey> for X25519PublicKey

Implements conversion from an X25519PublicKey reference to an owned X25519PublicKey.

fn from(key: &X25519PublicKey) -> Self

Converts to this type from the input type.

impl From<Rc<X25519PublicKey>> for X25519PublicKey

Implements conversion from a reference-counted X25519PublicKey to an owned X25519PublicKey.

fn from(value: Rc<X25519PublicKey>) -> Self

Converts to this type from the input type.

impl From<X25519PublicKey> for CBOR

Implements conversion from X25519PublicKey to CBOR for serialization.

fn from(value: X25519PublicKey) -> Self

Converts to this type from the input type.

impl From<X25519PublicKey> for Vec<u8>

Implements conversion from an X25519PublicKey to a byte vector.

fn from(key: X25519PublicKey) -> Self

Converts to this type from the input type.

impl Hash for X25519PublicKey

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 X25519PublicKey

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

Implements ReferenceProvider to provide a unique reference for the key.

fn reference(&self) -> Reference

Returns a cryptographic reference that uniquely identifies this object.

fn ref_hex(&self) -> String

Returns the reference data as a hexadecimal string.

fn ref_data_short(&self) -> [u8; 4]

Returns the first four bytes of the reference.

fn ref_hex_short(&self) -> String

Returns the first four bytes of the reference as a hexadecimal string.

fn ref_bytewords(&self, prefix: Option<&str>) -> String

Returns the first four bytes of the reference as upper-case ByteWords.

fn ref_bytemoji(&self, prefix: Option<&str>) -> String

Returns the first four bytes of the reference as Bytemoji.

impl TryFrom<CBOR> for X25519PublicKey

Implements TryFrom<CBOR> for X25519PublicKey to support conversion from CBOR data.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(cbor: CBOR) -> Result<Self>

Performs the conversion.

impl Eq for X25519PublicKey

impl StructuralPartialEq for X25519PublicKey