Struct X25519PrivateKey

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

A Curve25519 private key used for X25519 key agreement.

https://datatracker.ietf.org/doc/html/rfc7748

Implementations

impl X25519PrivateKey

pub const KEY_SIZE: usize = 32usize

pub fn new() -> Self

Generate a new random X25519PrivateKey.

pub fn keypair() -> (X25519PrivateKey, X25519PublicKey)

Generate a new random X25519PrivateKey and corresponding X25519PublicKey.

pub fn keypair_using( rng: &mut impl RandomNumberGenerator, ) -> (X25519PrivateKey, X25519PublicKey)

Generate a new random X25519PrivateKey and corresponding X25519PublicKey using the given random number generator.

pub fn new_using(rng: &mut impl RandomNumberGenerator) -> Self

Generate a new random X25519PrivateKey using the given random number generator.

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

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

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

Restore an X25519PrivateKey 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 from_hex(hex: impl AsRef<str>) -> Self

Restore an X25519PrivateKey from a hex string.

Panics

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

pub fn hex(&self) -> String

Get the hex string representation of the X25519PrivateKey.

pub fn public_key(&self) -> X25519PublicKey

Get the X25519PublicKey corresponding to this X25519PrivateKey.

pub fn derive_from_key_material(key_material: impl AsRef<[u8]>) -> Self

Derive an X25519PrivateKey from the given key material.

pub fn shared_key_with(&self, public_key: &X25519PublicKey) -> SymmetricKey

Derive a shared symmetric key from this X25519PrivateKey and the given X25519PublicKey.

Trait Implementations

impl AsRef<X25519PrivateKey> for X25519PrivateKey

fn as_ref(&self) -> &Self

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

impl CBORTagged for X25519PrivateKey

fn cbor_tags() -> Vec<Tag>

The CBOR tags assocated with this type. If more than one tag is present, they are considered equivalent for reading, but only the first one is used for writing.

impl CBORTaggedDecodable for X25519PrivateKey

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 X25519PrivateKey

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 X25519PrivateKey

fn clone(&self) -> X25519PrivateKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for X25519PrivateKey

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

Formats the value using the given formatter.

impl Decrypter for X25519PrivateKey

fn encapsulation_private_key(&self) -> EncapsulationPrivateKey

fn decapsulate_shared_secret( &self, ciphertext: &EncapsulationCiphertext, ) -> Result<SymmetricKey>

impl Default for X25519PrivateKey

fn default() -> Self

Returns the “default value” for a type.

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

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

Converts to this type from the input type.

impl From<&X25519PrivateKey> for Vec<u8>

fn from(key: &X25519PrivateKey) -> Self

Converts to this type from the input type.

impl From<&X25519PrivateKey> for X25519PrivateKey

fn from(key: &X25519PrivateKey) -> Self

Converts to this type from the input type.

impl From<Rc<X25519PrivateKey>> for X25519PrivateKey

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

Converts to this type from the input type.

impl From<X25519PrivateKey> for CBOR

fn from(value: X25519PrivateKey) -> Self

Converts to this type from the input type.

impl From<X25519PrivateKey> for Vec<u8>

fn from(key: X25519PrivateKey) -> Self

Converts to this type from the input type.

impl Hash for X25519PrivateKey

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 X25519PrivateKey

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

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Eq for X25519PrivateKey

impl StructuralPartialEq for X25519PrivateKey