ecc-internal.h 8.83 KB
Newer Older
1 2
/* ecc-internal.h

3
   Copyright (C) 2013, 2014 Niels Möller
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30

   This file is part of GNU Nettle.

   GNU Nettle is free software: you can redistribute it and/or
   modify it under the terms of either:

     * the GNU Lesser General Public License as published by the Free
       Software Foundation; either version 3 of the License, or (at your
       option) any later version.

   or

     * the GNU General Public License as published by the Free
       Software Foundation; either version 2 of the License, or (at your
       option) any later version.

   or both in parallel, as here.

   GNU Nettle is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   General Public License for more details.

   You should have received copies of the GNU General Public License and
   the GNU Lesser General Public License along with this program.  If
   not, see http://www.gnu.org/licenses/.
*/
Niels Möller's avatar
Niels Möller committed
31

32
/* Development of Nettle's ECC support was funded by the .SE Internet Fund. */
Niels Möller's avatar
Niels Möller committed
33 34 35 36

#ifndef NETTLE_ECC_INTERNAL_H_INCLUDED
#define NETTLE_ECC_INTERNAL_H_INCLUDED

37
#include "nettle-types.h"
38
#include "bignum.h"
Niels Möller's avatar
Niels Möller committed
39
#include "ecc-curve.h"
40
#include "gmp-glue.h"
Niels Möller's avatar
Niels Möller committed
41 42

/* Name mangling */
43 44
#define ecc_pp1_redc _nettle_ecc_pp1_redc
#define ecc_pm1_redc _nettle_ecc_pm1_redc
45 46 47 48 49 50 51
#define ecc_mod_add _nettle_ecc_mod_add
#define ecc_mod_sub _nettle_ecc_mod_sub
#define ecc_mod_mul_1 _nettle_ecc_mod_mul_1
#define ecc_mod_addmul_1 _nettle_ecc_mod_addmul_1
#define ecc_mod_submul_1 _nettle_ecc_mod_submul_1
#define ecc_mod_mul _nettle_ecc_mod_mul
#define ecc_mod_sqr _nettle_ecc_mod_sqr
52
#define ecc_mod_random _nettle_ecc_mod_random
53
#define ecc_mod _nettle_ecc_mod
54
#define ecc_mod_inv _nettle_ecc_mod_inv
55
#define ecc_hash _nettle_ecc_hash
Niels Möller's avatar
Niels Möller committed
56 57 58 59 60
#define cnd_copy _nettle_cnd_copy
#define sec_add_1 _nettle_sec_add_1
#define sec_sub_1 _nettle_sec_sub_1
#define sec_tabselect _nettle_sec_tabselect
#define sec_modinv _nettle_sec_modinv
61
#define curve25519_eh_to_x _nettle_curve25519_eh_to_x
Niels Möller's avatar
Niels Möller committed
62

63 64
#define ECC_MAX_SIZE ((521 + GMP_NUMB_BITS - 1) / GMP_NUMB_BITS)

Niels Möller's avatar
Niels Möller committed
65 66
/* Window size for ecc_mul_a. Using 4 bits seems like a good choice,
   for both Intel x86_64 and ARM Cortex A9. For the larger curves, of
67
   384 and 521 bits, we could improve speed by a few percent if we go
Niels Möller's avatar
Niels Möller committed
68 69 70
   up to 5 bits, but I don't think that's worth doubling the
   storage. */
#define ECC_MUL_A_WBITS 4
71 72
/* And for ecc_mul_a_eh */
#define ECC_MUL_A_EH_WBITS 4
73

74
struct ecc_modulo;
Niels Möller's avatar
Niels Möller committed
75 76 77

/* Reduces from 2*ecc->size to ecc->size. */
/* Required to return a result < 2q. This property is inherited by
78
   mod_mul and mod_sqr. */
79
typedef void ecc_mod_func (const struct ecc_modulo *m, mp_limb_t *rp);
Niels Möller's avatar
Niels Möller committed
80

81
typedef void ecc_mod_inv_func (const struct ecc_modulo *m,
82
			       mp_limb_t *vp, const mp_limb_t *ap,
83 84
			       mp_limb_t *scratch);

85 86 87 88 89 90
/* Computes the square root of (u/v) (mod p) */
typedef int ecc_mod_sqrt_func (const struct ecc_modulo *m,
			       mp_limb_t *rp,
			       const mp_limb_t *up, const mp_limb_t *vp,
			       mp_limb_t *scratch);

91 92 93 94 95
typedef void ecc_add_func (const struct ecc_curve *ecc,
			   mp_limb_t *r,
			   const mp_limb_t *p, const mp_limb_t *q,
			   mp_limb_t *scratch);

96 97 98 99 100 101 102 103 104 105 106 107 108
typedef void ecc_mul_g_func (const struct ecc_curve *ecc, mp_limb_t *r,
			     const mp_limb_t *np, mp_limb_t *scratch);

typedef void ecc_mul_func (const struct ecc_curve *ecc,
			   mp_limb_t *r,
			   const mp_limb_t *np, const mp_limb_t *p,
			   mp_limb_t *scratch);

