secp256k1/include/secp256k1.h

105 lines
4.3 KiB
C
Raw Normal View History

2013-03-11 21:27:43 +00:00
#ifndef _SECP256K1_
#define _SECP256K1_
2013-04-01 05:52:58 +00:00
#ifdef __cplusplus
2013-03-31 04:34:15 +00:00
extern "C" {
2013-04-01 05:52:58 +00:00
#endif
2013-04-14 20:44:45 +00:00
/** 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.
*/
2013-03-31 04:34:15 +00:00
void secp256k1_start(void);
2013-04-14 20:44:45 +00:00
/** Free all memory associated with this library. After this, no
* functions can be called anymore, except secp256k1_start()
*/
2013-03-31 04:34:15 +00:00
void secp256k1_stop(void);
2013-04-14 20:44:45 +00:00
/** Verify an ECDSA signature.
* Returns: 1: correct signature
* 0: incorrect signature
* -1: invalid public key
* -2: invalid signature
*/
int secp256k1_ecdsa_verify(const unsigned char *msg, int msglen,
const unsigned char *sig, int siglen,
const unsigned char *pubkey, int pubkeylen);
2013-05-04 22:49:30 +00:00
/** Create an ECDSA signature.
* Returns: 1: signature created
* 0: nonce invalid, try another one
* In: msg: the message being signed
* msglen: the length of the message being signed
* seckey: pointer to a 32-byte secret key (assumed to be valid)
* nonce: pointer to a 32-byte nonce (generated with a cryptographic PRNG)
* Out: sig: pointer to a 72-byte array where the signature will be placed.
* siglen: pointer to an int, which will be updated to the signature length (<=72).
*/
2013-05-04 22:21:03 +00:00
int secp256k1_ecdsa_sign(const unsigned char *msg, int msglen,
2013-05-04 22:49:30 +00:00
unsigned char *sig, int *siglen,
2013-05-04 22:21:03 +00:00
const unsigned char *seckey,
const unsigned char *nonce);
2013-05-05 00:46:07 +00:00
/** 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
* msglen: the length of the message being signed
* seckey: pointer to a 32-byte secret key (assumed to be valid)
* nonce: pointer to a 32-byte nonce (generated with a cryptographic PRNG)
* Out: sig: pointer to a 64-byte array where the signature will be placed.
* recid: pointer to an int, which will be updated to contain the recovery id.
*/
int secp256k1_ecdsa_sign_compact(const unsigned char *msg, int msglen,
unsigned char *sig64,
const unsigned char *seckey,
const unsigned char *nonce,
int *recid);
int secp256k1_ecdsa_recover_compact(const unsigned char *msg, int msglen,
const unsigned char *sig64,
unsigned char *pubkey, int *pubkeylen,
int compressed, int recid);
2013-05-04 22:49:30 +00:00
/** 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
*/
2013-05-04 22:21:03 +00:00
int secp256j1_ecdsa_seckey_verify(const unsigned char *seckey);
2013-04-14 20:44:45 +00:00
/** Just validate a public key.
* Returns: 1: valid public key
* 0: invalid public key
*/
int secp256k1_ecdsa_pubkey_verify(const unsigned char *pubkey, int pubkeylen);
/** 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.
* Out: pubkey: pointer to a 33-byte (if compressed) or 65-byte (if uncompressed)
* area to store the public key.
2013-05-04 22:21:03 +00:00
* pubkeylen: pointer to int that will be updated to contains the pubkey's
* length.
2013-04-14 20:44:45 +00:00
* Returns: 1: secret was valid, public key stores
* 0: secret was invalid, try again.
*/
2013-05-04 22:49:30 +00:00
int secp256k1_ecdsa_pubkey_create(unsigned char *pubkey, int *pubkeylen, const unsigned char *seckey, int compressed);
2013-05-04 22:21:03 +00:00
int secp256k1_ecdsa_pubkey_decompress(unsigned char *pubkey, int *pubkeylen);
2013-04-01 05:52:58 +00:00
2013-05-05 03:12:43 +00:00
int secp256k1_ecdsa_privkey_export(const unsigned char *seckey,
unsigned char *privkey, int *privkeylen,
int compressed);
int secp256k1_ecdsa_privkey_import(unsigned char *seckey,
const unsigned char *privkey, int privkeylen);
2013-04-01 05:52:58 +00:00
#ifdef __cplusplus
2013-03-11 21:27:43 +00:00
}
2013-04-01 05:52:58 +00:00
#endif
2013-03-11 21:27:43 +00:00
#endif