* cipher.h, i18n.h, iobuf.h, memory.h, mpi.h, types.h, util.h: Edit all
[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: not used */
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_is_neg(a)         ((a)->sign)
85
86 /*-- mpiutil.c --*/
87
88 #ifdef M_DEBUG
89 #define mpi_alloc(n)          mpi_debug_alloc((n), M_DBGINFO( __LINE__ ) )
90 #define mpi_alloc_secure(n) mpi_debug_alloc_secure((n), M_DBGINFO( __LINE__ ) )
91 #define mpi_alloc_like(n)   mpi_debug_alloc_like((n), M_DBGINFO( __LINE__ ) )
92 #define mpi_free(a)           mpi_debug_free((a), M_DBGINFO(__LINE__) )
93 #define mpi_resize(a,b)     mpi_debug_resize((a),(b), M_DBGINFO(__LINE__) )
94 #define mpi_copy(a)           mpi_debug_copy((a), M_DBGINFO(__LINE__) )
95 MPI mpi_debug_alloc( unsigned nlimbs, const char *info );
96 MPI mpi_debug_alloc_secure( unsigned nlimbs, const char *info );
97 MPI mpi_debug_alloc_like( MPI a, const char *info );
98 void mpi_debug_free( MPI a, const char *info );
99 void mpi_debug_resize( MPI a, unsigned nlimbs, const char *info );
100 MPI  mpi_debug_copy( MPI a, const char *info    );
101 #else
102 MPI mpi_alloc( unsigned nlimbs );
103 MPI mpi_alloc_secure( unsigned nlimbs );
104 MPI mpi_alloc_like( MPI a );
105 void mpi_free( MPI a );
106 void mpi_resize( MPI a, unsigned nlimbs );
107 MPI  mpi_copy( MPI a );
108 #endif
109 #define mpi_is_opaque(a) ((a) && ((a)->flags&4))
110 MPI mpi_set_opaque( MPI a, void *p, int len );
111 void *mpi_get_opaque( MPI a, int *len );
112 #define mpi_is_secure(a) ((a) && ((a)->flags&1))
113 void mpi_set_secure( MPI a );
114 void mpi_clear( MPI a );
115 void mpi_set( MPI w, MPI u);
116 void mpi_set_ui( MPI w, ulong u);
117 MPI  mpi_alloc_set_ui( unsigned long u);
118 void mpi_m_check( MPI a );
119 void mpi_swap( MPI a, MPI b);
120
121 /*-- mpicoder.c --*/
122 int mpi_write( IOBUF out, MPI a );
123 #ifdef M_DEBUG
124 #define mpi_read(a,b,c)   mpi_debug_read((a),(b),(c),  M_DBGINFO( __LINE__ ) )
125 MPI mpi_debug_read(IOBUF inp, unsigned *nread, int secure, const char *info);
126 #else
127 MPI mpi_read(IOBUF inp, unsigned *nread, int secure);
128 #endif
129 MPI mpi_read_from_buffer(byte *buffer, unsigned *ret_nread, int secure);
130 int mpi_fromstr(MPI val, const char *str);
131 int mpi_print( FILE *fp, MPI a, int mode );
132 void g10_log_mpidump( const char *text, MPI a );
133 u32 mpi_get_keyid( MPI a, u32 *keyid );
134 byte *mpi_get_buffer( MPI a, unsigned *nbytes, int *sign );
135 byte *mpi_get_secure_buffer( MPI a, unsigned *nbytes, int *sign );
136 void  mpi_set_buffer( MPI a, const byte *buffer, unsigned nbytes, int sign );
137
138 #define log_mpidump g10_log_mpidump
139
140 /*-- mpi-add.c --*/
141 void mpi_add_ui(MPI w, MPI u, ulong v );
142 void mpi_add(MPI w, MPI u, MPI v);
143 void mpi_addm(MPI w, MPI u, MPI v, MPI m);
144 void mpi_sub_ui(MPI w, MPI u, ulong v );
145 void mpi_sub( MPI w, MPI u, MPI v);
146 void mpi_subm( MPI w, MPI u, MPI v, MPI m);
147
148 /*-- mpi-mul.c --*/
149 void mpi_mul_ui(MPI w, MPI u, ulong v );
150 void mpi_mul_2exp( MPI w, MPI u, ulong cnt);
151 void mpi_mul( MPI w, MPI u, MPI v);
152 void mpi_mulm( MPI w, MPI u, MPI v, MPI m);
153
154 /*-- mpi-div.c --*/
155 ulong mpi_fdiv_r_ui( MPI rem, MPI dividend, ulong divisor );
156 void  mpi_fdiv_r( MPI rem, MPI dividend, MPI divisor );
157 void  mpi_fdiv_q( MPI quot, MPI dividend, MPI divisor );
158 void  mpi_fdiv_qr( MPI quot, MPI rem, MPI dividend, MPI divisor );
159 void  mpi_tdiv_r( MPI rem, MPI num, MPI den);
160 void  mpi_tdiv_qr( MPI quot, MPI rem, MPI num, MPI den);
161 void  mpi_tdiv_q_2exp( MPI w, MPI u, unsigned count );
162 int   mpi_divisible_ui(MPI dividend, ulong divisor );
163
164 /*-- mpi-gcd.c --*/
165 int mpi_gcd( MPI g, MPI a, MPI b );
166
167 /*-- mpi-pow.c --*/
168 void mpi_pow( MPI w, MPI u, MPI v);
169 void mpi_powm( MPI res, MPI base, MPI exp, MPI mod);
170
171 /*-- mpi-mpow.c --*/
172 void mpi_mulpowm( MPI res, MPI *basearray, MPI *exparray, MPI mod);
173
174 /*-- mpi-cmp.c --*/
175 int mpi_cmp_ui( MPI u, ulong v );
176 int mpi_cmp( MPI u, MPI v );
177
178 /*-- mpi-scan.c --*/
179 int mpi_getbyte( MPI a, unsigned idx );
180 void mpi_putbyte( MPI a, unsigned idx, int value );
181 unsigned mpi_trailing_zeros( MPI a );
182
183 /*-- mpi-bit.c --*/
184 void mpi_normalize( MPI a );
185 unsigned mpi_get_nbits( MPI a );
186 int  mpi_test_bit( MPI a, unsigned n );
187 void mpi_set_bit( MPI a, unsigned n );
188 void mpi_set_highbit( MPI a, unsigned n );
189 void mpi_clear_highbit( MPI a, unsigned n );
190 void mpi_clear_bit( MPI a, unsigned n );
191 void mpi_rshift( MPI x, MPI a, unsigned n );
192
193 /*-- mpi-inv.c --*/
194 void mpi_invm( MPI x, MPI u, MPI v );
195
196 #endif /*G10_MPI_H*/