secp256k1.c File Reference

#include "include/secp256k1.h"
#include "util.h"
#include "num_impl.h"
#include "field_impl.h"
#include "scalar_impl.h"
#include "group_impl.h"
#include "ecmult_impl.h"
#include "ecmult_gen_impl.h"
#include "ecdsa_impl.h"
#include "eckey_impl.h"

Include dependency graph for secp256k1.c:

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

Go to the source code of this file.

Macros
#define	SECP256K1_BUILD   (1)

Functions
void	secp256k1_start (unsigned int flags)
	Initialize the library. More...
void	secp256k1_stop (void)
	Free all memory associated with this library. More...
int	secp256k1_ecdsa_verify (const unsigned char *msg, int msglen, const unsigned char *sig, int siglen, const unsigned char *pubkey, int pubkeylen)
	Verify an ECDSA signature. More...
int	secp256k1_ecdsa_sign (const unsigned char *message, int messagelen, unsigned char *signature, int *signaturelen, const unsigned char *seckey, const unsigned char *nonce)
	Create an ECDSA signature. More...
int	secp256k1_ecdsa_sign_compact (const unsigned char *message, int messagelen, unsigned char *sig64, const unsigned char *seckey, const unsigned char *nonce, int *recid)
	Create a compact ECDSA signature (64 byte + recovery id). More...
int	secp256k1_ecdsa_recover_compact (const unsigned char *msg, int msglen, const unsigned char *sig64, unsigned char *pubkey, int *pubkeylen, int compressed, int recid)
	Recover an ECDSA public key from a compact signature. More...
int	secp256k1_ec_seckey_verify (const unsigned char *seckey)
	Verify an ECDSA secret key. More...
int	secp256k1_ec_pubkey_verify (const unsigned char *pubkey, int pubkeylen)
	Just validate a public key. More...
int	secp256k1_ec_pubkey_create (unsigned char *pubkey, int *pubkeylen, const unsigned char *seckey, int compressed)
	Compute the public key for a secret key. More...
int	secp256k1_ec_pubkey_decompress (unsigned char *pubkey, int *pubkeylen)
	Decompress a public key. More...
int	secp256k1_ec_privkey_tweak_add (unsigned char *seckey, const unsigned char *tweak)
	Tweak a private key by adding tweak to it. More...
int	secp256k1_ec_pubkey_tweak_add (unsigned char *pubkey, int pubkeylen, const unsigned char *tweak)
	Tweak a public key by adding tweak times the generator to it. More...
int	secp256k1_ec_privkey_tweak_mul (unsigned char *seckey, const unsigned char *tweak)
	Tweak a private key by multiplying it with tweak. More...
int	secp256k1_ec_pubkey_tweak_mul (unsigned char *pubkey, int pubkeylen, const unsigned char *tweak)
	Tweak a public key by multiplying it with tweak. More...
int	secp256k1_ec_privkey_export (const unsigned char *seckey, unsigned char *privkey, int *privkeylen, int compressed)
	Export a private key in DER format. More...
int	secp256k1_ec_privkey_import (unsigned char *seckey, const unsigned char *privkey, int privkeylen)
	Import a private key in DER format. More...

Macro Definition Documentation

SECP256K1_BUILD

#define SECP256K1_BUILD   (1)

Definition at line 7 of file secp256k1.c.

Function Documentation

secp256k1_ec_privkey_export()

int secp256k1_ec_privkey_export	(	const unsigned char *	seckey,
		unsigned char *	privkey,
		int *	privkeylen,
		int	compressed
	)

Export a private key in DER format.

Definition at line 306 of file secp256k1.c.

Here is the caller graph for this function:

secp256k1_ec_privkey_import()

int secp256k1_ec_privkey_import	(	unsigned char *	seckey,
		const unsigned char *	privkey,
		int	privkeylen
	)

Import a private key in DER format.

Definition at line 318 of file secp256k1.c.

Here is the caller graph for this function:

