ecc: Make a macro shorter.
[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
119 #define mpi_alloc_set_ui(a)   _gcry_mpi_alloc_set_ui ((a))
120 #define mpi_m_check(a)        _gcry_mpi_m_check ((a))
121 #define mpi_const(n)          _gcry_mpi_const ((n))
122
123 void _gcry_mpi_clear( gcry_mpi_t a );
124 gcry_mpi_t  _gcry_mpi_alloc_like( gcry_mpi_t a );
125 gcry_mpi_t  _gcry_mpi_alloc_set_ui( unsigned long u);
126 void _gcry_mpi_m_check( gcry_mpi_t a );
127 void _gcry_mpi_swap( gcry_mpi_t a, gcry_mpi_t b);
128 gcry_mpi_t _gcry_mpi_new (unsigned int nbits);
129 gcry_mpi_t _gcry_mpi_snew (unsigned int nbits);
130 gcry_mpi_t _gcry_mpi_set_opaque_copy (gcry_mpi_t a,
131                                       const void *p, unsigned int nbits);
132 void *_gcry_mpi_get_opaque_copy (gcry_mpi_t a, unsigned int *nbits);
133 int _gcry_mpi_is_neg (gcry_mpi_t a);
134 void _gcry_mpi_neg (gcry_mpi_t w, gcry_mpi_t u);
135 void _gcry_mpi_abs (gcry_mpi_t w);
136
137 /* Constants used to return constant MPIs.  See _gcry_mpi_init if you
138    want to add more constants. */
139 #define MPI_NUMBER_OF_CONSTANTS 6
140 enum gcry_mpi_constants
141   {
142     MPI_C_ZERO,
143     MPI_C_ONE,
144     MPI_C_TWO,
145     MPI_C_THREE,
146     MPI_C_FOUR,
147     MPI_C_EIGHT
148   };
149
150
151 gcry_mpi_t _gcry_mpi_const (enum gcry_mpi_constants no);
152
153
154 /*-- mpicoder.c --*/
155 void  _gcry_log_mpidump( const char *text, gcry_mpi_t a );
156 u32   _gcry_mpi_get_keyid( gcry_mpi_t a, u32 *keyid );
157 byte *_gcry_mpi_get_buffer (gcry_mpi_t a, unsigned int fill_le,
158                             unsigned int *r_nbytes, int *sign);
159 byte *_gcry_mpi_get_secure_buffer (gcry_mpi_t a, unsigned int fill_le,
160                                    unsigned *r_nbytes, int *sign);
161 void  _gcry_mpi_set_buffer ( gcry_mpi_t a, const void *buffer,
162                              unsigned int nbytes, int sign );
163 gpg_err_code_t _gcry_mpi_to_octet_string (unsigned char **r_frame,
164                                           void *space,
165                                           gcry_mpi_t value, size_t nbytes);
166
167 /*-- mpi-div.c --*/
168 #define mpi_fdiv_r_ui(a,b,c)   _gcry_mpi_fdiv_r_ui((a),(b),(c))
169 #define mpi_fdiv_r(a,b,c)      _gcry_mpi_fdiv_r((a),(b),(c))
170 #define mpi_fdiv_q(a,b,c)      _gcry_mpi_fdiv_q((a),(b),(c))
171 #define mpi_fdiv_qr(a,b,c,d)   _gcry_mpi_fdiv_qr((a),(b),(c),(d))
172 #define mpi_tdiv_r(a,b,c)      _gcry_mpi_tdiv_r((a),(b),(c))
173 #define mpi_tdiv_qr(a,b,c,d)   _gcry_mpi_tdiv_qr((a),(b),(c),(d))
174 #define mpi_tdiv_q_2exp(a,b,c) _gcry_mpi_tdiv_q_2exp((a),(b),(c))
175 #define mpi_divisible_ui(a,b)  _gcry_mpi_divisible_ui((a),(b))
176
177 ulong _gcry_mpi_fdiv_r_ui( gcry_mpi_t rem, gcry_mpi_t dividend, ulong divisor );
178 void  _gcry_mpi_fdiv_r( gcry_mpi_t rem, gcry_mpi_t dividend, gcry_mpi_t divisor );
179 void  _gcry_mpi_fdiv_q( gcry_mpi_t quot, gcry_mpi_t dividend, gcry_mpi_t divisor );
180 void  _gcry_mpi_fdiv_qr( gcry_mpi_t quot, gcry_mpi_t rem, gcry_mpi_t dividend, gcry_mpi_t divisor );
181 void  _gcry_mpi_tdiv_r( gcry_mpi_t rem, gcry_mpi_t num, gcry_mpi_t den);
182 void  _gcry_mpi_tdiv_qr( gcry_mpi_t quot, gcry_mpi_t rem, gcry_mpi_t num, gcry_mpi_t den);
183 void  _gcry_mpi_tdiv_q_2exp( gcry_mpi_t w, gcry_mpi_t u, unsigned count );
184 int   _gcry_mpi_divisible_ui(gcry_mpi_t dividend, ulong divisor );
185
186
187 /*-- mpi-mod.c --*/
188 #define mpi_barrett_init(m,f)     _gcry_mpi_barrett_init ((m),(f))
189 #define mpi_barrett_free(c)       _gcry_mpi_barrett_free ((c))
190 #define mpi_mod_barrett(r,a,c)    _gcry_mpi_mod_barrett ((r), (a), (c))
191 #define mpi_mul_barrett(r,u,v,c)  _gcry_mpi_mul_barrett ((r), (u), (v), (c))
192
193 /* Context used with Barrett reduction.  */
194 struct barrett_ctx_s;
195 typedef struct barrett_ctx_s *mpi_barrett_t;
196
197 mpi_barrett_t _gcry_mpi_barrett_init (gcry_mpi_t m, int copy);
198 void _gcry_mpi_barrett_free (mpi_barrett_t ctx);
199 void _gcry_mpi_mod_barrett (gcry_mpi_t r, gcry_mpi_t x, mpi_barrett_t ctx);
200 void _gcry_mpi_mul_barrett (gcry_mpi_t w, gcry_mpi_t u, gcry_mpi_t v,
201                             mpi_barrett_t ctx);
202
203
204 /*-- mpi-mpow.c --*/
205 #define mpi_mulpowm(a,b,c,d) _gcry_mpi_mulpowm ((a),(b),(c),(d))
206 void _gcry_mpi_mulpowm( gcry_mpi_t res, gcry_mpi_t *basearray, gcry_mpi_t *exparray, gcry_mpi_t mod);
207
208 /*-- mpi-scan.c --*/
209 #define mpi_trailing_zeros(a) _gcry_mpi_trailing_zeros ((a))
210 int      _gcry_mpi_getbyte( gcry_mpi_t a, unsigned idx );
211 void     _gcry_mpi_putbyte( gcry_mpi_t a, unsigned idx, int value );
212 unsigned _gcry_mpi_trailing_zeros( gcry_mpi_t a );
213
214 /*-- mpi-bit.c --*/
215 #define mpi_normalize(a)       _gcry_mpi_normalize ((a))
216
217 void _gcry_mpi_normalize( gcry_mpi_t a );
218
219 /*-- ec.c --*/
220
221 /* Object to represent a point in projective coordinates. */
222 struct gcry_mpi_point
223 {
224   gcry_mpi_t x;
225   gcry_mpi_t y;
226   gcry_mpi_t z;
227 };
228 typedef struct gcry_mpi_point mpi_point_struct;
229 typedef struct gcry_mpi_point *mpi_point_t;
230
231 void _gcry_mpi_point_init (mpi_point_t p);
232 void _gcry_mpi_point_free_parts (mpi_point_t p);
233 void _gcry_mpi_get_point (gcry_mpi_t x, gcry_mpi_t y, gcry_mpi_t z,
234                           mpi_point_t point);
235 void _gcry_mpi_snatch_point (gcry_mpi_t x, gcry_mpi_t y, gcry_mpi_t z,
236                              mpi_point_t point);
237
238
239 /* Models describing an elliptic curve.  */
240 enum gcry_mpi_ec_models
241   {
242     /* The Short Weierstrass equation is
243           y^2 = x^3 + ax + b
244      */
245     MPI_EC_WEIERSTRASS = 0,
246     /* The Montgomery equation is
247           by^2 = x^3 + ax^2 + x
248      */
249     MPI_EC_MONTGOMERY,
250     /* The Twisted Edwards equation is
251           ax^2 + y^2 = 1 + bx^2y^2
252        Note that we use 'b' instead of the commonly used 'd'.  */
253     MPI_EC_EDWARDS
254   };
255
256 /* Dialects used with elliptic curves.  It is easier to keep the
257    definition here than in ecc-common.h. */
258 enum ecc_dialects
259   {
260     ECC_DIALECT_STANDARD = 0,
261     ECC_DIALECT_ED25519
262   };
263
264
265 void _gcry_mpi_point_log (const char *name, mpi_point_t point, mpi_ec_t ctx);
266 #define log_printpnt(a,p,c) _gcry_mpi_point_log ((a), (p), (c))
267
268 mpi_ec_t _gcry_mpi_ec_p_internal_new (enum gcry_mpi_ec_models model,
269                                       enum ecc_dialects dialect,
270                                       int flags,
271                                       gcry_mpi_t p, gcry_mpi_t a, gcry_mpi_t b);
272 gpg_err_code_t _gcry_mpi_ec_p_new (gcry_ctx_t *r_ctx,
273                                    enum gcry_mpi_ec_models model,
274                                    enum ecc_dialects dialect,
275                                    int flags,
276                                    gcry_mpi_t p, gcry_mpi_t a, gcry_mpi_t b);
277 void _gcry_mpi_ec_free (mpi_ec_t ctx);
278
279 void _gcry_mpi_ec_dup_point (mpi_point_t result,
280                              mpi_point_t point, mpi_ec_t ctx);
281 void _gcry_mpi_ec_add_points (mpi_point_t result,
282                               mpi_point_t p1, mpi_point_t p2,
283                               mpi_ec_t ctx);
284 void _gcry_mpi_ec_mul_point (mpi_point_t result,
285                              gcry_mpi_t scalar, mpi_point_t point,
286                              mpi_ec_t ctx);
287 int  _gcry_mpi_ec_curve_point (gcry_mpi_point_t point, mpi_ec_t ctx);
288
289 gcry_mpi_t _gcry_mpi_ec_ec2os (gcry_mpi_point_t point, mpi_ec_t ectx);
290
291 gcry_mpi_t _gcry_mpi_ec_get_mpi (const char *name, gcry_ctx_t ctx, int copy);
292 gcry_mpi_point_t _gcry_mpi_ec_get_point (const char *name,
293                                          gcry_ctx_t ctx, int copy);
294 gpg_err_code_t _gcry_mpi_ec_set_mpi (const char *name, gcry_mpi_t newvalue,
295                                      gcry_ctx_t ctx);
296 gpg_err_code_t _gcry_mpi_ec_set_point (const char *name,
297                                        gcry_mpi_point_t newvalue,
298                                        gcry_ctx_t ctx);
299
300 /*-- ecc-curves.c --*/
301 gpg_err_code_t _gcry_mpi_ec_new (gcry_ctx_t *r_ctx,
302                                  gcry_sexp_t keyparam, const char *curvename);
303
304
305
306 #endif /*G10_MPI_H*/