Update head to match stable 1.0
[gnupg.git] / include / mpi.h
1 /* mpi.h  -  Multi Precision Integers
2  *      Copyright (C) 1994, 1996, 1998, 1999,
3  *                    2000, 2001 Free Software Foundation, Inc.
4  *
5  * This file is part of GNUPG.
6  *
7  * GNUPG is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * GNUPG 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 General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * 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  *       The GNU MP Library itself is published under the LGPL;
27  *       however I decided to publish this code under the plain GPL.
28  */
29
30 #ifndef G10_MPI_H
31 #define G10_MPI_H
32
33 #include <config.h>
34 #include <stdio.h>
35 #include "iobuf.h"
36 #include "types.h"
37 #include "memory.h"
38
39 #if BYTES_PER_MPI_LIMB == SIZEOF_UNSIGNED_INT
40   typedef unsigned int mpi_limb_t;
41   typedef   signed int mpi_limb_signed_t;
42 #elif BYTES_PER_MPI_LIMB == SIZEOF_UNSIGNED_LONG
43   typedef unsigned long int mpi_limb_t;
44   typedef   signed long int mpi_limb_signed_t;
45 #elif BYTES_PER_MPI_LIMB == SIZEOF_UNSIGNED_LONG_LONG
46   typedef unsigned long long int mpi_limb_t;
47   typedef   signed long long int mpi_limb_signed_t;
48 #elif BYTES_PER_MPI_LIMB == SIZEOF_UNSIGNED_SHORT
49   typedef unsigned short int mpi_limb_t;
50   typedef   signed short int mpi_limb_signed_t;
51 #else
52   #error BYTES_PER_MPI_LIMB does not match any C type
53 #endif
54 #define BITS_PER_MPI_LIMB    (8*BYTES_PER_MPI_LIMB)
55
56 #ifndef EXTERN_UNLESS_MAIN_MODULE
57  #if defined (__riscos__) && !defined (INCLUDED_BY_MAIN_MODULE)
58   #define EXTERN_UNLESS_MAIN_MODULE extern
59  #else
60   #define EXTERN_UNLESS_MAIN_MODULE 
61  #endif
62 #endif
63
64 #define DBG_MPI     mpi_debug_mode
65 EXTERN_UNLESS_MAIN_MODULE int mpi_debug_mode;
66
67
68 struct gcry_mpi {
69     int alloced;    /* array size (# of allocated limbs) */
70     int nlimbs;     /* number of valid limbs */
71     int nbits;      /* the real number of valid bits (info only) */
72     int sign;       /* indicates a negative number */
73     unsigned flags; /* bit 0: array must be allocated in secure memory space */
74                     /* bit 1: the mpi is encrypted */
75                     /* bit 2: the limb is a pointer to some m_alloced data */
76     mpi_limb_t *d;  /* array with the limbs */
77 };
78
79 typedef struct gcry_mpi *MPI;
80
81 #define MPI_NULL NULL
82
83 #define mpi_get_nlimbs(a)     ((a)->nlimbs)
84 #define mpi_get_nbit_info(a)  ((a)->nbits)
85 #define mpi_set_nbit_info(a,b) ((a)->nbits = (b))
86 #define mpi_is_neg(a)         ((a)->sign)
87
88 /*-- mpiutil.c --*/
89
90 #ifdef M_DEBUG
91   #define mpi_alloc(n)        mpi_debug_alloc((n), M_DBGINFO( __LINE__ ) )
92   #define mpi_alloc_secure(n) mpi_debug_alloc_secure((n), M_DBGINFO( __LINE__ ) )
93   #define mpi_alloc_like(n)   mpi_debug_alloc_like((n), M_DBGINFO( __LINE__ ) )
94   #define mpi_free(a)         mpi_debug_free((a), M_DBGINFO(__LINE__) )
95   #define mpi_resize(a,b)     mpi_debug_resize((a),(b), M_DBGINFO(__LINE__) )
96   #define mpi_copy(a)         mpi_debug_copy((a), M_DBGINFO(__LINE__) )
97   MPI mpi_debug_alloc( unsigned nlimbs, const char *info );
98   MPI mpi_debug_alloc_secure( unsigned nlimbs, const char *info );
99   MPI mpi_debug_alloc_like( MPI a, const char *info );
100   void mpi_debug_free( MPI a, const char *info );
101   void mpi_debug_resize( MPI a, unsigned nlimbs, const char *info );
102   MPI  mpi_debug_copy( MPI a, const char *info  );
103 #else
104   MPI mpi_alloc( unsigned nlimbs );
105   MPI mpi_alloc_secure( unsigned nlimbs );
106   MPI mpi_alloc_like( MPI a );
107   void mpi_free( MPI a );
108   void mpi_resize( MPI a, unsigned nlimbs );
109   MPI  mpi_copy( MPI a );
110 #endif
111 #define mpi_is_opaque(a) ((a) && ((a)->flags&4))
112 MPI mpi_set_opaque( MPI a, void *p, int len );
113 void *mpi_get_opaque( MPI a, int *len );
114 #define mpi_is_protected(a) ((a) && ((a)->flags&2))
115 #define mpi_set_protect_flag(a) ((a)->flags |= 2)
116 #define mpi_clear_protect_flag(a) ((a)->flags &= ~2)
117 #define mpi_is_secure(a) ((a) && ((a)->flags&1))
118 void mpi_set_secure( MPI a );
119 void mpi_clear( MPI a );
120 void mpi_set( MPI w, MPI u);
121 void mpi_set_ui( MPI w, ulong u);
122 MPI  mpi_alloc_set_ui( unsigned long u);
123 void mpi_m_check( MPI a );
124 void mpi_swap( MPI a, MPI b);
125
126 /*-- mpicoder.c --*/
127 int mpi_write( IOBUF out, MPI a );
128 #ifdef M_DEBUG
129   #define mpi_read(a,b,c)   mpi_debug_read((a),(b),(c),  M_DBGINFO( __LINE__ ) )
130   MPI mpi_debug_read(IOBUF inp, unsigned *nread, int secure, const char *info);
131 #else
132   MPI mpi_read(IOBUF inp, unsigned *nread, int secure);
133 #endif
134 MPI mpi_read_from_buffer(byte *buffer, unsigned *ret_nread, int secure);
135 int mpi_fromstr(MPI val, const char *str);
136 int mpi_print( FILE *fp, MPI a, int mode );
137 void g10_log_mpidump( const char *text, MPI a );
138 u32 mpi_get_keyid( MPI a, u32 *keyid );
139 byte *mpi_get_buffer( MPI a, unsigned *nbytes, int *sign );
140 byte *mpi_get_secure_buffer( MPI a, unsigned *nbytes, int *sign );
141 void  mpi_set_buffer( MPI a, const byte *buffer, unsigned nbytes, int sign );
142
143 #define log_mpidump g10_log_mpidump
144
145 /*-- mpi-add.c --*/
146 void mpi_add_ui(MPI w, MPI u, ulong v );
147 void mpi_add(MPI w, MPI u, MPI v);
148 void mpi_addm(MPI w, MPI u, MPI v, MPI m);
149 void mpi_sub_ui(MPI w, MPI u, ulong v );
150 void mpi_sub( MPI w, MPI u, MPI v);
151 void mpi_subm( MPI w, MPI u, MPI v, MPI m);
152
153 /*-- mpi-mul.c --*/
154 void mpi_mul_ui(MPI w, MPI u, ulong v );
155 void mpi_mul_2exp( MPI w, MPI u, ulong cnt);
156 void mpi_mul( MPI w, MPI u, MPI v);
157 void mpi_mulm( MPI w, MPI u, MPI v, MPI m);
158
159 /*-- mpi-div.c --*/
160 ulong mpi_fdiv_r_ui( MPI rem, MPI dividend, ulong divisor );
161 void  mpi_fdiv_r( MPI rem, MPI dividend, MPI divisor );
162 void  mpi_fdiv_q( MPI quot, MPI dividend, MPI divisor );
163 void  mpi_fdiv_qr( MPI quot, MPI rem, MPI dividend, MPI divisor );
164 void  mpi_tdiv_r( MPI rem, MPI num, MPI den);
165 void  mpi_tdiv_qr( MPI quot, MPI rem, MPI num, MPI den);
166 void  mpi_tdiv_q_2exp( MPI w, MPI u, unsigned count );
167 int   mpi_divisible_ui(MPI dividend, ulong divisor );
168
169 /*-- mpi-gcd.c --*/
170 int mpi_gcd( MPI g, MPI a, MPI b );
171
172 /*-- mpi-pow.c --*/
173 void mpi_pow( MPI w, MPI u, MPI v);
174 void mpi_powm( MPI res, MPI base, MPI exp, MPI mod);
175
176 /*-- mpi-mpow.c --*/
177 void mpi_mulpowm( MPI res, MPI *basearray, MPI *exparray, MPI mod);
178
179 /*-- mpi-cmp.c --*/
180 int mpi_cmp_ui( MPI u, ulong v );
181 int mpi_cmp( MPI u, MPI v );
182
183 /*-- mpi-scan.c --*/
184 int mpi_getbyte( MPI a, unsigned idx );
185 void mpi_putbyte( MPI a, unsigned idx, int value );
186 unsigned mpi_trailing_zeros( MPI a );
187
188 /*-- mpi-bit.c --*/
189 void mpi_normalize( MPI a );
190 unsigned mpi_get_nbits( MPI a );
191 int  mpi_test_bit( MPI a, unsigned n );
192 void mpi_set_bit( MPI a, unsigned n );
193 void mpi_set_highbit( MPI a, unsigned n );
194 void mpi_clear_highbit( MPI a, unsigned n );
195 void mpi_clear_bit( MPI a, unsigned n );
196 void mpi_rshift( MPI x, MPI a, unsigned n );
197
198 /*-- mpi-inv.c --*/
199 void mpi_invm( MPI x, MPI u, MPI v );
200
201
202 #endif /*G10_MPI_H*/