secp256k1_ec_privkey_tweak_add()

int secp256k1_ec_privkey_tweak_add	(	unsigned char *	seckey,
		const unsigned char *	tweak
	)

Tweak a private key by adding tweak to it.

Definition at line 217 of file secp256k1.c.

Here is the caller graph for this function:

secp256k1_ec_privkey_tweak_mul()

int secp256k1_ec_privkey_tweak_mul	(	unsigned char *	seckey,
		const unsigned char *	tweak
	)

Tweak a private key by multiplying it with tweak.

Definition at line 262 of file secp256k1.c.

Here is the caller graph for this function:

secp256k1_ec_pubkey_create()

int secp256k1_ec_pubkey_create	(	unsigned char *	pubkey,
		int *	pubkeylen,
		const unsigned char *	seckey,
		int	compressed
	)

Compute the public key for a secret key.

In: compressed: whether the computed public key should be compressed seckey: pointer to a 32-byte private key (cannot be NULL) Out: pubkey: pointer to a 33-byte (if compressed) or 65-byte (if uncompressed) area to store the public key (cannot be NULL) pubkeylen: pointer to int that will be updated to contains the pubkey's length (cannot be NULL) Returns: 1: secret was valid, public key stores 0: secret was invalid, try again. Requires starting using SECP256K1_START_SIGN.

Definition at line 191 of file secp256k1.c.

Here is the caller graph for this function:

secp256k1_ec_pubkey_decompress()

int secp256k1_ec_pubkey_decompress	(	unsigned char *	pubkey,
		int *	pubkeylen
	)

Decompress a public key.

In/Out: pubkey: pointer to a 65-byte array to put the decompressed public key. It must contain a 33-byte or 65-byte public key already (cannot be NULL) pubkeylen: pointer to the size of the public key pointed to by pubkey (cannot be NULL) It will be updated to reflect the new size. Returns: 0 if the passed public key was invalid, 1 otherwise. If 1 is returned, the pubkey is replaced with its decompressed version.

Definition at line 207 of file secp256k1.c.

secp256k1_ec_pubkey_tweak_add()

int secp256k1_ec_pubkey_tweak_add	(	unsigned char *	pubkey,
		int	pubkeylen,
		const unsigned char *	tweak
	)

Tweak a public key by adding tweak times the generator to it.

Requires starting with SECP256K1_START_VERIFY.

Definition at line 237 of file secp256k1.c.

Here is the caller graph for this function:

secp256k1_ec_pubkey_tweak_mul()

int secp256k1_ec_pubkey_tweak_mul	(	unsigned char *	pubkey,
		int	pubkeylen,
		const unsigned char *	tweak
	)

Tweak a public key by multiplying it with tweak.

Requires starting with SECP256K1_START_VERIFY.

Definition at line 281 of file secp256k1.c.

Here is the caller graph for this function:

secp256k1_ec_pubkey_verify()

int secp256k1_ec_pubkey_verify	(	const unsigned char *	pubkey,
		int	pubkeylen
	)

Just validate a public key.

Returns: 1: valid public key 0: invalid public key In: pubkey: pointer to a 33-byte or 65-byte public key (cannot be NULL). pubkeylen: length of pubkey

Definition at line 184 of file secp256k1.c.

secp256k1_ec_seckey_verify()

int secp256k1_ec_seckey_verify

(

const unsigned char *

seckey

)

Verify an ECDSA secret key.

Returns: 1: secret key is valid 0: secret key is invalid In: seckey: pointer to a 32-byte secret key (cannot be NULL)

Definition at line 173 of file secp256k1.c.

secp256k1_ecdsa_recover_compact()

int secp256k1_ecdsa_recover_compact	(	const unsigned char *	msg,
		int	msglen,
		const unsigned char *	sig64,
		unsigned char *	pubkey,
		int *	pubkeylen,
		int	compressed,
		int	recid
	)

Recover an ECDSA public key from a compact signature.

