See ChangeLog: Fri Feb 19 18:01:54 CET 1999 Werner Koch
[gnupg.git] / include / g10lib.h
1 /* g10lib.h -  GNU digital encryption libray interface
2  *      Copyright (C) 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
21 #ifndef _g10lib_G10LIB_H
22 #define _g10lib_G10LIB_H
23 #ifdef __cplusplus
24 extern "C" {
25 #endif
26
27
28
29 #ifndef _g10lib_INTERNAL
30 struct g10mpi_struct { int hidden_stuff; };
31 typedef struct g10mpi_struct *MPI;
32 #endif
33
34 int g10c_debug_mode;
35 int g10_opt_verbose;
36
37 /********************************
38  *******  math functions  *******
39  ********************************/
40 MPI  g10m_new( unsigned nbits );
41 MPI  g10m_new_secure( unsigned nbits );
42 void g10m_release( MPI a );
43 void g10m_resize( MPI a, unsigned nbits );
44 MPI  g10m_copy( MPI a );
45 void g10m_swap( MPI a, MPI b);
46 void g10m_set( MPI w, MPI u);
47 void g10m_set_ui( MPI w, unsigned long u);
48 void g10m_set_bytes( MPI a, unsigned nbits, unsigned char (*fnc)(int), int opaque );
49 int  g10m_cmp( MPI u, MPI v );
50 int  g10m_cmp_ui( MPI u, unsigned long v );
51
52
53 void g10m_add(MPI w, MPI u, MPI v);
54 void g10m_add_ui(MPI w, MPI u, unsigned long v );
55 void g10m_sub( MPI w, MPI u, MPI v);
56 void g10m_sub_ui(MPI w, MPI u, unsigned long v );
57
58 void g10m_mul_ui(MPI w, MPI u, unsigned long v );
59 void g10m_mul_2exp( MPI w, MPI u, unsigned long cnt);
60 void g10m_mul( MPI w, MPI u, MPI v);
61 void g10m_mulm( MPI w, MPI u, MPI v, MPI m);
62
63 void g10m_fdiv_q( MPI quot, MPI dividend, MPI divisor );
64
65 void g10m_powm( MPI res, MPI base, MPI exp, MPI mod);
66
67 int  g10m_gcd( MPI g, MPI a, MPI b );
68 int  g10m_invm( MPI x, MPI u, MPI v );
69
70 unsigned g10m_get_nbits( MPI a );
71 unsigned g10m_get_size( MPI a );
72
73 void g10m_set_buffer( MPI a, const char *buffer, unsigned nbytes, int sign );
74
75
76 /********************************************
77  *******  symmetric cipher functions  *******
78  ********************************************/
79
80
81
82 /*********************************************
83  *******  asymmetric cipher functions  *******
84  *********************************************/
85
86
87
88
89 /*********************************************
90  *******  cryptograhic hash functions  *******
91  *********************************************/
92
93
94 /*****************************************
95  *******  miscellaneous functions  *******
96  *****************************************/
97
98 const char *g10m_revision_string(int mode);
99 const char *g10c_revision_string(int mode);
100 const char *g10u_revision_string(int mode);
101
102 MPI   g10c_generate_secret_prime( unsigned nbits );
103 char *g10c_get_random_bits( unsigned nbits, int level, int secure );
104
105
106 void *g10_malloc( size_t n );
107 void *g10_calloc( size_t n );
108 void *g10_malloc_secure( size_t n );
109 void *g10_calloc_secure( size_t n );
110 void *g10_realloc( void *a, size_t n );
111 void  g10_free( void *p );
112 char *g10_strdup( const char * a);
113
114 void g10_log_bug( const char *fmt, ... );
115 void g10_log_bug0( const char *, int );
116 void g10_log_fatal( const char *fmt, ... );
117 void g10_log_error( const char *fmt, ... );
118 void g10_log_info( const char *fmt, ... );
119 void g10_log_debug( const char *fmt, ... );
120 void g10_log_hexdump( const char *text, char *buf, size_t len );
121 void g10_log_mpidump( const char *text, MPI a );
122
123
124 /***************************
125  *******  constants  *******
126  **************************/
127 #define CIPHER_ALGO_NONE         0
128 #define CIPHER_ALGO_IDEA         1
129 #define CIPHER_ALGO_3DES         2
130 #define CIPHER_ALGO_CAST5        3
131 #define CIPHER_ALGO_BLOWFISH     4  /* blowfish 128 bit key */
132 #define CIPHER_ALGO_SAFER_SK128  5
133 #define CIPHER_ALGO_DES_SK       6
134 #define CIPHER_ALGO_BLOWFISH160 42  /* blowfish 160 bit key (not in OpenPGP)*/
135 #define CIPHER_ALGO_DUMMY      110  /* no encryption at all */
136
137 #define PUBKEY_ALGO_RSA        1
138 #define PUBKEY_ALGO_RSA_E      2     /* RSA encrypt only */
139 #define PUBKEY_ALGO_RSA_S      3     /* RSA sign only */
140 #define PUBKEY_ALGO_ELGAMAL_E 16     /* encrypt only ElGamal (but not vor v3)*/
141 #define PUBKEY_ALGO_DSA       17
142 #define PUBKEY_ALGO_ELGAMAL   20     /* sign and encrypt elgamal */
143
144 #define DIGEST_ALGO_MD5       1
145 #define DIGEST_ALGO_SHA1      2
146 #define DIGEST_ALGO_RMD160    3
147 #define DIGEST_ALGO_TIGER     6
148
149 #define is_RSA(a)     ((a)==PUBKEY_ALGO_RSA || (a)==PUBKEY_ALGO_RSA_E \
150                        || (a)==PUBKEY_ALGO_RSA_S )
151 #define is_ELGAMAL(a) ((a)==PUBKEY_ALGO_ELGAMAL || (a)==PUBKEY_ALGO_ELGAMAL_E)
152
153 #define G10ERR_GENERAL         1
154 #define G10ERR_PUBKEY_ALGO     4
155 #define G10ERR_DIGEST_ALGO     5
156 #define G10ERR_BAD_PUBKEY      6
157 #define G10ERR_BAD_SECKEY      7
158 #define G10ERR_BAD_SIGN        8
159 #define G10ERR_CIPHER_ALGO    12
160 #define G10ERR_WRONG_SECKEY   18
161 #define G10ERR_UNSUPPORTED    19
162 #define G10ERR_NI_PUBKEY      27
163 #define G10ERR_NI_CIPHER      28
164 #define G10ERR_BAD_MPI        30
165 #define G10ERR_WR_PUBKEY_ALGO 41
166
167
168 /***********************************
169  *******  some handy macros  *******
170  ***********************************/
171
172 #ifndef BUG
173   #define BUG() g10_log_bug0( __FILE__ , __LINE__ )
174 #endif
175
176 #ifndef STR
177   #define STR(v) #v
178   #define STR2(v) STR(v)
179 #endif
180
181 #ifndef DIM
182   #define DIM(v) (sizeof(v)/sizeof((v)[0]))
183   #define DIMof(type,member)   DIM(((type *)0)->member)
184 #endif
185
186
187 #define DBG_CIPHER  g10c_debug_mode
188 #define OPT_VERBOSE g10_opt_verbose
189
190
191 #ifdef __cplusplus
192 }
193 #endif
194 #endif /* _g10lib_G10LIB_H */