Fix Serpent-AVX2 and Camellia-AVX2 counter modes
[libgcrypt.git] / src / mpi.h
1 /* mpi.h  -  Multi Precision Integers
2  * Copyright (C) 1994, 1996, 1998,
3  *               2001, 2002, 2003, 2005 Free Software Foundation, Inc.
4  *
5  * This file is part of Libgcrypt.
6  *
7  * Libgcrypt is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU Lesser general Public License as
9  * published by the Free Software Foundation; either version 2.1 of
10  * the License, or (at your option) any later version.
11  *
12  * Libgcrypt is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with this program; if not, write to the Free Software
19  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
20  *
21  * Note: This code is heavily based on the GNU MP Library.
22  *       Actually it's the same code with only minor changes in the
23  *       way the data is stored; this is to support the abstraction
24  *       of an optional secure memory allocation which may be used
25  *       to avoid revealing of sensitive data due to paging etc.
26  */
27
28 #ifndef G10_MPI_H
29 #define G10_MPI_H
30
31 #include <config.h>
32 #include <stdio.h>
33 #include <string.h>
34
35 #include "types.h"
36 #include "../mpi/mpi-asm-defs.h"
37
38 #include "g10lib.h"
39
40 #ifndef _GCRYPT_IN_LIBGCRYPT
41 #error this file should only be used inside libgcrypt
42 #endif
43
44 #ifndef BITS_PER_MPI_LIMB
45 #if BYTES_PER_MPI_LIMB == SIZEOF_UNSIGNED_INT
46   typedef unsigned int mpi_limb_t;
47   typedef   signed int mpi_limb_signed_t;
48 #elif BYTES_PER_MPI_LIMB == SIZEOF_UNSIGNED_LONG
49   typedef unsigned long int mpi_limb_t;
50   typedef   signed long int mpi_limb_signed_t;
51 #elif BYTES_PER_MPI_LIMB == SIZEOF_UNSIGNED_LONG_LONG
52   typedef unsigned long long int mpi_limb_t;
53   typedef   signed long long int mpi_limb_signed_t;
54 #elif BYTES_PER_MPI_LIMB == SIZEOF_UNSIGNED_SHORT
55   typedef unsigned short int mpi_limb_t;
56   typedef   signed short int mpi_limb_signed_t;
57 #else
58 #error BYTES_PER_MPI_LIMB does not match any C type
59 #endif
60 #define BITS_PER_MPI_LIMB    (8*BYTES_PER_MPI_LIMB)
61 #endif /*BITS_PER_MPI_LIMB*/
62
63 #define DBG_MPI     _gcry_get_debug_flag( 2 );
64
65 struct gcry_mpi
66 {
67   int alloced;         /* Array size (# of allocated limbs). */
68   int nlimbs;          /* Number of valid limbs. */
69   int sign;            /* Indicates a negative number and is also used
70                           for opaque MPIs to store the length.  */
71   unsigned int flags; /* Bit 0: Array to be allocated in secure memory space.*/
72                       /* Bit 2: The limb is a pointer to some m_alloced data.*/
73                       /* Bit 4: Immutable MPI - the MPI may not be modified.  */
74                       /* Bit 5: Constant MPI - the MPI will not be freed.  */
75   mpi_limb_t *d;      /* Array with the limbs */
76 };
77
78 #define MPI_NULL NULL
79
80 #define mpi_get_nlimbs(a)     ((a)->nlimbs)
81 #define mpi_has_sign(a)       ((a)->sign)
82
83 /*-- mpiutil.c --*/
84
85 #ifdef M_DEBUG
86 # define mpi_alloc(n)   _gcry_mpi_debug_alloc((n), M_DBGINFO( __LINE__ ) )
87 # define mpi_alloc_secure(n)  _gcry_mpi_debug_alloc_secure((n), M_DBGINFO( __LINE__ ) )
88 # define mpi_free(a)    _gcry_mpi_debug_free((a), M_DBGINFO(__LINE__) )
89 # define mpi_resize(a,b) _gcry_mpi_debug_resize((a),(b), M_DBGINFO(__LINE__) )
90 # define mpi_copy(a)      _gcry_mpi_debug_copy((a), M_DBGINFO(__LINE__) )
91   gcry_mpi_t _gcry_mpi_debug_alloc( unsigned nlimbs, const char *info );
92   gcry_mpi_t _gcry_mpi_debug_alloc_secure( unsigned nlimbs, const char *info );
93   void _gcry_mpi_debug_free( gcry_mpi_t a, const char *info );
94   void _gcry_mpi_debug_resize( gcry_mpi_t a, unsigned nlimbs, const char *info );
95   gcry_mpi_t  _gcry_mpi_debug_copy( gcry_mpi_t a, const char *info      );
96 #else
97 # define mpi_alloc(n)          _gcry_mpi_alloc((n) )
98 # define mpi_alloc_secure(n)  _gcry_mpi_alloc_secure((n) )
99 # define mpi_free(a)           _gcry_mpi_free((a) )
100 # define mpi_resize(a,b)      _gcry_mpi_resize((a),(b))
101 # define mpi_copy(a)           _gcry_mpi_copy((a))
102   gcry_mpi_t  _gcry_mpi_alloc( unsigned nlimbs );
103   gcry_mpi_t  _gcry_mpi_alloc_secure( unsigned nlimbs );
104   void _gcry_mpi_free( gcry_mpi_t a );
105   void _gcry_mpi_resize( gcry_mpi_t a, unsigned nlimbs );
106   gcry_mpi_t  _gcry_mpi_copy( gcry_mpi_t a );
107 #endif
108
109 void _gcry_mpi_immutable_failed (void);
110 #define mpi_immutable_failed() _gcry_mpi_immutable_failed ()
111
112 #define mpi_is_const(a)       ((a) && ((a)->flags&32))
113 #define mpi_is_immutable(a)   ((a) && ((a)->flags&16))
114 #define mpi_is_opaque(a)      ((a) && ((a)->flags&4))
115 #define mpi_is_secure(a)      ((a) && ((a)->flags&1))
116 #define mpi_clear(a)          _gcry_mpi_clear ((a))
117 #define mpi_alloc_like(a)     _gcry_mpi_alloc_like((a))
118 #define mpi_snatch(a,b)       _gcry_mpi_snatch ((a),(b))
119 #define mpi_set(a,b)          _gcry_mpi_set ((a),(b))
120 #define mpi_set_ui(a,b)       _gcry_mpi_set_ui ((a),(b))
121 #define mpi_get_ui(a,b)       _gcry_mpi_get_ui ((a),(b))
122 #define mpi_alloc_set_ui(a)   _gcry_mpi_alloc_set_ui ((a))
123 #define mpi_m_check(a)        _gcry_mpi_m_check ((a))
124 #define mpi_swap(a,b)         _gcry_mpi_swap ((a),(b))
125 #define mpi_new(n)            _gcry_mpi_new ((n))
126 #define mpi_snew(n)           _gcry_mpi_snew ((n))
127 #define mpi_const(n)          _gcry_mpi_const ((n))
128
129 void _gcry_mpi_clear( gcry_mpi_t a );
130 gcry_mpi_t  _gcry_mpi_alloc_like( gcry_mpi_t a );
131 gcry_mpi_t  _gcry_mpi_alloc_set_ui( unsigned long u);
132 gcry_err_code_t _gcry_mpi_get_ui (gcry_mpi_t w, ulong *u);
133 void _gcry_mpi_m_check( gcry_mpi_t a );
134 void _gcry_mpi_swap( gcry_mpi_t a, gcry_mpi_t b);
135 gcry_mpi_t _gcry_mpi_new (unsigned int nbits);
136 gcry_mpi_t _gcry_mpi_snew (unsigned int nbits);
137 gcry_mpi_t _gcry_mpi_set_opaque_copy (gcry_mpi_t a,
138                                       const void *p, unsigned int nbits);
139 void *_gcry_mpi_get_opaque_copy (gcry_mpi_t a, unsigned int *nbits);
140 int _gcry_mpi_is_neg (gcry_mpi_t a);
141 void _gcry_mpi_neg (gcry_mpi_t w, gcry_mpi_t u);
142 void _gcry_mpi_abs (gcry_mpi_t w);
143
144 /* Constants used to return constant MPIs.  See _gcry_mpi_init if you
145    want to add more constants. */
146 #define MPI_NUMBER_OF_CONSTANTS 6
147 enum gcry_mpi_constants
148   {
149     MPI_C_ZERO,
150     MPI_C_ONE,
151     MPI_C_TWO,
152     MPI_C_THREE,
153     MPI_C_FOUR,
154     MPI_C_EIGHT
155   };
156
157
158 gcry_mpi_t _gcry_mpi_const (enum gcry_mpi_constants no);
159
160
161 /*-- mpicoder.c --*/
162 void  _gcry_log_mpidump( const char *text, gcry_mpi_t a );
163 u32   _gcry_mpi_get_keyid( gcry_mpi_t a, u32 *keyid );
164 byte *_gcry_mpi_get_buffer (gcry_mpi_t a, unsigned int fill_le,
165                             unsigned int *r_nbytes, int *sign);
166 byte *_gcry_mpi_get_secure_buffer (gcry_mpi_t a, unsigned int fill_le,
167                                    unsigned *r_nbytes, int *sign);
168 void  _gcry_mpi_set_buffer ( gcry_mpi_t a, const void *buffer,
169                              unsigned int nbytes, int sign );
170 gpg_err_code_t _gcry_mpi_to_octet_string (unsigned char **r_frame,
171                                           void *space,
172                                           gcry_mpi_t value, size_t nbytes);
173
174 /*-- mpi-add.c --*/
175 #define mpi_add_ui(w,u,v) gcry_mpi_add_ui((w),(u),(v))
176 #define mpi_add(w,u,v)    gcry_mpi_add ((w),(u),(v))
177 #define mpi_addm(w,u,v,m) gcry_mpi_addm ((w),(u),(v),(m))
178 #define mpi_sub_ui(w,u,v) gcry_mpi_sub_ui ((w),(u),(v))
179 #define mpi_sub(w,u,v)    gcry_mpi_sub ((w),(u),(v))
180 #define mpi_subm(w,u,v,m) gcry_mpi_subm ((w),(u),(v),(m))
181
182
183 /*-- mpi-mul.c --*/
184 #define mpi_mul_ui(w,u,v)   gcry_mpi_mul_ui ((w),(u),(v))
185 #define mpi_mul_2exp(w,u,v) gcry_mpi_mul_2exp ((w),(u),(v))
186 #define mpi_mul(w,u,v)      gcry_mpi_mul ((w),(u),(v))
187 #define mpi_mulm(w,u,v,m)   gcry_mpi_mulm ((w),(u),(v),(m))
188
189
190 /*-- mpi-div.c --*/
191 #define mpi_fdiv_r_ui(a,b,c)   _gcry_mpi_fdiv_r_ui((a),(b),(c))
192 #define mpi_fdiv_r(a,b,c)      _gcry_mpi_fdiv_r((a),(b),(c))
193 #define mpi_fdiv_q(a,b,c)      _gcry_mpi_fdiv_q((a),(b),(c))
194 #define mpi_fdiv_qr(a,b,c,d)   _gcry_mpi_fdiv_qr((a),(b),(c),(d))
195 #define mpi_tdiv_r(a,b,c)      _gcry_mpi_tdiv_r((a),(b),(c))
196 #define mpi_tdiv_qr(a,b,c,d)   _gcry_mpi_tdiv_qr((a),(b),(c),(d))
197 #define mpi_tdiv_q_2exp(a,b,c) _gcry_mpi_tdiv_q_2exp((a),(b),(c))
198 #define mpi_divisible_ui(a,b)  _gcry_mpi_divisible_ui((a),(b))
199
200 ulong _gcry_mpi_fdiv_r_ui( gcry_mpi_t rem, gcry_mpi_t dividend, ulong divisor );
201 void  _gcry_mpi_fdiv_r( gcry_mpi_t rem, gcry_mpi_t dividend, gcry_mpi_t divisor );
202 void  _gcry_mpi_fdiv_q( gcry_mpi_t quot, gcry_mpi_t dividend, gcry_mpi_t divisor );
203 void  _gcry_mpi_fdiv_qr( gcry_mpi_t quot, gcry_mpi_t rem, gcry_mpi_t dividend, gcry_mpi_t divisor );
204 void  _gcry_mpi_tdiv_r( gcry_mpi_t rem, gcry_mpi_t num, gcry_mpi_t den);
205 void  _gcry_mpi_tdiv_qr( gcry_mpi_t quot, gcry_mpi_t rem, gcry_mpi_t num, gcry_mpi_t den);
206 void  _gcry_mpi_tdiv_q_2exp( gcry_mpi_t w, gcry_mpi_t u, unsigned count );
207 int   _gcry_mpi_divisible_ui(gcry_mpi_t dividend, ulong divisor );
208
209
210 /*-- mpi-mod.c --*/
211 #define mpi_mod(r,a,m)            _gcry_mpi_mod ((r), (a), (m))
212 #define mpi_barrett_init(m,f)     _gcry_mpi_barrett_init ((m),(f))
213 #define mpi_barrett_free(c)       _gcry_mpi_barrett_free ((c))
214 #define mpi_mod_barrett(r,a,c)    _gcry_mpi_mod_barrett ((r), (a), (c))
215 #define mpi_mul_barrett(r,u,v,c)  _gcry_mpi_mul_barrett ((r), (u), (v), (c))
216
217 void _gcry_mpi_mod (gcry_mpi_t r, gcry_mpi_t dividend, gcry_mpi_t divisor);
218
219 /* Context used with Barrett reduction.  */
220 struct barrett_ctx_s;
221 typedef struct barrett_ctx_s *mpi_barrett_t;
222
223 mpi_barrett_t _gcry_mpi_barrett_init (gcry_mpi_t m, int copy);
224 void _gcry_mpi_barrett_free (mpi_barrett_t ctx);
225 void _gcry_mpi_mod_barrett (gcry_mpi_t r, gcry_mpi_t x, mpi_barrett_t ctx);
226 void _gcry_mpi_mul_barrett (gcry_mpi_t w, gcry_mpi_t u, gcry_mpi_t v,
227                             mpi_barrett_t ctx);
228
229
230
231 /*-- mpi-gcd.c --*/
232
233 /*-- mpi-mpow.c --*/
234 #define mpi_mulpowm(a,b,c,d) _gcry_mpi_mulpowm ((a),(b),(c),(d))
235 void _gcry_mpi_mulpowm( gcry_mpi_t res, gcry_mpi_t *basearray, gcry_mpi_t *exparray, gcry_mpi_t mod);
236
237 /*-- mpi-cmp.c --*/
238 #define mpi_cmp_ui(a,b) gcry_mpi_cmp_ui ((a),(b))
239 #define mpi_cmp(a,b)    gcry_mpi_cmp ((a),(b))
240 int gcry_mpi_cmp_ui( gcry_mpi_t u, ulong v );
241 int gcry_mpi_cmp( gcry_mpi_t u, gcry_mpi_t v );
242
243 /*-- mpi-scan.c --*/
244 #define mpi_trailing_zeros(a) _gcry_mpi_trailing_zeros ((a))
245 int      _gcry_mpi_getbyte( gcry_mpi_t a, unsigned idx );
246 void     _gcry_mpi_putbyte( gcry_mpi_t a, unsigned idx, int value );
247 unsigned _gcry_mpi_trailing_zeros( gcry_mpi_t a );
248
249 /*-- mpi-bit.c --*/
250 #define mpi_normalize(a)       _gcry_mpi_normalize ((a))
251 #define mpi_get_nbits(a)       gcry_mpi_get_nbits ((a))
252 #define mpi_test_bit(a,b)      gcry_mpi_test_bit ((a),(b))
253 #define mpi_set_bit(a,b)       gcry_mpi_set_bit ((a),(b))
254 #define mpi_set_highbit(a,b)   gcry_mpi_set_highbit ((a),(b))
255 #define mpi_clear_bit(a,b)     gcry_mpi_clear_bit ((a),(b))
256 #define mpi_clear_highbit(a,b) gcry_mpi_clear_highbit ((a),(b))
257 #define mpi_rshift(a,b,c)      gcry_mpi_rshift ((a),(b),(c))
258 #define mpi_lshift(a,b,c)      gcry_mpi_lshift ((a),(b),(c))
259
260 void _gcry_mpi_normalize( gcry_mpi_t a );
261
262 /*-- mpi-inv.c --*/
263 #define mpi_invm(a,b,c) _gcry_mpi_invm ((a),(b),(c))
264
265 /*-- ec.c --*/
266
267 /* Object to represent a point in projective coordinates. */
268 struct gcry_mpi_point
269 {
270   gcry_mpi_t x;
271   gcry_mpi_t y;
272   gcry_mpi_t z;
273 };
274 typedef struct gcry_mpi_point mpi_point_struct;
275 typedef struct gcry_mpi_point *mpi_point_t;
276
277 void _gcry_mpi_point_init (mpi_point_t p);
278 void _gcry_mpi_point_free_parts (mpi_point_t p);
279 void _gcry_mpi_get_point (gcry_mpi_t x, gcry_mpi_t y, gcry_mpi_t z,
280                           mpi_point_t point);
281 void _gcry_mpi_snatch_point (gcry_mpi_t x, gcry_mpi_t y, gcry_mpi_t z,
282                              mpi_point_t point);
283
284
285 /* Models describing an elliptic curve.  */
286 enum gcry_mpi_ec_models
287   {
288
289     MPI_EC_WEIERSTRASS = 0,
290     MPI_EC_MONTGOMERY,
291     MPI_EC_TWISTEDEDWARDS
292     /* The equation for Twisted Edwards curves is
293           ax^2 + y^2 = 1 + bx^2y^2
294        Note that we use 'b' instead of the commonly used 'd'.  */
295   };
296
297 /* Dialects used with elliptic curves.  It is easier to keep the
298    definition here than in ecc-common.h. */
299 enum ecc_dialects
300   {
301     ECC_DIALECT_STANDARD = 0,
302     ECC_DIALECT_ED25519
303   };
304
305
306 /* Context used with elliptic curve functions.  */
307 struct mpi_ec_ctx_s;
308 typedef struct mpi_ec_ctx_s *mpi_ec_t;
309
310 void _gcry_mpi_point_log (const char *name, mpi_point_t point, mpi_ec_t ctx);
311 #define log_printpnt(a,p,c) _gcry_mpi_point_log ((a), (p), (c))
312
313 mpi_ec_t _gcry_mpi_ec_p_internal_new (enum gcry_mpi_ec_models model,
314                                       enum ecc_dialects dialect,
315                                       int flags,
316                                       gcry_mpi_t p, gcry_mpi_t a, gcry_mpi_t b);
317 gpg_err_code_t _gcry_mpi_ec_p_new (gcry_ctx_t *r_ctx,
318                                    enum gcry_mpi_ec_models model,
319                                    enum ecc_dialects dialect,
320                                    int flags,
321                                    gcry_mpi_t p, gcry_mpi_t a, gcry_mpi_t b);
322 void _gcry_mpi_ec_free (mpi_ec_t ctx);
323
324 int _gcry_mpi_ec_get_affine (gcry_mpi_t x, gcry_mpi_t y, mpi_point_t point,
325                              mpi_ec_t ctx);
326 void _gcry_mpi_ec_dup_point (mpi_point_t result,
327                              mpi_point_t point, mpi_ec_t ctx);
328 void _gcry_mpi_ec_add_points (mpi_point_t result,
329                               mpi_point_t p1, mpi_point_t p2,
330                               mpi_ec_t ctx);
331 void _gcry_mpi_ec_mul_point (mpi_point_t result,
332                              gcry_mpi_t scalar, mpi_point_t point,
333                              mpi_ec_t ctx);
334 int  _gcry_mpi_ec_curve_point (gcry_mpi_point_t point, mpi_ec_t ctx);
335
336 gcry_mpi_t _gcry_mpi_ec_ec2os (gcry_mpi_point_t point, mpi_ec_t ectx);
337
338 gcry_mpi_t _gcry_mpi_ec_get_mpi (const char *name, gcry_ctx_t ctx, int copy);
339 gcry_mpi_point_t _gcry_mpi_ec_get_point (const char *name,
340                                          gcry_ctx_t ctx, int copy);
341 gpg_err_code_t _gcry_mpi_ec_set_mpi (const char *name, gcry_mpi_t newvalue,
342                                      gcry_ctx_t ctx);
343 gpg_err_code_t _gcry_mpi_ec_set_point (const char *name,
344                                        gcry_mpi_point_t newvalue,
345                                        gcry_ctx_t ctx);
346
347 /*-- ecc-curves.c --*/
348 gpg_err_code_t _gcry_mpi_ec_new (gcry_ctx_t *r_ctx,
349                                  gcry_sexp_t keyparam, const char *curvename);
350
351
352
353 #endif /*G10_MPI_H*/