Struct bc_components::AgreementPrivateKey

pub struct AgreementPrivateKey(_);

A Curve25519 private key used for X25519 key agreement.

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

Implementations

impl AgreementPrivateKey

pub const KEY_SIZE: usize = 32usize

pub fn new() -> Self

Generate a new random AgreementPrivateKey.

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

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

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

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

pub fn from_data_ref<T>(data: &T) -> Option<Self>where T: AsRef<[u8]>,

Restore an AgreementPrivateKey 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<T>(hex: T) -> Selfwhere T: AsRef<str>,

Restore an AgreementPrivateKey from a hex string.

Panics

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

pub fn hex(&self) -> String

Get the hex string representation of the AgreementPrivateKey.

pub fn public_key(&self) -> AgreementPublicKey

Get the AgreementPublicKey corresponding to this AgreementPrivateKey.

pub fn derive_from_key_material<D>(key_material: D) -> Selfwhere D: AsRef<[u8]>,

Derive an AgreementPrivateKey from the given key material.

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

Derive a shared symmetric key from this AgreementPrivateKey and the given AgreementPublicKey.

Trait Implementations

impl CBORDecodable for AgreementPrivateKey

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

Creates an instance of this type from CBOR symbolic representation.

fn from_cbor_data(cbor_data: &[u8]) -> Result<Self, Error>where Self: Sized,

Creates an instance of this type from encoded CBOR binary data.

impl CBOREncodable for AgreementPrivateKey

fn cbor(&self) -> CBOR

Returns the value in CBOR symbolic representation.

fn cbor_data(&self) -> Vec<u8, Global>

Returns the value in CBOR binary representation.

impl CBORTagged for AgreementPrivateKey

const CBOR_TAG: Tag = tags::AGREEMENT_PRIVATE_KEY

The CBOR tag assocated with this type.

impl CBORTaggedDecodable for AgreementPrivateKey

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

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: &[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: &[u8]) -> Result<Self, Error>where Self: Sized,

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

impl CBORTaggedEncodable for AgreementPrivateKey

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.

impl Clone for AgreementPrivateKey

fn clone(&self) -> AgreementPrivateKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AgreementPrivateKey

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

Formats the value using the given formatter.

impl Default for AgreementPrivateKey

fn default() -> Self

Returns the “default value” for a type.

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

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

Converts to this type from the input type.

impl From<&AgreementPrivateKey> for AgreementPrivateKey

fn from(key: &AgreementPrivateKey) -> Self

Converts to this type from the input type.

impl From<&AgreementPrivateKey> for Vec<u8>

fn from(key: &AgreementPrivateKey) -> Self

Converts to this type from the input type.

impl From<AgreementPrivateKey> for Vec<u8>

fn from(key: AgreementPrivateKey) -> Self

Converts to this type from the input type.

impl From<Rc<AgreementPrivateKey>> for AgreementPrivateKey

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

Converts to this type from the input type.

impl Hash for AgreementPrivateKey

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<AgreementPrivateKey> for AgreementPrivateKey

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

fn from_ur(ur: &UR) -> Result<Self, Error>where Self: Sized,

fn from_ur_string<T>(ur_string: T) -> Result<Self, Error>where T: Into<String>, Self: Sized,

impl UREncodable for AgreementPrivateKey

fn ur(&self) -> UR

Returns the UR representation of the object.

fn ur_string(&self) -> String

Returns the UR string representation of the object.

impl Eq for AgreementPrivateKey

impl StructuralEq for AgreementPrivateKey

impl StructuralPartialEq for AgreementPrivateKey

impl URCodable for AgreementPrivateKey