See ChangeLog: Fri Feb 19 18:01:54 CET 1999 Werner Koch
[gnupg.git] / include / mpi.h
1 /* mpi.h  -  Multi Precision Integers
2  *      Copyright (C) 1994, 1996, 1998 Free Software Foundation, Inc.
3  *
4  * This file is part of GNUPG.
5  *
6  * GNUPG is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * GNUPG is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
19  *
20  * Note: This code is heavily based on the GNU MP Library.
21  *       Actually it's the same code with only minor changes in the
22  *       way the data is stored; this is to support the abstraction
23  *       of an optional secure memory allocation which may be used
24  *       to avoid revealing of sensitive data due to paging etc.
25  *       The GNU MP Library itself is published under the LGPL;
26  *       however I decided to publish this code under the plain GPL.
27  */
28
29 #ifndef G10_MPI_H
30 #define G10_MPI_H
31
32 #include <stdio.h>
33 #include "iobuf.h"
34 #include "types.h"
35 #include "memory.h"
36
37
38 #define DBG_MPI     mpi_debug_mode
39 int mpi_debug_mode;
40
41 #define BITS_PER_MPI_LIMB    (8*SIZEOF_UNSIGNED_LONG)
42 #define 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
46 struct gcry_mpi {
47     int alloced;    /* array size (# of allocated limbs) */
48     int nlimbs;     /* number of valid limbs */
49     int nbits;      /* the real number of valid bits (info only) */
50     int sign;       /* indicates a negative number */
51     unsigned flags; /* bit 0: array must be allocated in secure memory space */
52                     /* bit 1: the mpi is encrypted */
53                     /* bit 2: the limb is a pointer to some m_alloced data */
54     mpi_limb_t *d;  /* array with the limbs */
55 };
56
57 typedef struct gcry_mpi *MPI;
58
59 #define MPI_NULL NULL
60
61 #define mpi_get_nlimbs(a)     ((a)->nlimbs)
62 #define mpi_get_nbit_info(a)  ((a)->nbits)
63 #define mpi_set_nbit_info(a,b) ((a)->nbits = (b))
64 #define mpi_is_neg(a)         ((a)->sign)
65
66 /*-- mpiutil.c --*/
67
68 #ifdef M_DEBUG
69   #define mpi_alloc(n)  mpi_debug_alloc((n), M_DBGINFO( __LINE__ ) )
70   #define mpi_alloc_secure(n)  mpi_debug_alloc_secure((n), M_DBGINFO( __LINE__ ) )
71   #define mpi_free(a)   mpi_debug_free((a), M_DBGINFO(__LINE__) )
72   #define mpi_resize(a,b) mpi_debug_resize((a),(b), M_DBGINFO(__LINE__) )
73   #define mpi_copy(a)     mpi_debug_copy((a), M_DBGINFO(__LINE__) )
74   MPI mpi_debug_alloc( unsigned nlimbs, const char *info );
75   MPI mpi_debug_alloc_secure( unsigned nlimbs, const char *info );
76   void mpi_debug_free( MPI a, const char *info );
77   void mpi_debug_resize( MPI a, unsigned nlimbs, const char *info );
78   MPI  mpi_debug_copy( MPI a, const char *info  );
79 #else
80   MPI mpi_alloc( unsigned nlimbs );
81   MPI mpi_alloc_secure( unsigned nlimbs );
82   void mpi_free( MPI a );
83   void mpi_resize( MPI a, unsigned nlimbs );
84   MPI  mpi_copy( MPI a );
85 #endif
86 #define mpi_is_opaque(a) ((a) && ((a)->flags&4))
87 MPI mpi_set_opaque( MPI a, void *p, int len );
88 void *mpi_get_opaque( MPI a, int *len );
89 #define mpi_is_protected(a) ((a) && ((a)->flags&2))
90 #define mpi_set_protect_flag(a) ((a)->flags |= 2)
91 #define mpi_clear_protect_flag(a) ((a)->flags &= ~2)
92 #define mpi_is_secure(a) ((a) && ((a)->flags&1))
93 void mpi_set_secure( MPI a );
94 void mpi_clear( MPI a );
95 void mpi_set( MPI w, MPI u);
96 void mpi_set_ui( MPI w, ulong u);
97 MPI  mpi_alloc_set_ui( unsigned long u);
98 void mpi_m_check( MPI a );
99 void mpi_swap( MPI a, MPI b);
100
101 /*-- mpicoder.c --*/
102 int mpi_write( IOBUF out, MPI a );
103 #ifdef M_DEBUG
104   #define mpi_read(a,b,c)   mpi_debug_read((a),(b),(c),  M_DBGINFO( __LINE__ ) )
105   MPI mpi_debug_read(IOBUF inp, unsigned *nread, int secure, const char *info);
106 #else
107   MPI mpi_read(IOBUF inp, unsigned *nread, int secure);
108 #endif
109 MPI mpi_read_from_buffer(byte *buffer, unsigned *ret_nread, int secure);
110 int mpi_fromstr(MPI val, const char *str);
111 int mpi_print( FILE *fp, MPI a, int mode );
112 u32 mpi_get_keyid( MPI a, u32 *keyid );
113 byte *mpi_get_buffer( MPI a, unsigned *nbytes, int *sign );
114 byte *mpi_get_secure_buffer( MPI a, unsigned *nbytes, int *sign );
115 void  mpi_set_buffer( MPI a, const byte *buffer, unsigned nbytes, int sign );
116
117 /*-- mpi-add.c --*/
118 void mpi_add_ui(MPI w, MPI u, ulong v );
119 void mpi_add(MPI w, MPI u, MPI v);
120 void mpi_addm(MPI w, MPI u, MPI v, MPI m);
121 void mpi_sub_ui(MPI w, MPI u, ulong v );
122 void mpi_sub( MPI w, MPI u, MPI v);
123 void mpi_subm( MPI w, MPI u, MPI v, MPI m);
124
125 /*-- mpi-mul.c --*/
126 void mpi_mul_ui(MPI w, MPI u, ulong v );
127 void mpi_mul_2exp( MPI w, MPI u, ulong cnt);
128 void mpi_mul( MPI w, MPI u, MPI v);
129 void mpi_mulm( MPI w, MPI u, MPI v, MPI m);
130
131 /*-- mpi-div.c --*/
132 ulong mpi_fdiv_r_ui( MPI rem, MPI dividend, ulong divisor );
133 void  mpi_fdiv_r( MPI rem, MPI dividend, MPI divisor );
134 void  mpi_fdiv_q( MPI quot, MPI dividend, MPI divisor );
135 void  mpi_fdiv_qr( MPI quot, MPI rem, MPI dividend, MPI divisor );
136 void  mpi_tdiv_r( MPI rem, MPI num, MPI den);
137 void  mpi_tdiv_qr( MPI quot, MPI rem, MPI num, MPI den);
138 void  mpi_tdiv_q_2exp( MPI w, MPI u, unsigned count );
139 int   mpi_divisible_ui(MPI dividend, ulong divisor );
140
141 /*-- mpi-gcd.c --*/
142 int mpi_gcd( MPI g, MPI a, MPI b );
143
144 /*-- mpi-pow.c --*/
145 void mpi_pow( MPI w, MPI u, MPI v);
146 void mpi_powm( MPI res, MPI base, MPI exp, MPI mod);
147
148 /*-- mpi-mpow.c --*/
149 void mpi_mulpowm( MPI res, MPI *basearray, MPI *exparray, MPI mod);
150
151 /*-- mpi-cmp.c --*/
152 int mpi_cmp_ui( MPI u, ulong v );
153 int mpi_cmp( MPI u, MPI v );
154
155 /*-- mpi-scan.c --*/
156 int mpi_getbyte( MPI a, unsigned idx );
157 void mpi_putbyte( MPI a, unsigned idx, int value );
158 unsigned mpi_trailing_zeros( MPI a );
159
160 /*-- mpi-bit.c --*/
161 void mpi_normalize( MPI a );
162 unsigned mpi_get_nbits( MPI a );
163 int  mpi_test_bit( MPI a, unsigned n );
164 void mpi_set_bit( MPI a, unsigned n );
165 void mpi_set_highbit( MPI a, unsigned n );
166 void mpi_clear_highbit( MPI a, unsigned n );
167 void mpi_clear_bit( MPI a, unsigned n );
168 void mpi_rshift( MPI x, MPI a, unsigned n );
169
170 /*-- mpi-inv.c --*/
171 void mpi_invm( MPI x, MPI u, MPI v );
172
173
174 #endif /*G10_MPI_H*/