secp256k1_ecdh.h File Reference

#include "secp256k1.h"

Include dependency graph for secp256k1_ecdh.h:

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

Go to the source code of this file.

Typedefs
typedef int(*	secp256k1_ecdh_hash_function) (unsigned char *output, const unsigned char *x, const unsigned char *y, void *data)
	A pointer to a function that applies hash function to a point. More...

Functions
SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int	secp256k1_ecdh (const secp256k1_context *ctx, unsigned char *output, const secp256k1_pubkey *pubkey, const unsigned char *privkey, secp256k1_ecdh_hash_function hashfp, void *data) SECP256K1_ARG_NONNULL(1) SECP256K1_ARG_NONNULL(2) SECP256K1_ARG_NONNULL(3) SECP256K1_ARG_NONNULL(4)
	Compute an EC Diffie-Hellman secret in constant time Returns: 1: exponentiation was successful 0: scalar was invalid (zero or overflow) Args: ctx: pointer to a context object (cannot be NULL) Out: output: pointer to an array to be filled by the function In: pubkey: a pointer to a secp256k1_pubkey containing an initialized public key privkey: a 32-byte scalar with which to multiply the point hashfp: pointer to a hash function. More...

Variables
SECP256K1_API const secp256k1_ecdh_hash_function	secp256k1_ecdh_hash_function_sha256
	An implementation of SHA256 hash function that applies to compressed public key. More...
SECP256K1_API const secp256k1_ecdh_hash_function	secp256k1_ecdh_hash_function_default
	A default ecdh hash function (currently equal to secp256k1_ecdh_hash_function_sha256). More...

Typedef Documentation

secp256k1_ecdh_hash_function

typedef int(* secp256k1_ecdh_hash_function) (unsigned char *output, const unsigned char *x, const unsigned char *y, void *data)

A pointer to a function that applies hash function to a point.

Returns: 1 if a point was successfully hashed. 0 will cause ecdh to fail Out: output: pointer to an array to be filled by the function In: x: pointer to a 32-byte x coordinate y: pointer to a 32-byte y coordinate data: Arbitrary data pointer that is passed through

Definition at line 18 of file secp256k1_ecdh.h.

Function Documentation

secp256k1_ecdh()

SECP256K1_API SECP256K1_WARN_UNUSED_RESULT int secp256k1_ecdh	(	const secp256k1_context *	ctx,
		unsigned char *	output,
		const secp256k1_pubkey *	pubkey,
		const unsigned char *	privkey,
		secp256k1_ecdh_hash_function	hashfp,
		void *	data
	)

Compute an EC Diffie-Hellman secret in constant time Returns: 1: exponentiation was successful 0: scalar was invalid (zero or overflow) Args: ctx: pointer to a context object (cannot be NULL) Out: output: pointer to an array to be filled by the function In: pubkey: a pointer to a secp256k1_pubkey containing an initialized public key privkey: a 32-byte scalar with which to multiply the point hashfp: pointer to a hash function.

If NULL, secp256k1_ecdh_hash_function_sha256 is used data: Arbitrary data pointer that is passed through

Definition at line 29 of file main_impl.h.

References ARG_CHECK, ctx, secp256k1_ecdh_hash_function_default, secp256k1_ecmult_const(), secp256k1_fe_get_b32(), secp256k1_fe_normalize(), secp256k1_ge_set_gej(), secp256k1_pubkey_load(), secp256k1_scalar_clear(), secp256k1_scalar_is_zero(), secp256k1_scalar_set_b32(), VERIFY_CHECK, secp256k1_ge::x, and secp256k1_ge::y.

Referenced by bench_ecdh(), Java_org_bitcoin_NativeSecp256k1_secp256k1_1ecdh(), test_bad_scalar(), test_ecdh_api(), and test_ecdh_generator_basepoint().

Variable Documentation

secp256k1_ecdh_hash_function_default

SECP256K1_API const secp256k1_ecdh_hash_function secp256k1_ecdh_hash_function_default

A default ecdh hash function (currently equal to secp256k1_ecdh_hash_function_sha256).

Definition at line 27 of file main_impl.h.

Referenced by secp256k1_ecdh().

secp256k1_ecdh_hash_function_sha256

SECP256K1_API const secp256k1_ecdh_hash_function secp256k1_ecdh_hash_function_sha256

An implementation of SHA256 hash function that applies to compressed public key.

Definition at line 26 of file main_impl.h.