Struct bc_components::SigningPrivateKey

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

A private ECDSA key for signing.

Implementations

impl SigningPrivateKey

pub const KEY_SIZE: usize = 32usize

pub fn new() -> Self

Generate a new random SigningPrivateKey.

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

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

For testing purposes only.

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

Restores a SigningPrivateKey from a vector of bytes.

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

Restores a SigningPrivateKey from a reference to a vector of bytes.

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

Returns a reference to the vector of private key data.

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

Restores a SigningPrivateKey from a hex string.

Panics

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

pub fn hex(&self) -> String

Returns the private key as a hex string.

pub fn ecdsa_public_key(&self) -> SigningPublicKey

Derives the ECDSA signing public key from this private key.

pub fn schnorr_public_key(&self) -> SigningPublicKey

Derives the Schnorr signing public key from this private key.

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

Derives a new SigningPrivateKey from the given key material.

impl SigningPrivateKey

pub fn ecdsa_sign(&self, message: impl AsRef<[u8]>) -> Signature

pub fn schnorr_sign_using( &self, message: impl AsRef<[u8]>, tag: impl AsRef<[u8]>, rng: &mut impl RandomNumberGenerator ) -> Signature

pub fn schnorr_sign( &self, message: impl AsRef<[u8]>, tag: impl AsRef<[u8]> ) -> Signature

Trait Implementations

impl AsRef<SigningPrivateKey> for SigningPrivateKey

fn as_ref(&self) -> &SigningPrivateKey

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

impl CBORDecodable for SigningPrivateKey

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

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 SigningPrivateKey

fn cbor(&self) -> CBOR

Returns the value in CBOR symbolic representation.

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

Returns the value in CBOR binary representation.

impl CBORTagged for SigningPrivateKey

const CBOR_TAG: Tag = tags::SIGNING_PRIVATE_KEY

The CBOR tag assocated with this type.

impl CBORTaggedDecodable for SigningPrivateKey

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: &[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 SigningPrivateKey

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 SigningPrivateKey

fn clone(&self) -> SigningPrivateKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SigningPrivateKey

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

Formats the value using the given formatter.

impl Default for SigningPrivateKey

fn default() -> Self

Returns the “default value” for a type.

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

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

Converts to this type from the input type.

impl From<&SigningPrivateKey> for SigningPrivateKey

fn from(key: &SigningPrivateKey) -> Self

Converts to this type from the input type.

impl From<&SigningPrivateKey> for Vec<u8>

fn from(key: &SigningPrivateKey) -> Self

Converts to this type from the input type.

impl From<Rc<SigningPrivateKey>> for SigningPrivateKey

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

Converts to this type from the input type.

impl From<SigningPrivateKey> for CBOR

fn from(value: SigningPrivateKey) -> Self

Converts to this type from the input type.

impl From<SigningPrivateKey> for Vec<u8>

fn from(key: SigningPrivateKey) -> Self

Converts to this type from the input type.

impl Hash for SigningPrivateKey

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 SigningPrivateKey

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

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 TryFrom<CBOR> for SigningPrivateKey

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 URDecodable for SigningPrivateKey

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 SigningPrivateKey

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 SigningPrivateKey

impl StructuralPartialEq for SigningPrivateKey

impl URCodable for SigningPrivateKey