Enum bc_components::SigningPrivateKey

pub enum SigningPrivateKey {
    Schnorr(ECPrivateKey),
    ECDSA(ECPrivateKey),
    SSH(Box<PrivateKey>),
}

A private ECDSA, Schnorr or SSH key for signing.

• Both ECDSA and Schnorr keys are based on ECPrivateKey.
• SSH keys are based on SSHPrivateKey, an alias for (ssh_key::PrivateKey).

Variants

Schnorr(ECPrivateKey)

ECDSA(ECPrivateKey)

SSH(Box<PrivateKey>)

Implementations

impl SigningPrivateKey

pub const fn new_schnorr(key: ECPrivateKey) -> Self

pub const fn new_ecdsa(key: ECPrivateKey) -> Self

pub fn new_ssh(key: SSHPrivateKey) -> Self

pub fn to_schnorr(&self) -> Option<&ECPrivateKey>

pub fn to_ecdsa(&self) -> Option<&ECPrivateKey>

pub fn to_ssh(&self) -> Option<&SSHPrivateKey>

pub fn public_key(&self) -> SigningPublicKey

impl SigningPrivateKey

pub fn schnorr_sign( &self, message: impl AsRef<[u8]>, tag: impl AsRef<[u8]>, rng: Rc<RefCell<dyn RandomNumberGenerator>>, ) -> Result<Signature>

Trait Implementations

impl CBORTagged for SigningPrivateKey

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 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: 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 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 From<&SigningPrivateKey> for SigningPrivateKey

fn from(key: &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 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 Signer for SigningPrivateKey

fn sign_with_options( &self, message: &dyn AsRef<[u8]>, options: Option<SigningOptions>, ) -> Result<Signature>

fn sign(&self, message: &dyn AsRef<[u8]>) -> Result<Signature>

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

impl StructuralPartialEq for SigningPrivateKey