Struct SigningKey

pub struct SigningKey<C>
where
    C: PrimeCurve + ProjectiveArithmetic,
    Scalar<C>: FromDigest<C> + Invert<Output = Scalar<C>> + SignPrimitive<C>,
    SignatureSize<C>: ArrayLength<u8>,
{ /* private fields */ }

Available on crate feature sign only.

ECDSA signing key. Generic over elliptic curves.

Requires an elliptic_curve_flow::ProjectiveArithmetic impl on the curve, and a SignPrimitive impl on its associated Scalar type.

Implementations

impl<C> SigningKey<C>

where C: PrimeCurve + ProjectiveArithmetic, Scalar<C>: FromDigest<C> + Invert<Output = Scalar<C>> + SignPrimitive<C>, SignatureSize<C>: ArrayLength<u8>,

pub fn random(rng: impl CryptoRng + RngCore) -> Self

Generate a cryptographically random SigningKey.

pub fn from_bytes(bytes: &[u8]) -> Result<Self>

Initialize signing key from a raw scalar serialized as a byte slice.

pub fn verifying_key(&self) -> VerifyingKey<C>

Available on crate feature verify only.

Get the VerifyingKey which corresponds to this SigningKey

pub fn to_bytes(&self) -> FieldBytes<C>

Serialize this SigningKey as bytes

Trait Implementations

impl<C> Clone for SigningKey<C>

where C: PrimeCurve + ProjectiveArithmetic + Clone, Scalar<C>: FromDigest<C> + Invert<Output = Scalar<C>> + SignPrimitive<C>, SignatureSize<C>: ArrayLength<u8>,

fn clone(&self) -> SigningKey<C>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<C> ConstantTimeEq for SigningKey<C>

where C: PrimeCurve + ProjectiveArithmetic, Scalar<C>: FromDigest<C> + Invert<Output = Scalar<C>> + SignPrimitive<C>, SignatureSize<C>: ArrayLength<u8>,

fn ct_eq(&self, other: &Self) -> Choice

Determine if two items are equal.

impl<C> Debug for SigningKey<C>

where C: PrimeCurve + ProjectiveArithmetic, Scalar<C>: FromDigest<C> + Invert<Output = Scalar<C>> + SignPrimitive<C>, SignatureSize<C>: ArrayLength<u8>,

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

Formats the value using the given formatter.

impl<C, D> DigestSigner<D, Signature<C>> for SigningKey<C>

where C: PrimeCurve + ProjectiveArithmetic, D: FixedOutput<OutputSize = FieldSize<C>> + BlockInput + Clone + Default + Reset + Update, Scalar<C>: FromDigest<C> + Invert<Output = Scalar<C>> + SignPrimitive<C>, SignatureSize<C>: ArrayLength<u8>,

fn try_sign_digest(&self, digest: D) -> Result<Signature<C>>

Sign message prehash using a deterministic ephemeral scalar (k) computed using the algorithm described in RFC 6979 (Section 3.2): https://tools.ietf.org/html/rfc6979#section-3

fn sign_digest(&self, digest: D) -> S

Sign the given prehashed message Digest, returning a signature.

impl<C> Drop for SigningKey<C>

where C: PrimeCurve + ProjectiveArithmetic, Scalar<C>: FromDigest<C> + Invert<Output = Scalar<C>> + SignPrimitive<C>, SignatureSize<C>: ArrayLength<u8>,

fn drop(&mut self)

Executes the destructor for this type.

impl<C> From<&SecretKey<C>> for SigningKey<C>

where C: PrimeCurve + ProjectiveArithmetic, Scalar<C>: FromDigest<C> + Invert<Output = Scalar<C>> + SignPrimitive<C>, SignatureSize<C>: ArrayLength<u8>,

fn from(secret_key: &SecretKey<C>) -> Self

Converts to this type from the input type.

impl<C> From<&SigningKey<C>> for VerifyingKey<C>

where C: PrimeCurve + ProjectiveArithmetic, Scalar<C>: FromDigest<C> + Invert<Output = Scalar<C>> + SignPrimitive<C>, SignatureSize<C>: ArrayLength<u8>,

fn from(signing_key: &SigningKey<C>) -> VerifyingKey<C>

Converts to this type from the input type.

impl<C> From<NonZeroScalar<C>> for SigningKey<C>

where C: PrimeCurve + ProjectiveArithmetic, Scalar<C>: FromDigest<C> + Invert<Output = Scalar<C>> + SignPrimitive<C>, SignatureSize<C>: ArrayLength<u8>,

fn from(secret_scalar: NonZeroScalar<C>) -> Self

Converts to this type from the input type.

impl<C> From<SecretKey<C>> for SigningKey<C>

where C: PrimeCurve + ProjectiveArithmetic, Scalar<C>: FromDigest<C> + Invert<Output = Scalar<C>> + SignPrimitive<C>, SignatureSize<C>: ArrayLength<u8>,

fn from(secret_key: SecretKey<C>) -> Self

Converts to this type from the input type.