Returns: 1: public key successfully recovered (which guarantees a correct signature). 0: otherwise. In: msg: the message assumed to be signed (cannot be NULL) msglen: the length of the message (at most 32) sig64: signature as 64 byte array (cannot be NULL) compressed: whether to recover a compressed or uncompressed pubkey recid: the recovery id (0-3, as returned by ecdsa_sign_compact) Out: pubkey: pointer to a 33 or 65 byte array to put the pubkey (cannot be NULL) pubkeylen: pointer to an int that will contain the pubkey length (cannot be NULL) Requires starting using SECP256K1_START_VERIFY.

Definition at line 141 of file secp256k1.c.

Here is the caller graph for this function:

secp256k1_ecdsa_sign()

int secp256k1_ecdsa_sign	(	const unsigned char *	msg,
		int	msglen,
		unsigned char *	sig,
		int *	siglen,
		const unsigned char *	seckey,
		const unsigned char *	nonce
	)

Create an ECDSA signature.

Returns: 1: signature created 0: nonce invalid, try another one In: msg: the message being signed (cannot be NULL) msglen: the length of the message being signed (at most 32) seckey: pointer to a 32-byte secret key (cannot be NULL, assumed to be valid) nonce: pointer to a 32-byte nonce (cannot be NULL, generated with a cryptographic PRNG) Out: sig: pointer to an array where the signature will be placed (cannot be NULL) In/Out: siglen: pointer to an int with the length of sig, which will be updated to contain the actual signature length (<=72). Requires starting using SECP256K1_START_SIGN.

Definition at line 75 of file secp256k1.c.

Here is the caller graph for this function:

secp256k1_ecdsa_sign_compact()

int secp256k1_ecdsa_sign_compact	(	const unsigned char *	msg,
		int	msglen,
		unsigned char *	sig64,
		const unsigned char *	seckey,
		const unsigned char *	nonce,
		int *	recid
	)

Create a compact ECDSA signature (64 byte + recovery id).

Returns: 1: signature created 0: nonce invalid, try another one In: msg: the message being signed (cannot be NULL) msglen: the length of the message being signed (at most 32) seckey: pointer to a 32-byte secret key (cannot be NULL, assumed to be valid) nonce: pointer to a 32-byte nonce (cannot be NULL, generated with a cryptographic PRNG) Out: sig: pointer to a 64-byte array where the signature will be placed (cannot be NULL) recid: pointer to an int, which will be updated to contain the recovery id (can be NULL) Requires starting using SECP256K1_START_SIGN.

Definition at line 108 of file secp256k1.c.

Here is the caller graph for this function:

secp256k1_ecdsa_verify()

int secp256k1_ecdsa_verify	(	const unsigned char *	msg,
		int	msglen,
		const unsigned char *	sig,
		int	siglen,
		const unsigned char *	pubkey,
		int	pubkeylen
	)

Verify an ECDSA signature.

Returns: 1: correct signature 0: incorrect signature -1: invalid public key -2: invalid signature In: msg: the message being verified (cannot be NULL) msglen: the length of the message (at most 32) sig: the signature being verified (cannot be NULL) siglen: the length of the signature pubkey: the public key to verify with (cannot be NULL) pubkeylen: the length of pubkey Requires starting using SECP256K1_START_VERIFY.

Definition at line 43 of file secp256k1.c.

Here is the caller graph for this function:

secp256k1_start()

void secp256k1_start

(

unsigned int

flags

)

Initialize the library.

This may take some time (10-100 ms). You need to call this before calling any other function. It cannot run in parallel with any other functions, but once secp256k1_start() returns, all other functions are thread-safe.

Definition at line 21 of file secp256k1.c.

Here is the caller graph for this function:

secp256k1_stop()

void secp256k1_stop

(

void

)

Free all memory associated with this library.

After this, no functions can be called anymore, except secp256k1_start()

Definition at line 34 of file secp256k1.c.

Here is the caller graph for this function: