Add GCRYMPI_FLAG_IMMUTABLE to help debugging.
[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: Const MPI - the MPI may not be modified.  */
74   mpi_limb_t *d;      /* Array with the limbs */
75 };
76
77 #define MPI_NULL NULL
78
79 #define mpi_get_nlimbs(a)     ((a)->nlimbs)
80 #define mpi_is_neg(a)         ((a)->sign)
81
82 /*-- mpiutil.c --*/
83
84 #ifdef M_DEBUG
85 # define mpi_alloc(n)   _gcry_mpi_debug_alloc((n), M_DBGINFO( __LINE__ ) )
86 # define mpi_alloc_secure(n)  _gcry_mpi_debug_alloc_secure((n), M_DBGINFO( __LINE__ ) )
87 # define mpi_free(a)    _gcry_mpi_debug_free((a), M_DBGINFO(__LINE__) )
88 # define mpi_resize(a,b) _gcry_mpi_debug_resize((a),(b), M_DBGINFO(__LINE__) )
89 # define mpi_copy(a)      _gcry_mpi_debug_copy((a), M_DBGINFO(__LINE__) )
90   gcry_mpi_t _gcry_mpi_debug_alloc( unsigned nlimbs, const char *info );
91   gcry_mpi_t _gcry_mpi_debug_alloc_secure( unsigned nlimbs, const char *info );
92   void _gcry_mpi_debug_free( gcry_mpi_t a, const char *info );
93   void _gcry_mpi_debug_resize( gcry_mpi_t a, unsigned nlimbs, const char *info );
94   gcry_mpi_t  _gcry_mpi_debug_copy( gcry_mpi_t a, const char *info      );
95 #else
96 # define mpi_alloc(n)          _gcry_mpi_alloc((n) )
97 # define mpi_alloc_secure(n)  _gcry_mpi_alloc_secure((n) )
98 # define mpi_free(a)           _gcry_mpi_free((a) )
99 # define mpi_resize(a,b)      _gcry_mpi_resize((a),(b))
100 # define mpi_copy(a)           _gcry_mpi_copy((a))
101   gcry_mpi_t  _gcry_mpi_alloc( unsigned nlimbs );
102   gcry_mpi_t  _gcry_mpi_alloc_secure( unsigned nlimbs );
103   void _gcry_mpi_free( gcry_mpi_t a );
104   void _gcry_mpi_resize( gcry_mpi_t a, unsigned nlimbs );
105   gcry_mpi_t  _gcry_mpi_copy( gcry_mpi_t a );
106 #endif
107
108 void _gcry_mpi_immutable_failed (void);
109 #define mpi_immutable_failed() _gcry_mpi_immutable_failed ()
110
111 #define mpi_is_immutable(a)   ((a) && ((a)->flags&16))
112 #define mpi_is_opaque(a)      ((a) && ((a)->flags&4))
113 #define mpi_is_secure(a)      ((a) && ((a)->flags&1))
114 #define mpi_clear(a)          _gcry_mpi_clear ((a))
115 #define mpi_alloc_like(a)     _gcry_mpi_alloc_like((a))
116 #define mpi_snatch(a,b)       _gcry_mpi_snatch ((a),(b))
117 #define mpi_set(a,b)          _gcry_mpi_set ((a),(b))
118 #define mpi_set_ui(a,b)       _gcry_mpi_set_ui ((a),(b))
119 #define mpi_get_ui(a,b)       _gcry_mpi_get_ui ((a),(b))
120 #define mpi_alloc_set_ui(a)   _gcry_mpi_alloc_set_ui ((a))
121 #define mpi_m_check(a)        _gcry_mpi_m_check ((a))
122 #define mpi_swap(a,b)         _gcry_mpi_swap ((a),(b))
123 #define mpi_new(n)            _gcry_mpi_new ((n))
124 #define mpi_snew(n)           _gcry_mpi_snew ((n))
125
126 void _gcry_mpi_clear( gcry_mpi_t a );
127 gcry_mpi_t  _gcry_mpi_alloc_like( gcry_mpi_t a );
128 gcry_mpi_t  _gcry_mpi_alloc_set_ui( unsigned long u);
129 gcry_err_code_t _gcry_mpi_get_ui (gcry_mpi_t w, ulong *u);
130 void _gcry_mpi_m_check( gcry_mpi_t a );
131 void _gcry_mpi_swap( gcry_mpi_t a, gcry_mpi_t b);
132 gcry_mpi_t _gcry_mpi_new (unsigned int nbits);
133 gcry_mpi_t _gcry_mpi_snew (unsigned int nbits);
134
135 /*-- mpicoder.c --*/
136 void  _gcry_log_mpidump( const char *text, gcry_mpi_t a );
137 u32   _gcry_mpi_get_keyid( gcry_mpi_t a, u32 *keyid );
138 byte *_gcry_mpi_get_buffer( gcry_mpi_t a, unsigned *nbytes, int *sign );
139 byte *_gcry_mpi_get_secure_buffer( gcry_mpi_t a, unsigned *nbytes, int *sign );
140 void  _gcry_mpi_set_buffer ( gcry_mpi_t a, const void *buffer,
141                              unsigned int nbytes, int sign );
142
143 #define log_mpidump _gcry_log_mpidump
144
145 /*-- mpi-add.c --*/
146 #define mpi_add_ui(w,u,v) gcry_mpi_add_ui((w),(u),(v))
147 #define mpi_add(w,u,v)    gcry_mpi_add ((w),(u),(v))
148 #define mpi_addm(w,u,v,m) gcry_mpi_addm ((w),(u),(v),(m))
149 #define mpi_sub_ui(w,u,v) gcry_mpi_sub_ui ((w),(u),(v))
150 #define mpi_sub(w,u,v)    gcry_mpi_sub ((w),(u),(v))
151 #define mpi_subm(w,u,v,m) gcry_mpi_subm ((w),(u),(v),(m))
152
153
154 /*-- mpi-mul.c --*/
155 #define mpi_mul_ui(w,u,v)   gcry_mpi_mul_ui ((w),(u),(v))
156 #define mpi_mul_2exp(w,u,v) gcry_mpi_mul_2exp ((w),(u),(v))
157 #define mpi_mul(w,u,v)      gcry_mpi_mul ((w),(u),(v))
158 #define mpi_mulm(w,u,v,m)   gcry_mpi_mulm ((w),(u),(v),(m))
159
160
161 /*-- mpi-div.c --*/
162 #define mpi_fdiv_r_ui(a,b,c)   _gcry_mpi_fdiv_r_ui((a),(b),(c))
163 #define mpi_fdiv_r(a,b,c)      _gcry_mpi_fdiv_r((a),(b),(c))
164 #define mpi_fdiv_q(a,b,c)      _gcry_mpi_fdiv_q((a),(b),(c))
165 #define mpi_fdiv_qr(a,b,c,d)   _gcry_mpi_fdiv_qr((a),(b),(c),(d))
166 #define mpi_tdiv_r(a,b,c)      _gcry_mpi_tdiv_r((a),(b),(c))
167 #define mpi_tdiv_qr(a,b,c,d)   _gcry_mpi_tdiv_qr((a),(b),(c),(d))
168 #define mpi_tdiv_q_2exp(a,b,c) _gcry_mpi_tdiv_q_2exp((a),(b),(c))
169 #define mpi_divisible_ui(a,b)  _gcry_mpi_divisible_ui((a),(b))
170
171 ulong _gcry_mpi_fdiv_r_ui( gcry_mpi_t rem, gcry_mpi_t dividend, ulong divisor );
172 void  _gcry_mpi_fdiv_r( gcry_mpi_t rem, gcry_mpi_t dividend, gcry_mpi_t divisor );
173 void  _gcry_mpi_fdiv_q( gcry_mpi_t quot, gcry_mpi_t dividend, gcry_mpi_t divisor );
174 void  _gcry_mpi_fdiv_qr( gcry_mpi_t quot, gcry_mpi_t rem, gcry_mpi_t dividend, gcry_mpi_t divisor );
175 void  _gcry_mpi_tdiv_r( gcry_mpi_t rem, gcry_mpi_t num, gcry_mpi_t den);
176 void  _gcry_mpi_tdiv_qr( gcry_mpi_t quot, gcry_mpi_t rem, gcry_mpi_t num, gcry_mpi_t den);
177 void  _gcry_mpi_tdiv_q_2exp( gcry_mpi_t w, gcry_mpi_t u, unsigned count );
178 int   _gcry_mpi_divisible_ui(gcry_mpi_t dividend, ulong divisor );
179
180
181 /*-- mpi-mod.c --*/
182 #define mpi_mod(r,a,m)            _gcry_mpi_mod ((r), (a), (m))
183 #define mpi_barrett_init(m,f)     _gcry_mpi_barrett_init ((m),(f))
184 #define mpi_barrett_free(c)       _gcry_mpi_barrett_free ((c))
185 #define mpi_mod_barrett(r,a,c)    _gcry_mpi_mod_barrett ((r), (a), (c))
186 #define mpi_mul_barrett(r,u,v,c)  _gcry_mpi_mul_barrett ((r), (u), (v), (c))
187
188 void _gcry_mpi_mod (gcry_mpi_t r, gcry_mpi_t dividend, gcry_mpi_t divisor);
189
190 /* Context used with Barrett reduction.  */
191 struct barrett_ctx_s;
192 typedef struct barrett_ctx_s *mpi_barrett_t;
193
194 mpi_barrett_t _gcry_mpi_barrett_init (gcry_mpi_t m, int copy);
195 void _gcry_mpi_barrett_free (mpi_barrett_t ctx);
196 void _gcry_mpi_mod_barrett (gcry_mpi_t r, gcry_mpi_t x, mpi_barrett_t ctx);
197 void _gcry_mpi_mul_barrett (gcry_mpi_t w, gcry_mpi_t u, gcry_mpi_t v,
198                             mpi_barrett_t ctx);
199
200
201
202 /*-- mpi-gcd.c --*/
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-cmp.c --*/
209 #define mpi_cmp_ui(a,b) gcry_mpi_cmp_ui ((a),(b))
210 #define mpi_cmp(a,b)    gcry_mpi_cmp ((a),(b))
211 int gcry_mpi_cmp_ui( gcry_mpi_t u, ulong v );
212 int gcry_mpi_cmp( gcry_mpi_t u, gcry_mpi_t v );
213
214 /*-- mpi-scan.c --*/
215 #define mpi_trailing_zeros(a) _gcry_mpi_trailing_zeros ((a))
216 int      _gcry_mpi_getbyte( gcry_mpi_t a, unsigned idx );
217 void     _gcry_mpi_putbyte( gcry_mpi_t a, unsigned idx, int value );
218 unsigned _gcry_mpi_trailing_zeros( gcry_mpi_t a );
219
220 /*-- mpi-bit.c --*/
221 #define mpi_normalize(a)       _gcry_mpi_normalize ((a))
222 #define mpi_get_nbits(a)       gcry_mpi_get_nbits ((a))
223 #define mpi_test_bit(a,b)      gcry_mpi_test_bit ((a),(b))
224 #define mpi_set_bit(a,b)       gcry_mpi_set_bit ((a),(b))
225 #define mpi_set_highbit(a,b)   gcry_mpi_set_highbit ((a),(b))
226 #define mpi_clear_bit(a,b)     gcry_mpi_clear_bit ((a),(b))
227 #define mpi_clear_highbit(a,b) gcry_mpi_clear_highbit ((a),(b))
228 #define mpi_rshift(a,b,c)      gcry_mpi_rshift ((a),(b),(c))
229 #define mpi_lshift(a,b,c)      gcry_mpi_lshift ((a),(b),(c))
230
231 void _gcry_mpi_normalize( gcry_mpi_t a );
232
233 /*-- mpi-inv.c --*/
234 #define mpi_invm(a,b,c) _gcry_mpi_invm ((a),(b),(c))
235
236 /*-- ec.c --*/
237
238 /* Object to represent a point in projective coordinates. */
239 struct gcry_mpi_point
240 {
241   gcry_mpi_t x;
242   gcry_mpi_t y;
243   gcry_mpi_t z;
244 };
245 typedef struct gcry_mpi_point mpi_point_struct;
246 typedef struct gcry_mpi_point *mpi_point_t;
247
248 void _gcry_mpi_point_init (mpi_point_t p);
249 void _gcry_mpi_point_free_parts (mpi_point_t p);
250 void _gcry_mpi_get_point (gcry_mpi_t x, gcry_mpi_t y, gcry_mpi_t z,
251                           mpi_point_t point);
252 void _gcry_mpi_snatch_point (gcry_mpi_t x, gcry_mpi_t y, gcry_mpi_t z,
253                              mpi_point_t point);
254
255 /* Context used with elliptic curve functions.  */
256 struct mpi_ec_ctx_s;
257 typedef struct mpi_ec_ctx_s *mpi_ec_t;
258
259 mpi_ec_t _gcry_mpi_ec_p_internal_new (gcry_mpi_t p, gcry_mpi_t a);
260 void _gcry_mpi_ec_free (mpi_ec_t ctx);
261 int _gcry_mpi_ec_get_affine (gcry_mpi_t x, gcry_mpi_t y, mpi_point_t point,
262                              mpi_ec_t ctx);
263 void _gcry_mpi_ec_dup_point (mpi_point_t result,
264                              mpi_point_t point, mpi_ec_t ctx);
265 void _gcry_mpi_ec_add_points (mpi_point_t result,
266                               mpi_point_t p1, mpi_point_t p2,
267                               mpi_ec_t ctx);
268 void _gcry_mpi_ec_mul_point (mpi_point_t result,
269                              gcry_mpi_t scalar, mpi_point_t point,
270                              mpi_ec_t ctx);
271
272
273
274 #endif /*G10_MPI_H*/