See ChangeLog: Fri Dec 31 12:48:31 CET 1999 Werner Koch
[libgcrypt.git] / src / 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 "types.h"
34 #include "memory.h"
35
36
37 #define DBG_MPI     g10_get_debug_flag( 2 );
38
39 #define BITS_PER_MPI_LIMB    (8*SIZEOF_UNSIGNED_LONG)
40 #define BYTES_PER_MPI_LIMB   SIZEOF_UNSIGNED_LONG
41 typedef unsigned long int mpi_limb_t;
42 typedef   signed long int mpi_limb_signed_t;
43
44 struct gcry_mpi {
45     int alloced;    /* array size (# of allocated limbs) */
46     int nlimbs;     /* number of valid limbs */
47     int sign;       /* indicates a negative number and is used for opaque
48                      * MPIs to store the length */
49     unsigned flags; /* bit 0: array must be allocated in secure memory space */
50                     /* bit 2: the limb is a pointer to some m_alloced data */
51     mpi_limb_t *d;  /* array with the limbs */
52 };
53
54 #ifndef DID_MPI_TYPEDEF
55   typedef struct gcry_mpi *MPI;
56   #define DID_MPI_TYPEDEF
57 #endif
58
59 #define MPI_NULL NULL
60
61 #define mpi_get_nlimbs(a)     ((a)->nlimbs)
62 #define mpi_is_neg(a)         ((a)->sign)
63
64 /*-- mpiutil.c --*/
65
66 #ifdef M_DEBUG
67   #define mpi_alloc(n)  mpi_debug_alloc((n), M_DBGINFO( __LINE__ ) )
68   #define mpi_alloc_secure(n)  mpi_debug_alloc_secure((n), M_DBGINFO( __LINE__ ) )
69   #define mpi_free(a)   mpi_debug_free((a), M_DBGINFO(__LINE__) )
70   #define mpi_resize(a,b) mpi_debug_resize((a),(b), M_DBGINFO(__LINE__) )
71   #define mpi_copy(a)     mpi_debug_copy((a), M_DBGINFO(__LINE__) )
72   MPI mpi_debug_alloc( unsigned nlimbs, const char *info );
73   MPI mpi_debug_alloc_secure( unsigned nlimbs, const char *info );
74   void mpi_debug_free( MPI a, const char *info );
75   void mpi_debug_resize( MPI a, unsigned nlimbs, const char *info );
76   MPI  mpi_debug_copy( MPI a, const char *info  );
77 #else
78   MPI mpi_alloc( unsigned nlimbs );
79   MPI mpi_alloc_secure( unsigned nlimbs );
80   void mpi_free( MPI a );
81   void mpi_resize( MPI a, unsigned nlimbs );
82   MPI  mpi_copy( MPI a );
83 #endif
84 #define mpi_is_opaque(a) ((a) && ((a)->flags&4))
85 MPI mpi_set_opaque( MPI a, void *p, unsigned int len );
86 void *mpi_get_opaque( MPI a, unsigned int *len );
87 #define mpi_is_secure(a) ((a) && ((a)->flags&1))
88 void mpi_set_secure( MPI a );
89 void mpi_clear( MPI a );
90 MPI  mpi_alloc_like( MPI a );
91 void mpi_set( MPI w, MPI u);
92 void mpi_set_ui( MPI w, ulong u);
93 MPI  mpi_alloc_set_ui( unsigned long u);
94 void mpi_m_check( MPI a );
95 void mpi_swap( MPI a, MPI b);
96
97 /*-- mpicoder.c --*/
98 int mpi_fromstr(MPI val, const char *str);
99 int mpi_print( FILE *fp, MPI a, int mode );
100 void g10_log_mpidump( const char *text, MPI a );
101 u32 mpi_get_keyid( MPI a, u32 *keyid );
102 byte *mpi_get_buffer( MPI a, unsigned *nbytes, int *sign );
103 byte *mpi_get_secure_buffer( MPI a, unsigned *nbytes, int *sign );
104 void  mpi_set_buffer( MPI a, const byte *buffer, unsigned nbytes, int sign );
105
106 #define log_mpidump g10_log_mpidump
107
108 /*-- mpi-add.c --*/
109 void mpi_add_ui(MPI w, MPI u, ulong v );
110 void mpi_add(MPI w, MPI u, MPI v);
111 void mpi_addm(MPI w, MPI u, MPI v, MPI m);
112 void mpi_sub_ui(MPI w, MPI u, ulong v );
113 void mpi_sub( MPI w, MPI u, MPI v);
114 void mpi_subm( MPI w, MPI u, MPI v, MPI m);
115
116 /*-- mpi-mul.c --*/
117 void mpi_mul_ui(MPI w, MPI u, ulong v );
118 void mpi_mul_2exp( MPI w, MPI u, ulong cnt);
119 void mpi_mul( MPI w, MPI u, MPI v);
120 void mpi_mulm( MPI w, MPI u, MPI v, MPI m);
121
122 /*-- mpi-div.c --*/
123 ulong mpi_fdiv_r_ui( MPI rem, MPI dividend, ulong divisor );
124 void  mpi_fdiv_r( MPI rem, MPI dividend, MPI divisor );
125 void  mpi_fdiv_q( MPI quot, MPI dividend, MPI divisor );
126 void  mpi_fdiv_qr( MPI quot, MPI rem, MPI dividend, MPI divisor );
127 void  mpi_tdiv_r( MPI rem, MPI num, MPI den);
128 void  mpi_tdiv_qr( MPI quot, MPI rem, MPI num, MPI den);
129 void  mpi_tdiv_q_2exp( MPI w, MPI u, unsigned count );
130 int   mpi_divisible_ui(MPI dividend, ulong divisor );
131
132 /*-- mpi-gcd.c --*/
133 int mpi_gcd( MPI g, MPI a, MPI b );
134
135 /*-- mpi-mpow.c --*/
136 void mpi_mulpowm( MPI res, MPI *basearray, MPI *exparray, MPI mod);
137
138 /*-- mpi-cmp.c --*/
139 int mpi_cmp_ui( MPI u, ulong v );
140 int mpi_cmp( MPI u, MPI v );
141
142 /*-- mpi-scan.c --*/
143 int mpi_getbyte( MPI a, unsigned idx );
144 void mpi_putbyte( MPI a, unsigned idx, int value );
145 unsigned mpi_trailing_zeros( MPI a );
146
147 /*-- mpi-bit.c --*/
148 void mpi_normalize( MPI a );
149 unsigned int mpi_get_nbits( MPI a );
150 int  mpi_test_bit( MPI a, unsigned n );
151 void mpi_set_bit( MPI a, unsigned n );
152 void mpi_set_highbit( MPI a, unsigned n );
153 void mpi_clear_highbit( MPI a, unsigned n );
154 void mpi_clear_bit( MPI a, unsigned n );
155 void mpi_rshift( MPI x, MPI a, unsigned n );
156
157 /*-- mpi-inv.c --*/
158 void mpi_invm( MPI x, MPI u, MPI v );
159
160
161 #endif /*G10_MPI_H*/