typedef void ecc_h_to_a_func (const struct ecc_curve *ecc,
			      int flags,
			      mp_limb_t *r, const mp_limb_t *p,
			      mp_limb_t *scratch);

109 110 111 112 113 114
struct ecc_modulo
{
  unsigned short bit_size;
  unsigned short size;
  unsigned short B_size;
  unsigned short redc_size;
115
  unsigned short invert_itch;
116
  unsigned short sqrt_itch;
117 118 119 120 121 122 123 124 125

  const mp_limb_t *m;
  /* B^size mod m. Expected to have at least 32 leading zeros
     (equality for secp_256r1). */
  const mp_limb_t *B;
  /* 2^{bit_size} - p, same value as above, but shifted. */
  const mp_limb_t *B_shifted;
  /* m +/- 1, for redc, excluding redc_size low limbs. */
  const mp_limb_t *redc_mpm1;
126 127
  /* (m+1)/2 */
  const mp_limb_t *mp1h;
128 129 130

  ecc_mod_func *mod;
  ecc_mod_func *reduce;
131
  ecc_mod_inv_func *invert;
132
  ecc_mod_sqrt_func *sqrt;
133 134
};

Niels Möller's avatar
Niels Möller committed
135 136 137 138 139 140
/* Represents an elliptic curve of the form

     y^2 = x^3 - 3x + b (mod p)
*/
struct ecc_curve
{
Niels Möller's avatar
Niels Möller committed
141 142 143 144 145 146 147
  /* The prime p. */
  struct ecc_modulo p;
  /* Group order. FIXME: Currently, many fucntions rely on q.size ==
     p.size. This has to change for radix-51 implementation of
     curve25519 mod p arithmetic. */
  struct ecc_modulo q;

Niels Möller's avatar
Niels Möller committed
148 149 150 151
  unsigned short use_redc;
  unsigned short pippenger_k;
  unsigned short pippenger_c;

152
  unsigned short add_hhh_itch;
153 154 155 156
  unsigned short mul_itch;
  unsigned short mul_g_itch;
  unsigned short h_to_a_itch;

157
  ecc_add_func *add_hhh;
158 159 160 161
  ecc_mul_func *mul;
  ecc_mul_g_func *mul_g;
  ecc_h_to_a_func *h_to_a;

Niels Möller's avatar
Niels Möller committed
162
  /* Curve constant */
Niels Möller's avatar
Niels Möller committed
163
  const mp_limb_t *b;
164
  /* Generator, x coordinate followed by y (affine coordinates).
Niels Möller's avatar
Niels Möller committed
165
     Currently used only by the test suite. */
Niels Möller's avatar
Niels Möller committed
166
  const mp_limb_t *g;
167 168 169
  /* If non-NULL, the constant needed for transformation to the
     equivalent Edwards curve. */
  const mp_limb_t *edwards_root;
Niels Möller's avatar
Niels Möller committed
170

171
  /* For redc, same as B mod p, otherwise 1. */
Niels Möller's avatar
Niels Möller committed
172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187
  const mp_limb_t *unit;

  /* Tables for multiplying by the generator, size determined by k and
     c. The first 2^c entries are defined by

       T[  j_0 +   j_1 2 +     ... + j_{c-1} 2^{c-1} ]
         = j_0 g + j_1 2^k g + ... + j_{c-1} 2^{k(c-1)} g

     The following entries differ by powers of 2^{kc},

       T[i] = 2^{kc} T[i-2^c]
  */  
  const mp_limb_t *pippenger_table;
};

/* In-place reduction. */
188
ecc_mod_func ecc_mod;
189 190
ecc_mod_func ecc_pp1_redc;
ecc_mod_func ecc_pm1_redc;
Niels Möller's avatar
Niels Möller committed
191

192 193
ecc_mod_inv_func ecc_mod_inv;

Niels Möller's avatar
Niels Möller committed
194
void
195 196
ecc_mod_add (const struct ecc_modulo *m, mp_limb_t *rp,
	     const mp_limb_t *ap, const mp_limb_t *bp);
Niels Möller's avatar
Niels Möller committed
197
void
198 199
ecc_mod_sub (const struct ecc_modulo *m, mp_limb_t *rp,
	     const mp_limb_t *ap, const mp_limb_t *bp);
Niels Möller's avatar
Niels Möller committed
200 201

void
202 203
ecc_mod_mul_1 (const struct ecc_modulo *m, mp_limb_t *rp,
	       const mp_limb_t *ap, const mp_limb_t b);
Niels Möller's avatar
Niels Möller committed
204 205

void
206 207
ecc_mod_addmul_1 (const struct ecc_modulo *m, mp_limb_t *rp,
		  const mp_limb_t *ap, mp_limb_t b);
Niels Möller's avatar
Niels Möller committed
208
void
209 210
ecc_mod_submul_1 (const struct ecc_modulo *m, mp_limb_t *rp,
		  const mp_limb_t *ap, mp_limb_t b);
Niels Möller's avatar
Niels Möller committed
211 212 213

