Merge pull request #332

37100d7 improve ECDH header-doc (Jonas Schnelli)
This commit is contained in:
Pieter Wuille 2015-10-11 16:47:03 +02:00
commit 98135ee3d2
No known key found for this signature in database
GPG Key ID: 57896D2FF8F0B657
1 changed files with 8 additions and 7 deletions

View File

@ -10,17 +10,18 @@ extern "C" {
/** Compute an EC Diffie-Hellman secret in constant time /** Compute an EC Diffie-Hellman secret in constant time
* Returns: 1: exponentiation was successful * Returns: 1: exponentiation was successful
* 0: scalar was invalid (zero or overflow) * 0: scalar was invalid (zero or overflow)
* Args: ctx: pointer to a context object (cannot be NULL) * Args: ctx: pointer to a context object (cannot be NULL)
* Out: result: a 32-byte array which will be populated by an ECDH * Out: result: a 32-byte array which will be populated by an ECDH
* secret computed from the point and scalar * secret computed from the point and scalar
* In: point: pointer to a public point * In: pubkey: a pointer to a secp256k1_pubkey containing an
* scalar: a 32-byte scalar with which to multiply the point * initialized public key
* privkey: a 32-byte scalar with which to multiply the point
*/ */
SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_ecdh( SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_ecdh(
const secp256k1_context* ctx, const secp256k1_context* ctx,
unsigned char *result, unsigned char *result,
const secp256k1_pubkey *point, const secp256k1_pubkey *pubkey,
const unsigned char *scalar const unsigned char *privkey
) SECP256K1_ARG_NONNULL(1) SECP256K1_ARG_NONNULL(2) SECP256K1_ARG_NONNULL(3) SECP256K1_ARG_NONNULL(4); ) SECP256K1_ARG_NONNULL(1) SECP256K1_ARG_NONNULL(2) SECP256K1_ARG_NONNULL(3) SECP256K1_ARG_NONNULL(4);
# ifdef __cplusplus # ifdef __cplusplus