ed448.h

/**
 * @file goldilocks/ed448.h
 * @author Mike Hamburg
 *
 * @copyright
 *   Copyright (c) 2015-2016 Cryptography Research, Inc.  \n
 *   Copyright (c) 2018 the libgoldilocks contributors.  \n
 *   Released under the MIT License.  See LICENSE.txt for license information.
 *
 * @brief A group of prime order p, based on Ed448-Goldilocks.
 */

#ifndef __GOLDILOCKS_ED448_H__
#define __GOLDILOCKS_ED448_H__ 1

#include <./point_448.h>
#include <./shake.h>

#ifdef __cplusplus
extern "C" {
#endif

/** Number of bytes in an EdDSA public key. */
#define GOLDILOCKS_EDDSA_448_PUBLIC_BYTES 57

/** Number of bytes in an EdDSA private key. */
#define GOLDILOCKS_EDDSA_448_PRIVATE_BYTES GOLDILOCKS_EDDSA_448_PUBLIC_BYTES

/** Number of bytes in an EdDSA signature. */
#define GOLDILOCKS_EDDSA_448_SIGNATURE_BYTES (GOLDILOCKS_EDDSA_448_PUBLIC_BYTES + GOLDILOCKS_EDDSA_448_PRIVATE_BYTES)

/** Does EdDSA support non-contextual signatures? */
#define GOLDILOCKS_EDDSA_448_SUPPORTS_CONTEXTLESS_SIGS 0


/** Prehash context (raw), because each EdDSA instance has a different prehash. */
#define goldilocks_ed448_prehash_ctx_s   goldilocks_shake256_ctx_s

/** Prehash context, array[1] form. */
#define goldilocks_ed448_prehash_ctx_p   goldilocks_shake256_ctx_p

/** Prehash update. */
#define goldilocks_ed448_prehash_update  goldilocks_shake256_update

/** Prehash destroy. */
#define goldilocks_ed448_prehash_destroy goldilocks_shake256_destroy

/** EdDSA encoding ratio. */
#define GOLDILOCKS_448_EDDSA_ENCODE_RATIO 4

/** EdDSA decoding ratio. */
#define GOLDILOCKS_448_EDDSA_DECODE_RATIO (4 / 4)

/**
 * @brief EdDSA key secret key generation.  This function uses a different (non-Decaf)
 * encoding. It is used for libotrv4.
 *
 * @param [out] secret The secret key.
 * @param [in] privkey The private key.
 */
void goldilocks_ed448_derive_secret_scalar (
    goldilocks_448_scalar_p secret,
    const uint8_t privkey[GOLDILOCKS_EDDSA_448_PRIVATE_BYTES]
) GOLDILOCKS_API_VIS GOLDILOCKS_NONNULL GOLDILOCKS_NOINLINE;

/**
 * @brief EdDSA key generation.  This function uses a different (non-Decaf)
 * encoding.
 *
 * @param [out] pubkey The public key.
 * @param [in] privkey The private key.
 */
void goldilocks_ed448_derive_public_key (
    uint8_t pubkey[GOLDILOCKS_EDDSA_448_PUBLIC_BYTES],
    const uint8_t privkey[GOLDILOCKS_EDDSA_448_PRIVATE_BYTES]
) GOLDILOCKS_API_VIS GOLDILOCKS_NONNULL GOLDILOCKS_NOINLINE;

/**
 * @brief EdDSA signing.
 *
 * @param [out] signature The signature.
 * @param [in] privkey The private key.
 * @param [in] pubkey The public key.
 * @param [in] message The message to sign.
 * @param [in] message_len The length of the message.
 * @param [in] prehashed Nonzero if the message is actually the hash of something you want to sign.
 * @param [in] context A "context" for this signature of up to 255 bytes.
 * @param [in] context_len Length of the context.
 *
 * @warning For Ed25519, it is unsafe to use the same key for both prehashed and non-prehashed
 * messages, at least without some very careful protocol-level disambiguation.  For Ed448 it is
 * safe.  The C++ wrapper is designed to make it harder to screw this up, but this C code gives
 * you no seat belt.
 */
void goldilocks_ed448_sign (
    uint8_t signature[GOLDILOCKS_EDDSA_448_SIGNATURE_BYTES],
    const uint8_t privkey[GOLDILOCKS_EDDSA_448_PRIVATE_BYTES],
    const uint8_t pubkey[GOLDILOCKS_EDDSA_448_PUBLIC_BYTES],
    const uint8_t *message,
    size_t message_len,
    uint8_t prehashed,
    const uint8_t *context,
    uint8_t context_len
) GOLDILOCKS_API_VIS __attribute__((nonnull(1,2,3))) GOLDILOCKS_NOINLINE;

/**
 * @brief EdDSA signing with prehash.
 *
 * @param [out] signature The signature.
 * @param [in] privkey The private key.
 * @param [in] pubkey The public key.
 * @param [in] hash The hash of the message.  This object will not be modified by the call.
 * @param [in] context A "context" for this signature of up to 255 bytes.  Must be the same as what was used for the prehash.
 * @param [in] context_len Length of the context.
 *
 * @warning For Ed25519, it is unsafe to use the same key for both prehashed and non-prehashed
 * messages, at least without some very careful protocol-level disambiguation.  For Ed448 it is
 * safe.  The C++ wrapper is designed to make it harder to screw this up, but this C code gives
 * you no seat belt.
 */
void goldilocks_ed448_sign_prehash (
    uint8_t signature[GOLDILOCKS_EDDSA_448_SIGNATURE_BYTES],
    const uint8_t privkey[GOLDILOCKS_EDDSA_448_PRIVATE_BYTES],
    const uint8_t pubkey[GOLDILOCKS_EDDSA_448_PUBLIC_BYTES],
    const goldilocks_ed448_prehash_ctx_p hash,
    const uint8_t *context,
    uint8_t context_len
) GOLDILOCKS_API_VIS __attribute__((nonnull(1,2,3,4))) GOLDILOCKS_NOINLINE;

/**
 * @brief Prehash initialization, with contexts if supported.
 *
 * @param [out] hash The hash object to be initialized.
 */
void goldilocks_ed448_prehash_init (
    goldilocks_ed448_prehash_ctx_p hash
) GOLDILOCKS_API_VIS __attribute__((nonnull(1))) GOLDILOCKS_NOINLINE;

/**
 * @brief EdDSA signature verification.
 *
 * Uses the standard (i.e. less-strict) verification formula.
 *
 * @param [in] signature The signature.
 * @param [in] pubkey The public key.
 * @param [in] message The message to verify.
 * @param [in] message_len The length of the message.
 * @param [in] prehashed Nonzero if the message is actually the hash of something you want to verify.
 * @param [in] context A "context" for this signature of up to 255 bytes.
 * @param [in] context_len Length of the context.
 *
 * @warning For Ed25519, it is unsafe to use the same key for both prehashed and non-prehashed
 * messages, at least without some very careful protocol-level disambiguation.  For Ed448 it is
 * safe.  The C++ wrapper is designed to make it harder to screw this up, but this C code gives
 * you no seat belt.
 */
goldilocks_error_t goldilocks_ed448_verify (
    const uint8_t signature[GOLDILOCKS_EDDSA_448_SIGNATURE_BYTES],
    const uint8_t pubkey[GOLDILOCKS_EDDSA_448_PUBLIC_BYTES],
    const uint8_t *message,
    size_t message_len,
    uint8_t prehashed,
    const uint8_t *context,
    uint8_t context_len
) GOLDILOCKS_API_VIS __attribute__((nonnull(1,2))) GOLDILOCKS_NOINLINE;

/**
 * @brief EdDSA signature verification.
 *
 * Uses the standard (i.e. less-strict) verification formula.
 *
 * @param [in] signature The signature.
 * @param [in] pubkey The public key.
 * @param [in] hash The hash of the message.  This object will not be modified by the call.
 * @param [in] context A "context" for this signature of up to 255 bytes.  Must be the same as what was used for the prehash.
 * @param [in] context_len Length of the context.
 *
 * @warning For Ed25519, it is unsafe to use the same key for both prehashed and non-prehashed
 * messages, at least without some very careful protocol-level disambiguation.  For Ed448 it is
 * safe.  The C++ wrapper is designed to make it harder to screw this up, but this C code gives
 * you no seat belt.
 */
goldilocks_error_t goldilocks_ed448_verify_prehash (
    const uint8_t signature[GOLDILOCKS_EDDSA_448_SIGNATURE_BYTES],
    const uint8_t pubkey[GOLDILOCKS_EDDSA_448_PUBLIC_BYTES],
    const goldilocks_ed448_prehash_ctx_p hash,
    const uint8_t *context,
    uint8_t context_len
) GOLDILOCKS_API_VIS __attribute__((nonnull(1,2))) GOLDILOCKS_NOINLINE;

/**
 * @brief EdDSA point encoding.  Used internally, exposed externally.
 * Multiplies by GOLDILOCKS_448_EDDSA_ENCODE_RATIO first.
 *
 * The multiplication is required because the EdDSA encoding represents
 * the cofactor information, but the Decaf encoding ignores it (which
 * is the whole point).  So if you decode from EdDSA and re-encode to
 * EdDSA, the cofactor info must get cleared, because the intermediate
 * representation doesn't track it.
 *
 * The way libgoldilocks handles this is to multiply by
 * GOLDILOCKS_448_EDDSA_DECODE_RATIO when decoding, and by
 * GOLDILOCKS_448_EDDSA_ENCODE_RATIO when encoding.  The product of these
 * ratios is always exactly the cofactor 4, so the cofactor
 * ends up cleared one way or another.  But exactly how that shakes
 * out depends on the base points specified in RFC 8032.
 *
 * The upshot is that if you pass the base point to
 * this function, you will get GOLDILOCKS_448_EDDSA_ENCODE_RATIO times the
 * EdDSA base point.
 *
 * @param [out] enc The encoded point.
 * @param [in] p The point.
 */
void goldilocks_448_point_mul_by_ratio_and_encode_like_eddsa (
    uint8_t enc[GOLDILOCKS_EDDSA_448_PUBLIC_BYTES],
    const goldilocks_448_point_p p
) GOLDILOCKS_API_VIS GOLDILOCKS_NONNULL GOLDILOCKS_NOINLINE;

/**
 * @brief EdDSA point decoding.  Multiplies by GOLDILOCKS_448_EDDSA_DECODE_RATIO,
 * and ignores cofactor information.
 *
 * See notes on goldilocks_448_point_mul_by_ratio_and_encode_like_eddsa
 *
 * @param [out] enc The encoded point.
 * @param [in] p The point.
 */
goldilocks_error_t goldilocks_448_point_decode_like_eddsa_and_mul_by_ratio (
    goldilocks_448_point_p p,
    const uint8_t enc[GOLDILOCKS_EDDSA_448_PUBLIC_BYTES]
) GOLDILOCKS_API_VIS GOLDILOCKS_NONNULL GOLDILOCKS_NOINLINE;

/**
 * @brief EdDSA to ECDH public key conversion
 * Deserialize the point to get y on Edwards curve,
 * Convert it to u coordinate on Montgomery curve.
 *
 * @warning This function does not check that the public key being converted
 * is a valid EdDSA public key (FUTURE?)
 *
 * @param[out] x The ECDH public key as in RFC7748(point on Montgomery curve)
 * @param[in] ed The EdDSA public key(point on Edwards curve)
 */
void goldilocks_ed448_convert_public_key_to_x448 (
    uint8_t x[GOLDILOCKS_X448_PUBLIC_BYTES],
    const uint8_t ed[GOLDILOCKS_EDDSA_448_PUBLIC_BYTES]
) GOLDILOCKS_API_VIS GOLDILOCKS_NONNULL GOLDILOCKS_NOINLINE;

/**
 * @brief EdDSA to ECDH private key conversion
 * Using the appropriate hash function, hash the EdDSA private key
 * and keep only the lower bytes to get the ECDH private key
 *
 * @param[out] x The ECDH private key as in RFC7748
 * @param[in] ed The EdDSA private key
 */
void goldilocks_ed448_convert_private_key_to_x448 (
    uint8_t x[GOLDILOCKS_X448_PRIVATE_BYTES],
    const uint8_t ed[GOLDILOCKS_EDDSA_448_PRIVATE_BYTES]
) GOLDILOCKS_API_VIS GOLDILOCKS_NONNULL GOLDILOCKS_NOINLINE;
void goldilocks_ed448_private_to_secretkey (
    uint8_t secretkey[GOLDILOCKS_EDDSA_448_PRIVATE_BYTES],
    const uint8_t privkey[GOLDILOCKS_EDDSA_448_PRIVATE_BYTES]
) GOLDILOCKS_API_VIS GOLDILOCKS_NONNULL GOLDILOCKS_NOINLINE;

void goldilocks_ed448_sign_with_secretkey_and_prenonce (
    uint8_t signature[GOLDILOCKS_EDDSA_448_SIGNATURE_BYTES],
    const uint8_t secretkey[GOLDILOCKS_EDDSA_448_PRIVATE_BYTES],
    const uint8_t seed[GOLDILOCKS_EDDSA_448_PRIVATE_BYTES],
    const uint8_t pubkey[GOLDILOCKS_EDDSA_448_PUBLIC_BYTES],
    const uint8_t *message,
    size_t message_len,
    uint8_t prehashed,
    const uint8_t *context,
    uint8_t context_len
) GOLDILOCKS_API_VIS __attribute__((nonnull(1,2,3,4))) GOLDILOCKS_NOINLINE;

void goldilocks_ed448_derive_public_key_from_secretkey (
    uint8_t pubkey[GOLDILOCKS_EDDSA_448_PUBLIC_BYTES],
    const uint8_t secretkey[GOLDILOCKS_EDDSA_448_PRIVATE_BYTES]
) GOLDILOCKS_API_VIS GOLDILOCKS_NONNULL GOLDILOCKS_NOINLINE;

void goldilocks_ed448_add_two_publickeys (
    uint8_t pubkey[GOLDILOCKS_EDDSA_448_PUBLIC_BYTES],
    const uint8_t publickey1[GOLDILOCKS_EDDSA_448_PUBLIC_BYTES],
    const uint8_t publickey2[GOLDILOCKS_EDDSA_448_PUBLIC_BYTES]
) GOLDILOCKS_API_VIS GOLDILOCKS_NONNULL GOLDILOCKS_NOINLINE; 

#ifdef __cplusplus
} /* extern "C" */
#endif

#endif /* __GOLDILOCKS_ED448_H__ */