Struct Signature

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

An ECDSA signature

Implementations

impl Signature

pub fn from_der(data: &[u8]) -> Result<Signature, Error>

Converts a DER-encoded byte slice to a signature

pub fn from_compact(data: &[u8]) -> Result<Signature, Error>

Converts a 64-byte compact-encoded byte slice to a signature

pub fn from_der_lax(data: &[u8]) -> Result<Signature, Error>

Converts a “lax DER”-encoded byte slice to a signature. This is basically only useful for validating signatures in the Bitcoin blockchain from before 2016. It should never be used in new applications. This library does not support serializing to this “format”

pub fn normalize_s(&mut self)

Normalizes a signature to a “low S” form. In ECDSA, signatures are of the form (r, s) where r and s are numbers lying in some finite field. The verification equation will pass for (r, s) iff it passes for (r, -s), so it is possible to ``modify’’ signatures in transit by flipping the sign of s. This does not constitute a forgery since the signed message still cannot be changed, but for some applications, changing even the signature itself can be a problem. Such applications require a “strong signature”. It is believed that ECDSA is a strong signature except for this ambiguity in the sign of s, so to accommodate these applications libsecp256k1 will only accept signatures for which s is in the lower half of the field range. This eliminates the ambiguity.

However, for some systems, signatures with high s-values are considered valid. (For example, parsing the historic Bitcoin blockchain requires this.) For these applications we provide this normalization function, which ensures that the s value lies in the lower half of its range.

pub fn as_ptr(&self) -> *const Signature

Obtains a raw pointer suitable for use with FFI functions

pub fn as_mut_ptr(&mut self) -> *mut Signature

Obtains a raw mutable pointer suitable for use with FFI functions

pub fn serialize_der(&self) -> SerializedSignature

Serializes the signature in DER format

pub fn serialize_compact(&self) -> [u8; 64]

Serializes the signature in compact format

Trait Implementations

impl CPtr for Signature

type Target = Signature

fn as_c_ptr(&self) -> *const <Signature as CPtr>::Target

fn as_mut_c_ptr(&mut self) -> *mut <Signature as CPtr>::Target

impl Clone for Signature

fn clone(&self) -> Signature

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Signature

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

Formats the value using the given formatter.

impl Display for Signature

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

Formats the value using the given formatter.

impl From<Signature> for Signature

Creates a new signature from a FFI signature

fn from(sig: Signature) -> Signature

Converts to this type from the input type.

impl FromStr for Signature

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Signature, Error>

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

impl Hash for Signature

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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 Signature

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

fn read<R>(r: &mut R) -> Result<Signature, DecodeError>

where R: Read,

Reads a Self in from the given Read.

impl Writeable for Signature

fn write<W>(&self, w: &mut W) -> Result<(), Error>

where W: Writer,

Writes self out to the given Writer.

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

Writes self out to a Vec<u8>.

fn serialized_length(&self) -> usize

Gets the length of this object after it has been serialized. This can be overridden to optimize cases where we prepend an object with its length.

impl Copy for Signature

impl Eq for Signature

impl StructuralPartialEq for Signature