/* NOTE: mul and sqr needs 2*ecc->size limbs at rp */
void
214 215
ecc_mod_mul (const struct ecc_modulo *m, mp_limb_t *rp,
	     const mp_limb_t *ap, const mp_limb_t *bp);
Niels Möller's avatar
Niels Möller committed
216 217

void
218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239
ecc_mod_sqr (const struct ecc_modulo *m, mp_limb_t *rp,
	     const mp_limb_t *ap);

#define ecc_modp_add(ecc, r, a, b) \
  ecc_mod_add (&(ecc)->p, (r), (a), (b))
#define ecc_modp_sub(ecc, r, a, b) \
  ecc_mod_sub (&(ecc)->p, (r), (a), (b))
#define ecc_modp_mul_1(ecc, r, a, b) \
  ecc_mod_mul_1 (&(ecc)->p, (r), (a), (b))
#define ecc_modp_addmul_1(ecc, r, a, b) \
  ecc_mod_addmul_1 (&(ecc)->p, (r), (a), (b))
#define ecc_modp_submul_1(ecc, r, a, b) \
  ecc_mod_submul_1 (&(ecc)->p, (r), (a), (b))
#define ecc_modp_mul(ecc, r, a, b) \
  ecc_mod_mul (&(ecc)->p, (r), (a), (b))
#define ecc_modp_sqr(ecc, r, a) \
  ecc_mod_sqr (&(ecc)->p, (r), (a))

#define ecc_modq_add(ecc, r, a, b) \
  ecc_mod_add (&(ecc)->q, (r), (a), (b))
#define ecc_modq_mul(ecc, r, a, b) \
  ecc_mod_mul (&(ecc)->q, (r), (a), (b))
Niels Möller's avatar
Niels Möller committed
240 241

/* mod q operations. */
242
void
243 244
ecc_mod_random (const struct ecc_modulo *m, mp_limb_t *xp,
		void *ctx, nettle_random_func *random, mp_limb_t *scratch);
245 246

void
247
ecc_hash (const struct ecc_modulo *m,
248
	  mp_limb_t *hp,
Niels Möller's avatar
Niels Möller committed
249
	  size_t length, const uint8_t *digest);
250

Niels Möller's avatar
Niels Möller committed
251 252 253 254 255 256 257 258 259 260 261 262 263 264
void
cnd_copy (int cnd, mp_limb_t *rp, const mp_limb_t *ap, mp_size_t n);

mp_limb_t
sec_add_1 (mp_limb_t *rp, mp_limb_t *ap, mp_size_t n, mp_limb_t b);

mp_limb_t
sec_sub_1 (mp_limb_t *rp, mp_limb_t *ap, mp_size_t n, mp_limb_t b);

void
sec_tabselect (mp_limb_t *rp, mp_size_t rn,
	       const mp_limb_t *table, unsigned tn,
	       unsigned k);

265 266 267 268
void
curve25519_eh_to_x (mp_limb_t *xp, const mp_limb_t *p,
		    mp_limb_t *scratch);

Niels Möller's avatar
Niels Möller committed
269
/* Current scratch needs: */
270
#define ECC_MOD_INV_ITCH(size) (2*(size))
Niels Möller's avatar
Niels Möller committed
271
#define ECC_J_TO_A_ITCH(size) (5*(size))
272
#define ECC_EH_TO_A_ITCH(size, inv) (2*(size)+(inv))
Niels Möller's avatar
Niels Möller committed
273
#define ECC_DUP_JJ_ITCH(size) (5*(size))
274
#define ECC_DUP_EH_ITCH(size) (5*(size))
Niels Möller's avatar
Niels Möller committed
275 276
#define ECC_ADD_JJA_ITCH(size) (6*(size))
#define ECC_ADD_JJJ_ITCH(size) (8*(size))
277
#define ECC_ADD_EH_ITCH(size) (6*(size))
278
#define ECC_ADD_EHH_ITCH(size) (7*(size))
Niels Möller's avatar
Niels Möller committed
279
#define ECC_MUL_G_ITCH(size) (9*(size))
280
#define ECC_MUL_G_EH_ITCH(size) (9*(size))
Niels Möller's avatar
Niels Möller committed
281 282 283 284 285 286
#if ECC_MUL_A_WBITS == 0
#define ECC_MUL_A_ITCH(size) (12*(size))
#else
#define ECC_MUL_A_ITCH(size) \
  (((3 << ECC_MUL_A_WBITS) + 11) * (size))
#endif
287 288 289 290 291 292
#if ECC_MUL_A_EH_WBITS == 0
#define ECC_MUL_A_EH_ITCH(size) (13*(size))
#else
#define ECC_MUL_A_EH_ITCH(size) \
  (((3 << ECC_MUL_A_EH_WBITS) + 10) * (size))
#endif
293
#define ECC_ECDSA_SIGN_ITCH(size) (12*(size))
294
#define ECC_MOD_RANDOM_ITCH(size) (size)
295
#define ECC_HASH_ITCH(size) (1+(size))
Niels Möller's avatar
Niels Möller committed
296 297

#endif /* NETTLE_ECC_INTERNAL_H_INCLUDED */