src/field.h

   1 /**********************************************************************
   2  * Copyright (c) 2013, 2014 Pieter Wuille                             *
   3  * Distributed under the MIT software license, see the accompanying   *
   4  * file COPYING or http://www.opensource.org/licenses/mit-license.php.*
   5  **********************************************************************/
   6
   7 #ifndef SECP256K1_FIELD_H
   8 #define SECP256K1_FIELD_H
   9
  10 /** Field element module.
  11  *
  12  *  Field elements can be represented in several ways, but code accessing
  13  *  it (and implementations) need to take certain properties into account:
  14  *  - Each field element can be normalized or not.
  15  *  - Each field element has a magnitude, which represents how far away
  16  *    its representation is away from normalization. Normalized elements
  17  *    always have a magnitude of 1, but a magnitude of 1 doesn't imply
  18  *    normality.
  19  */
  20
  21 #if defined HAVE_CONFIG_H
  22 #include "libsecp256k1-config.h"
  23 #endif
  24
  25 #include "util.h"
  26
  27 #if defined(SECP256K1_WIDEMUL_INT128)
  28 #include "field_5x52.h"
  29 #elif defined(SECP256K1_WIDEMUL_INT64)
  30 #include "field_10x26.h"
  31 #else
  32 #error "Please select wide multiplication implementation"
  33 #endif
  34
  35 /** Normalize a field element. This brings the field element to a canonical representation, reduces
  36  *  its magnitude to 1, and reduces it modulo field size `p`.
  37  */
  38 static void secp256k1_fe_normalize(secp256k1_fe *r);
  39
  40 /** Weakly normalize a field element: reduce its magnitude to 1, but don't fully normalize. */
  41 static void secp256k1_fe_normalize_weak(secp256k1_fe *r);
  42
  43 /** Normalize a field element, without constant-time guarantee. */
  44 static void secp256k1_fe_normalize_var(secp256k1_fe *r);
  45
  46 /** Verify whether a field element represents zero i.e. would normalize to a zero value. The field
  47  *  implementation may optionally normalize the input, but this should not be relied upon. */
  48 static int secp256k1_fe_normalizes_to_zero(secp256k1_fe *r);
  49
  50 /** Verify whether a field element represents zero i.e. would normalize to a zero value. The field
  51  *  implementation may optionally normalize the input, but this should not be relied upon. */
  52 static int secp256k1_fe_normalizes_to_zero_var(secp256k1_fe *r);
  53
  54 /** Set a field element equal to a small integer. Resulting field element is normalized. */
  55 static void secp256k1_fe_set_int(secp256k1_fe *r, int a);
  56
  57 /** Sets a field element equal to zero, initializing all fields. */
  58 static void secp256k1_fe_clear(secp256k1_fe *a);
  59
  60 /** Verify whether a field element is zero. Requires the input to be normalized. */
  61 static int secp256k1_fe_is_zero(const secp256k1_fe *a);
  62
  63 /** Check the "oddness" of a field element. Requires the input to be normalized. */
  64 static int secp256k1_fe_is_odd(const secp256k1_fe *a);
  65
  66 /** Compare two field elements. Requires magnitude-1 inputs. */
  67 static int secp256k1_fe_equal(const secp256k1_fe *a, const secp256k1_fe *b);
  68
  69 /** Same as secp256k1_fe_equal, but may be variable time. */
  70 static int secp256k1_fe_equal_var(const secp256k1_fe *a, const secp256k1_fe *b);
  71
  72 /** Compare two field elements. Requires both inputs to be normalized */
  73 static int secp256k1_fe_cmp_var(const secp256k1_fe *a, const secp256k1_fe *b);
  74
  75 /** Set a field element equal to 32-byte big endian value. If successful, the resulting field element is normalized. */
  76 static int secp256k1_fe_set_b32(secp256k1_fe *r, const unsigned char *a);
  77
  78 /** Convert a field element to a 32-byte big endian value. Requires the input to be normalized */
  79 static void secp256k1_fe_get_b32(unsigned char *r, const secp256k1_fe *a);
  80
  81 /** Set a field element equal to the additive inverse of another. Takes a maximum magnitude of the input
  82  *  as an argument. The magnitude of the output is one higher. */
  83 static void secp256k1_fe_negate(secp256k1_fe *r, const secp256k1_fe *a, int m);
  84
  85 /** Multiplies the passed field element with a small integer constant. Multiplies the magnitude by that
  86  *  small integer. */
  87 static void secp256k1_fe_mul_int(secp256k1_fe *r, int a);
  88
  89 /** Adds a field element to another. The result has the sum of the inputs' magnitudes as magnitude. */
  90 static void secp256k1_fe_add(secp256k1_fe *r, const secp256k1_fe *a);
  91
  92 /** Sets a field element to be the product of two others. Requires the inputs' magnitudes to be at most 8.
  93  *  The output magnitude is 1 (but not guaranteed to be normalized). */
  94 static void secp256k1_fe_mul(secp256k1_fe *r, const secp256k1_fe *a, const secp256k1_fe * SECP256K1_RESTRICT b);
  95
  96 /** Sets a field element to be the square of another. Requires the input's magnitude to be at most 8.
  97  *  The output magnitude is 1 (but not guaranteed to be normalized). */
  98 static void secp256k1_fe_sqr(secp256k1_fe *r, const secp256k1_fe *a);
  99
 100 /** If a has a square root, it is computed in r and 1 is returned. If a does not
 101  *  have a square root, the root of its negation is computed and 0 is returned.
 102  *  The input's magnitude can be at most 8. The output magnitude is 1 (but not
 103  *  guaranteed to be normalized). The result in r will always be a square
 104  *  itself. */
 105 static int secp256k1_fe_sqrt(secp256k1_fe *r, const secp256k1_fe *a);
 106
 107 /** Checks whether a field element is a quadratic residue. */
 108 static int secp256k1_fe_is_quad_var(const secp256k1_fe *a);
 109
 110 /** Sets a field element to be the (modular) inverse of another. Requires the input's magnitude to be
 111  *  at most 8. The output magnitude is 1 (but not guaranteed to be normalized). */
 112 static void secp256k1_fe_inv(secp256k1_fe *r, const secp256k1_fe *a);
 113
 114 /** Potentially faster version of secp256k1_fe_inv, without constant-time guarantee. */
 115 static void secp256k1_fe_inv_var(secp256k1_fe *r, const secp256k1_fe *a);
 116
 117 /** Calculate the (modular) inverses of a batch of field elements. Requires the inputs' magnitudes to be
 118  *  at most 8. The output magnitudes are 1 (but not guaranteed to be normalized). The inputs and
 119  *  outputs must not overlap in memory. */
 120 static void secp256k1_fe_inv_all_var(secp256k1_fe *r, const secp256k1_fe *a, size_t len);
 121
 122 /** Convert a field element to the storage type. */
 123 static void secp256k1_fe_to_storage(secp256k1_fe_storage *r, const secp256k1_fe *a);
 124
 125 /** Convert a field element back from the storage type. */
 126 static void secp256k1_fe_from_storage(secp256k1_fe *r, const secp256k1_fe_storage *a);
 127
 128 /** If flag is true, set *r equal to *a; otherwise leave it. Constant-time.  Both *r and *a must be initialized.*/
 129 static void secp256k1_fe_storage_cmov(secp256k1_fe_storage *r, const secp256k1_fe_storage *a, int flag);
 130
 131 /** If flag is true, set *r equal to *a; otherwise leave it. Constant-time.  Both *r and *a must be initialized.*/
 132 static void secp256k1_fe_cmov(secp256k1_fe *r, const secp256k1_fe *a, int flag);
 133
 134 #endif /* SECP256K1_FIELD_H */