iqr_ecdh.h

Go to the documentation of this file.

#ifndef IQR_ECDH_H
#define IQR_ECDH_H

#ifdef __cplusplus
extern "C" {
#endif

#include "iqr_api.h"
#include "iqr_context.h"
#include "iqr_retval.h"
#include "iqr_rng.h"

#include <stddef.h>
#include <stdint.h>

// ---------------------------------------------------------------------------------------------------------------------------------
// Opaque data types.
// ---------------------------------------------------------------------------------------------------------------------------------

typedef struct iqr_ECDHParams_struct iqr_ECDHParams;

typedef struct iqr_ECDHPrivateKey_struct iqr_ECDHPrivateKey;

typedef struct iqr_ECDHCurve_struct iqr_ECDHCurve;

// ---------------------------------------------------------------------------------------------------------------------------------
// Curves.
// ---------------------------------------------------------------------------------------------------------------------------------

IQR_EXTERN
const iqr_ECDHCurve IQR_ECDH_NISTP256;

IQR_EXTERN
const iqr_ECDHCurve IQR_ECDH_NISTP384;

IQR_EXTERN
const iqr_ECDHCurve IQR_ECDH_NISTP521;

IQR_EXTERN
const iqr_ECDHCurve IQR_ECDH_X25519;

// ---------------------------------------------------------------------------------------------------------------------------------
// Domain parameter functions.
// ---------------------------------------------------------------------------------------------------------------------------------

IQR_API
iqr_retval iqr_ECDHCreateParams(const iqr_Context *ctx, const iqr_ECDHCurve *curve, iqr_ECDHParams **params);

IQR_API_UNENFORCED_RETURN
iqr_retval iqr_ECDHDestroyParams(iqr_ECDHParams **params);

IQR_API
iqr_retval iqr_ECDHGetPublicKeySize(const iqr_ECDHParams *params, size_t *public_key_size);

IQR_API
iqr_retval iqr_ECDHGetSecretSize(const iqr_ECDHParams *params, size_t *secret_size);

// ---------------------------------------------------------------------------------------------------------------------------------
// Private key generation functions.
// ---------------------------------------------------------------------------------------------------------------------------------

IQR_API
iqr_retval iqr_ECDHCreatePrivateKey(const iqr_ECDHParams *params, const iqr_RNG *rng, iqr_ECDHPrivateKey **private_key);

IQR_API_UNENFORCED_RETURN
iqr_retval iqr_ECDHDestroyPrivateKey(iqr_ECDHPrivateKey **private_key);

// ---------------------------------------------------------------------------------------------------------------------------------
// Public key generation function.
// ---------------------------------------------------------------------------------------------------------------------------------

IQR_API
iqr_retval iqr_ECDHGetPublicKey(const iqr_ECDHPrivateKey *private_key, uint8_t *public_key, size_t public_key_size);

// ---------------------------------------------------------------------------------------------------------------------------------
// Shared secret generation function.
// ---------------------------------------------------------------------------------------------------------------------------------

IQR_API
iqr_retval iqr_ECDHGetSecret(const iqr_ECDHPrivateKey *private_key, const uint8_t *public_key, size_t public_key_size,
    uint8_t *secret, size_t secret_size);

#ifdef __cplusplus
}
#endif

#endif /* IQR_ECDH_H */