impl<C> FromPrivateKey for SigningKey<C>

where C: PrimeCurve + AlgorithmParameters + ProjectiveArithmetic, AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>, Scalar<C>: FromDigest<C> + Invert<Output = Scalar<C>> + SignPrimitive<C>, SignatureSize<C>: ArrayLength<u8>, UntaggedPointSize<C>: Add<U1> + ArrayLength<u8>, UncompressedPointSize<C>: ArrayLength<u8>,

Available on crate feature pkcs8 only.

fn from_pkcs8_private_key_info( private_key_info: PrivateKeyInfo<'_>, ) -> Result<Self>

Parse the PrivateKeyInfo from a PKCS#8-encoded document.

fn from_pkcs8_der(bytes: &[u8]) -> Result<Self, Error>

Deserialize PKCS#8 private key from ASN.1 DER-encoded data (binary format).

fn from_pkcs8_doc(doc: &PrivateKeyDocument) -> Result<Self, Error>

Deserialize PKCS#8 private key from a PrivateKeyDocument.

fn from_pkcs8_pem(s: &str) -> Result<Self, Error>

Deserialize PKCS#8-encoded private key from PEM.

impl<C> FromStr for SigningKey<C>

where C: PrimeCurve + AlgorithmParameters + ProjectiveArithmetic, AffinePoint<C>: FromEncodedPoint<C> + ToEncodedPoint<C>, Scalar<C>: FromDigest<C> + Invert<Output = Scalar<C>> + SignPrimitive<C>, SignatureSize<C>: ArrayLength<u8>, UntaggedPointSize<C>: Add<U1> + ArrayLength<u8>, UncompressedPointSize<C>: ArrayLength<u8>,

Available on crate feature pem only.

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self>

Parses a string s to return a value of this type.

impl<C> PartialEq for SigningKey<C>

where C: PrimeCurve + ProjectiveArithmetic, Scalar<C>: FromDigest<C> + Invert<Output = Scalar<C>> + SignPrimitive<C>, SignatureSize<C>: ArrayLength<u8>,

fn eq(&self, other: &SigningKey<C>) -> 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<C, D> RandomizedDigestSigner<D, Signature<C>> for SigningKey<C>

where C: PrimeCurve + ProjectiveArithmetic, D: FixedOutput<OutputSize = FieldSize<C>> + BlockInput + Clone + Default + Reset + Update, Scalar<C>: FromDigest<C> + Invert<Output = Scalar<C>> + SignPrimitive<C>, SignatureSize<C>: ArrayLength<u8>,

fn try_sign_digest_with_rng( &self, rng: impl CryptoRng + RngCore, digest: D, ) -> Result<Signature<C>>

Sign message prehash using an ephemeral scalar (k) derived according to a variant of RFC 6979 (Section 3.6) which supplies additional entropy from an RNG.

fn sign_digest_with_rng(&self, rng: impl CryptoRng + RngCore, digest: D) -> S

Sign the given prehashed message Digest, returning a signature.

impl<C> RandomizedSigner<Signature<C>> for SigningKey<C>

where Self: RandomizedDigestSigner<C::Digest, Signature<C>>, C: PrimeCurve + ProjectiveArithmetic + DigestPrimitive, Scalar<C>: FromDigest<C> + Invert<Output = Scalar<C>> + SignPrimitive<C>, SignatureSize<C>: ArrayLength<u8>,

fn try_sign_with_rng( &self, rng: impl CryptoRng + RngCore, msg: &[u8], ) -> Result<Signature<C>>

Attempt to sign the given message, returning a digital signature on success, or an error if something went wrong.

fn sign_with_rng(&self, rng: impl CryptoRng + RngCore, msg: &[u8]) -> S

Sign the given message and return a digital signature

impl<C> Signer<Signature<C>> for SigningKey<C>

where Self: DigestSigner<C::Digest, Signature<C>>, C: PrimeCurve + ProjectiveArithmetic + DigestPrimitive, Scalar<C>: FromDigest<C> + Invert<Output = Scalar<C>> + SignPrimitive<C>, SignatureSize<C>: ArrayLength<u8>,

fn try_sign(&self, msg: &[u8]) -> Result<Signature<C>>

Attempt to sign the given message, returning a digital signature on success, or an error if something went wrong.

fn sign(&self, msg: &[u8]) -> S

Sign the given message and return a digital signature

impl<C> TryFrom<&[u8]> for SigningKey<C>

where C: PrimeCurve + ProjectiveArithmetic, Scalar<C>: FromDigest<C> + Invert<Output = Scalar<C>> + SignPrimitive<C>, SignatureSize<C>: ArrayLength<u8>,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(bytes: &[u8]) -> Result<Self>

Performs the conversion.

impl<C> Eq for SigningKey<C>

where C: PrimeCurve + ProjectiveArithmetic, Scalar<C>: FromDigest<C> + Invert<Output = Scalar<C>> + SignPrimitive<C>, SignatureSize<C>: ArrayLength<u8>,