#include "secp256k1.h"

Include dependency graph for secp256k1_recovery.h:

This graph shows which files directly or indirectly include this file:

Classes
struct	secp256k1_ecdsa_recoverable_signature
	Opaque data structured that holds a parsed ECDSA signature, supporting pubkey recovery. More...

Functions
SECP256K1_API int	secp256k1_ecdsa_recoverable_signature_parse_compact (const secp256k1_context ctx, secp256k1_ecdsa_recoverable_signature sig, const unsigned char *input64, int recid) SECP256K1_ARG_NONNULL(1) SECP256K1_ARG_NONNULL(2) SECP256K1_ARG_NONNULL(3)
	Parse a compact ECDSA signature (64 bytes + recovery id). More...

SECP256K1_API int	secp256k1_ecdsa_recoverable_signature_convert (const secp256k1_context ctx, secp256k1_ecdsa_signature sig, const secp256k1_ecdsa_recoverable_signature *sigin) SECP256K1_ARG_NONNULL(1) SECP256K1_ARG_NONNULL(2) SECP256K1_ARG_NONNULL(3)
	Convert a recoverable signature into a normal signature. More...

SECP256K1_API int	secp256k1_ecdsa_recoverable_signature_serialize_compact (const secp256k1_context ctx, unsigned char output64, int recid, const secp256k1_ecdsa_recoverable_signature sig) SECP256K1_ARG_NONNULL(1) SECP256K1_ARG_NONNULL(2) SECP256K1_ARG_NONNULL(3) SECP256K1_ARG_NONNULL(4)
	Serialize an ECDSA signature in compact format (64 bytes + recovery id). More...

SECP256K1_API int	secp256k1_ecdsa_sign_recoverable (const secp256k1_context ctx, secp256k1_ecdsa_recoverable_signature sig, const unsigned char msg32, const unsigned char seckey, secp256k1_nonce_function noncefp, const void *ndata) SECP256K1_ARG_NONNULL(1) SECP256K1_ARG_NONNULL(2) SECP256K1_ARG_NONNULL(3) SECP256K1_ARG_NONNULL(4)
	Create a recoverable ECDSA signature. More...

SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int	secp256k1_ecdsa_recover (const secp256k1_context ctx, secp256k1_pubkey pubkey, const secp256k1_ecdsa_recoverable_signature sig, const unsigned char msg32) SECP256K1_ARG_NONNULL(1) SECP256K1_ARG_NONNULL(2) SECP256K1_ARG_NONNULL(3) SECP256K1_ARG_NONNULL(4)
	Recover an ECDSA public key from a signature. More...

Function Documentation

◆ secp256k1_ecdsa_recover()

SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_ecdsa_recover	(	const secp256k1_context *	ctx,
		secp256k1_pubkey *	pubkey,
		const secp256k1_ecdsa_recoverable_signature *	sig,
		const unsigned char *	msg32
	)

Recover an ECDSA public key from a signature.

Returns: 1: public key successfully recovered (which guarantees a correct signature). 0: otherwise. Args: ctx: pointer to a context object, initialized for verification (cannot be NULL) Out: pubkey: pointer to the recovered public key (cannot be NULL) In: sig: pointer to initialized signature that supports pubkey recovery (cannot be NULL) msg32: the 32-byte message hash assumed to be signed (cannot be NULL)

Definition at line 170 of file main_impl.h.

References ARG_CHECK, ctx, secp256k1_context_struct::ecmult_ctx, secp256k1_ecdsa_recoverable_signature_load(), secp256k1_ecdsa_sig_recover(), secp256k1_ecmult_context_is_built(), secp256k1_pubkey_save(), secp256k1_scalar_set_b32(), and VERIFY_CHECK.

Referenced by bench_recover(), CPubKey::RecoverCompact(), test_ecdsa_recovery_api(), test_ecdsa_recovery_edge_cases(), and test_ecdsa_recovery_end_to_end().

◆ secp256k1_ecdsa_recoverable_signature_convert()

