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