Implemented PKA trust model
[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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
20  * USA.
21  *
22  * Note: This code is heavily based on the GNU MP Library.
23  *       Actually it's the same code with only minor changes in the
24  *       way the data is stored; this is to support the abstraction
25  *       of an optional secure memory allocation which may be used
26  *       to avoid revealing of sensitive data due to paging etc.
27  *       The GNU MP Library itself is published under the LGPL;
28  *       however I decided to publish this code under the plain GPL.
29  */
30
31 #ifndef G10_MPI_H
32 #define G10_MPI_H
33
34 #include <config.h>
35 #include <stdio.h>
36 #include "iobuf.h"
37 #include "types.h"
38 #include "memory.h"
39
40 #if BYTES_PER_MPI_LIMB == SIZEOF_UNSIGNED_INT
41   typedef unsigned int mpi_limb_t;
42   typedef   signed int mpi_limb_signed_t;
43 #elif BYTES_PER_MPI_LIMB == SIZEOF_UNSIGNED_LONG
44   typedef unsigned long int mpi_limb_t;
45   typedef   signed long int mpi_limb_signed_t;
46 #elif BYTES_PER_MPI_LIMB == SIZEOF_UNSIGNED_LONG_LONG
47   typedef unsigned long long int mpi_limb_t;
48   typedef   signed long long int mpi_limb_signed_t;
49 #elif BYTES_PER_MPI_LIMB == SIZEOF_UNSIGNED_SHORT
50   typedef unsigned short int mpi_limb_t;
51   typedef   signed short int mpi_limb_signed_t;
52 #else
53 #error BYTES_PER_MPI_LIMB does not match any C type
54 #endif
55 #define BITS_PER_MPI_LIMB    (8*BYTES_PER_MPI_LIMB)
56
57 #ifndef EXTERN_UNLESS_MAIN_MODULE
58 #if defined (__riscos__) && !defined (INCLUDED_BY_MAIN_MODULE)
59 #define EXTERN_UNLESS_MAIN_MODULE extern
60 #else
61 #define EXTERN_UNLESS_MAIN_MODULE 
62 #endif
63 #endif
64
65 #define DBG_MPI     mpi_debug_mode
66 EXTERN_UNLESS_MAIN_MODULE int mpi_debug_mode;
67
68
69 struct gcry_mpi {
70     int alloced;    /* array size (# of allocated limbs) */
71     int nlimbs;     /* number of valid limbs */
72     unsigned int nbits; /* the real number of valid bits (info only) */
73     int sign;       /* indicates a negative number */
74     unsigned flags; /* bit 0: array must be allocated in secure memory space */
75                     /* bit 1: not used */
76                     /* bit 2: the limb is a pointer to some xmalloced data */
77     mpi_limb_t *d;  /* array with the limbs */
78 };
79
80 typedef struct gcry_mpi *MPI;
81
82 #define MPI_NULL NULL
83
84 #define mpi_get_nlimbs(a)     ((a)->nlimbs)
85 #define mpi_is_neg(a)         ((a)->sign)
86
87 /*-- mpiutil.c --*/
88
89 #ifdef M_DEBUG
90 #define mpi_alloc(n)          mpi_debug_alloc((n), M_DBGINFO( __LINE__ ) )
91 #define mpi_alloc_secure(n) mpi_debug_alloc_secure((n), M_DBGINFO( __LINE__ ) )
92 #define mpi_alloc_like(n)   mpi_debug_alloc_like((n), M_DBGINFO( __LINE__ ) )
93 #define mpi_free(a)           mpi_debug_free((a), M_DBGINFO(__LINE__) )
94 #define mpi_resize(a,b)     mpi_debug_resize((a),(b), M_DBGINFO(__LINE__) )
95 #define mpi_copy(a)           mpi_debug_copy((a), M_DBGINFO(__LINE__) )
96 MPI mpi_debug_alloc( unsigned nlimbs, const char *info );
97 MPI mpi_debug_alloc_secure( unsigned nlimbs, const char *info );
98 MPI mpi_debug_alloc_like( MPI a, const char *info );
99 void mpi_debug_free( MPI a, const char *info );
100 void mpi_debug_resize( MPI a, unsigned nlimbs, const char *info );
101 MPI  mpi_debug_copy( MPI a, const char *info    );
102 #else
103 MPI mpi_alloc( unsigned nlimbs );
104 MPI mpi_alloc_secure( unsigned nlimbs );
105 MPI mpi_alloc_like( MPI a );
106 void mpi_free( MPI a );
107 void mpi_resize( MPI a, unsigned nlimbs );
108 MPI  mpi_copy( MPI a );
109 #endif
110 #define mpi_is_opaque(a) ((a) && ((a)->flags&4))
111 MPI mpi_set_opaque( MPI a, void *p, unsigned int len );
112 void *mpi_get_opaque( MPI a, unsigned int *len );
113 #define mpi_is_secure(a) ((a) && ((a)->flags&1))
114 void mpi_set_secure( MPI a );
115 void mpi_clear( MPI a );
116 void mpi_set( MPI w, MPI u);
117 void mpi_set_ui( MPI w, ulong u);
118 MPI  mpi_alloc_set_ui( unsigned long u);
119 void mpi_m_check( MPI a );
120 void mpi_swap( MPI a, MPI b);
121
122 /*-- mpicoder.c --*/
123 int mpi_write( IOBUF out, MPI a );
124 #ifdef M_DEBUG
125 #define mpi_read(a,b,c)   mpi_debug_read((a),(b),(c),  M_DBGINFO( __LINE__ ) )
126 MPI mpi_debug_read(IOBUF inp, unsigned *nread, int secure, const char *info);
127 #else
128 MPI mpi_read(IOBUF inp, unsigned *nread, int secure);
129 #endif
130 MPI mpi_read_from_buffer(byte *buffer, unsigned *ret_nread, int secure);
131 int mpi_fromstr(MPI val, const char *str);
132 int mpi_print( FILE *fp, MPI a, int mode );
133 void g10_log_mpidump( const char *text, MPI a );
134 u32 mpi_get_keyid( MPI a, u32 *keyid );
135 byte *mpi_get_buffer( MPI a, unsigned *nbytes, int *sign );
136 byte *mpi_get_secure_buffer( MPI a, unsigned *nbytes, int *sign );
137 void  mpi_set_buffer( MPI a, const byte *buffer, unsigned nbytes, int sign );
138
139 #define log_mpidump g10_log_mpidump
140
141 /*-- mpi-add.c --*/
142 void mpi_add_ui(MPI w, MPI u, ulong v );
143 void mpi_add(MPI w, MPI u, MPI v);
144 void mpi_addm(MPI w, MPI u, MPI v, MPI m);
145 void mpi_sub_ui(MPI w, MPI u, ulong v );
146 void mpi_sub( MPI w, MPI u, MPI v);
147 void mpi_subm( MPI w, MPI u, MPI v, MPI m);
148
149 /*-- mpi-mul.c --*/
150 void mpi_mul_ui(MPI w, MPI u, ulong v );
151 void mpi_mul_2exp( MPI w, MPI u, ulong cnt);
152 void mpi_mul( MPI w, MPI u, MPI v);
153 void mpi_mulm( MPI w, MPI u, MPI v, MPI m);
154
155 /*-- mpi-div.c --*/
156 ulong mpi_fdiv_r_ui( MPI rem, MPI dividend, ulong divisor );
157 void  mpi_fdiv_r( MPI rem, MPI dividend, MPI divisor );
158 void  mpi_fdiv_q( MPI quot, MPI dividend, MPI divisor );
159 void  mpi_fdiv_qr( MPI quot, MPI rem, MPI dividend, MPI divisor );
160 void  mpi_tdiv_r( MPI rem, MPI num, MPI den);
161 void  mpi_tdiv_qr( MPI quot, MPI rem, MPI num, MPI den);
162 void  mpi_tdiv_q_2exp( MPI w, MPI u, unsigned count );
163 int   mpi_divisible_ui(MPI dividend, ulong divisor );
164
165 /*-- mpi-gcd.c --*/
166 int mpi_gcd( MPI g, MPI a, MPI b );
167
168 /*-- mpi-pow.c --*/
169 void mpi_pow( MPI w, MPI u, MPI v);
170 void mpi_powm( MPI res, MPI base, MPI exponent, MPI mod);
171
172 /*-- mpi-mpow.c --*/
173 void mpi_mulpowm( MPI res, MPI *basearray, MPI *exparray, MPI mod);
174
175 /*-- mpi-cmp.c --*/
176 int mpi_cmp_ui( MPI u, ulong v );
177 int mpi_cmp( MPI u, MPI v );
178
179 /*-- mpi-scan.c --*/
180 int mpi_getbyte( MPI a, unsigned idx );
181 void mpi_putbyte( MPI a, unsigned idx, int value );
182 unsigned mpi_trailing_zeros( MPI a );
183
184 /*-- mpi-bit.c --*/
185 void mpi_normalize( MPI a );
186 unsigned mpi_get_nbits( MPI a );
187 int  mpi_test_bit( MPI a, unsigned n );
188 void mpi_set_bit( MPI a, unsigned n );
189 void mpi_set_highbit( MPI a, unsigned n );
190 void mpi_clear_highbit( MPI a, unsigned n );
191 void mpi_clear_bit( MPI a, unsigned n );
192 void mpi_rshift( MPI x, MPI a, unsigned n );
193
194 /*-- mpi-inv.c --*/
195 void mpi_invm( MPI x, MPI u, MPI v );
196
197 #endif /*G10_MPI_H*/