SECP256K1_API int secp256k1_ecdsa_recoverable_signature_convert	(	const secp256k1_context *	ctx,
		secp256k1_ecdsa_signature *	sig,
		const secp256k1_ecdsa_recoverable_signature *	sigin
	)

Convert a recoverable signature into a normal signature.

Returns: 1 Out: sig: a pointer to a normal signature (cannot be NULL). In: sigin: a pointer to a recoverable signature (cannot be NULL).

Definition at line 74 of file main_impl.h.

References ARG_CHECK, ctx, secp256k1_ecdsa_recoverable_signature_load(), and secp256k1_ecdsa_signature_save().

Referenced by test_ecdsa_recovery_api(), and test_ecdsa_recovery_end_to_end().

◆ secp256k1_ecdsa_recoverable_signature_parse_compact()

SECP256K1_API int secp256k1_ecdsa_recoverable_signature_parse_compact	(	const secp256k1_context *	ctx,
		secp256k1_ecdsa_recoverable_signature *	sig,
		const unsigned char *	input64,
		int	recid
	)

Parse a compact ECDSA signature (64 bytes + recovery id).

Returns: 1 when the signature could be parsed, 0 otherwise Args: ctx: a secp256k1 context object Out: sig: a pointer to a signature object In: input64: a pointer to a 64-byte compact signature recid: the recovery id (0, 1, 2 or 3)

Definition at line 38 of file main_impl.h.

References ARG_CHECK, ctx, secp256k1_ecdsa_recoverable_signature_save(), and secp256k1_scalar_set_b32().

Referenced by bench_recover(), CPubKey::RecoverCompact(), test_ecdsa_recovery_api(), test_ecdsa_recovery_edge_cases(), and test_ecdsa_recovery_end_to_end().

◆ secp256k1_ecdsa_recoverable_signature_serialize_compact()

SECP256K1_API int secp256k1_ecdsa_recoverable_signature_serialize_compact	(	const secp256k1_context *	ctx,
		unsigned char *	output64,
		int *	recid,
		const secp256k1_ecdsa_recoverable_signature *	sig
	)

Serialize an ECDSA signature in compact format (64 bytes + recovery id).

Returns: 1 Args: ctx: a secp256k1 context object Out: output64: a pointer to a 64-byte array of the compact signature (cannot be NULL) recid: a pointer to an integer to hold the recovery id (can be NULL). In: sig: a pointer to an initialized signature object (cannot be NULL)

Definition at line 60 of file main_impl.h.

References ARG_CHECK, ctx, secp256k1_ecdsa_recoverable_signature_load(), and secp256k1_scalar_get_b32().

Referenced by CKey::SignCompact(), test_ecdsa_recovery_api(), and test_ecdsa_recovery_end_to_end().

◆ secp256k1_ecdsa_sign_recoverable()

SECP256K1_API int secp256k1_ecdsa_sign_recoverable	(	const secp256k1_context *	ctx,
		secp256k1_ecdsa_recoverable_signature *	sig,
		const unsigned char *	msg32,
		const unsigned char *	seckey,
		secp256k1_nonce_function	noncefp,
		const void *	ndata
	)

Create a recoverable ECDSA signature.

Returns: 1: signature created 0: the nonce generation function failed, or the private key was invalid. Args: ctx: pointer to a context object, initialized for signing (cannot be NULL) Out: sig: pointer to an array where the signature will be placed (cannot be NULL) In: msg32: the 32-byte message hash being signed (cannot be NULL) seckey: pointer to a 32-byte secret key (cannot be NULL) noncefp:pointer to a nonce generation function. If NULL, secp256k1_nonce_function_default is used ndata: pointer to arbitrary data used by the nonce generation function (can be NULL)

Definition at line 123 of file main_impl.h.

References ARG_CHECK, count, ctx, secp256k1_context_struct::ecmult_gen_ctx, secp256k1_ecdsa_recoverable_signature_save(), secp256k1_ecdsa_sig_sign(), secp256k1_ecmult_gen_context_is_built(), secp256k1_nonce_function_default, secp256k1_scalar_clear(), secp256k1_scalar_is_zero(), secp256k1_scalar_set_b32(), and VERIFY_CHECK.