53106271e19035af41a74fd13165da06525d4d04
[libgcrypt.git] / src / gcrypt.h
1 /* gcrypt.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 _GCRYPT_H
22 #define _GCRYPT_H
23 #ifdef __cplusplus
24 extern "C" {
25 #endif
26
27
28 /*******************************************
29  *                                         *
30  *  error handling                         *
31  *                                         *
32  *******************************************/
33
34 enum gcry_error {
35     GCRYERR_SUCCESS = 0,
36     GCRYERR_INV_OP = 1,     /* inavlid operation code */
37     GCRYERR_GENERAL = 2
38 };
39
40 /*******************************************
41  *                                         *
42  *  multi precision integer functions      *
43  *                                         *
44  *******************************************/
45
46 enum gcry_mpi_opcode {
47     GCRYMPI_NOOP = 0,
48     GCRYMPI_NEW  = 1,       /* use gcry_mpi_new() */
49     GCRYMPI_SNEW = 2,       /* use gcry_mpi_new() */
50     GCRYMPI_RELEASE = 3,
51     GCRYMPI_RESIZE = 4,
52     GCRYMPI_COPY = 5,       /* use gcry_mpi_new() */
53     GCRYMPI_SWAP = 6,
54     GCRYMPI_SET  = 7,
55     GCRYMPI_SET_UI = 8,
56     GCRYMPI_CMP    = 9,
57     GCRYMPI_CMP_UI = 10
58 };
59
60 struct gcry_mpi;
61
62 int gcry_mpi_api( enum gcry_mpi_opcode opcode, int n_args, ... );
63 struct gcry_mpi *gcry_mpi_new( enum gcry_mpi_opcode opcode,
64                                unsigned int size,
65                                struct gcry_mpi *val
66                               );
67
68 #ifndef GCRYPT_NO_MPI_MACROS
69 #define mpi_new( nbits )  gcry_mpi_new( GCRYMPI_NEW, (nbits), NULL )
70 #define mpi_secure_new( nbits )  gcry_mpi_new( GCRYMPI_SNEW, (nbits), NULL )
71 #define mpi_release( a )     do {   gcry_mpi_api( GCRYMPI_RELEASE, 1, (a) );
72                                     (a) = NULL; } while(0)
73 #define mpi_resize( a, n )  gcry_mpi_api( GCRYMPI_RESIZE, 2, (a), (n) )
74 #define mpi_copy( a )       gcry_mpi_new( GCRYMPI_COPY, 0, (a) )
75 #define mpi_swap( a, b )    gcyr_mpi_api( GCRYMPI_SWAP, 2, (a), (b) )
76 /* void mpi_set( MPI w, MPI u ); */
77 #define mpi_set( w, u)      gcry_mpi_api( GCRYMPI_SET, 2, (w), (u) )
78 /* void mpi_set_ui( MPI w, unsigned long u ); */
79 #define mpi_set_ui( w, u)   gcry_mpi_api( GCRYMPI_SET_UI, 2, (w), (u) )
80 /* int  mpi_cmp( MPI u, MPI v ); */
81 #define mpi_cmp( u, v )     gcry_mpi_api( GCRYMPI_CMP, 2, (u), (v) )
82 /* int  mpi_cmp_ui( MPI u, unsigned long v ); */
83 #define mpi_cmp_ui( u, v )  gcry_mpi_api( GCRYMPI_CMP_UI, 2, (u), (v) )
84
85
86 void g10m_add(MPI w, MPI u, MPI v);
87 void g10m_add_ui(MPI w, MPI u, unsigned long v );
88 void g10m_sub( MPI w, MPI u, MPI v);
89 void g10m_sub_ui(MPI w, MPI u, unsigned long v );
90
91 void g10m_mul_ui(MPI w, MPI u, unsigned long v );
92 void g10m_mul_2exp( MPI w, MPI u, unsigned long cnt);
93 void g10m_mul( MPI w, MPI u, MPI v);
94 void g10m_mulm( MPI w, MPI u, MPI v, MPI m);
95
96 void g10m_fdiv_q( MPI quot, MPI dividend, MPI divisor );
97
98 void g10m_powm( MPI res, MPI base, MPI exp, MPI mod);
99
100 int  g10m_gcd( MPI g, MPI a, MPI b );
101 int  g10m_invm( MPI x, MPI u, MPI v );
102
103 unsigned g10m_get_nbits( MPI a );
104 unsigned g10m_get_size( MPI a );
105
106 void g10m_set_buffer( MPI a, const char *buffer, unsigned nbytes, int sign );
107
108
109 #endif /* GCRYPT_NO_MPI_MACROS */
110
111 /********************************************
112  *******  symmetric cipher functions  *******
113  ********************************************/
114
115
116
117 /*********************************************
118  *******  asymmetric cipher functions  *******
119  *********************************************/
120
121
122
123
124 /*********************************************
125  *******  cryptograhic hash functions  *******
126  *********************************************/
127
128
129 /*****************************************
130  *******  miscellaneous functions  *******
131  *****************************************/
132
133 #if 0
134 const char *g10m_revision_string(int mode);
135 const char *g10c_revision_string(int mode);
136 const char *g10u_revision_string(int mode);
137
138 MPI   g10c_generate_secret_prime( unsigned nbits );
139 char *g10c_get_random_bits( unsigned nbits, int level, int secure );
140
141
142 void *g10_malloc( size_t n );
143 void *g10_calloc( size_t n );
144 void *g10_malloc_secure( size_t n );
145 void *g10_calloc_secure( size_t n );
146 void *g10_realloc( void *a, size_t n );
147 void  g10_free( void *p );
148 char *g10_strdup( const char * a);
149
150 void g10_log_bug( const char *fmt, ... );
151 void g10_log_bug0( const char *, int );
152 void g10_log_fatal( const char *fmt, ... );
153 void g10_log_error( const char *fmt, ... );
154 void g10_log_info( const char *fmt, ... );
155 void g10_log_debug( const char *fmt, ... );
156 void g10_log_hexdump( const char *text, char *buf, size_t len );
157 void g10_log_mpidump( const char *text, MPI a );
158 #endif
159
160 /***************************
161  *******  constants  *******
162  **************************/
163 #if 0
164 #define CIPHER_ALGO_NONE         0
165 #define CIPHER_ALGO_IDEA         1
166 #define CIPHER_ALGO_3DES         2
167 #define CIPHER_ALGO_CAST5        3
168 #define CIPHER_ALGO_BLOWFISH     4  /* blowfish 128 bit key */
169 #define CIPHER_ALGO_SAFER_SK128  5
170 #define CIPHER_ALGO_DES_SK       6
171 #define CIPHER_ALGO_BLOWFISH160 42  /* blowfish 160 bit key (not in OpenPGP)*/
172 #define CIPHER_ALGO_DUMMY      110  /* no encryption at all */
173
174 #define PUBKEY_ALGO_RSA        1
175 #define PUBKEY_ALGO_RSA_E      2     /* RSA encrypt only */
176 #define PUBKEY_ALGO_RSA_S      3     /* RSA sign only */
177 #define PUBKEY_ALGO_ELGAMAL_E 16     /* encrypt only ElGamal (but not vor v3)*/
178 #define PUBKEY_ALGO_DSA       17
179 #define PUBKEY_ALGO_ELGAMAL   20     /* sign and encrypt elgamal */
180
181 #define DIGEST_ALGO_MD5       1
182 #define DIGEST_ALGO_SHA1      2
183 #define DIGEST_ALGO_RMD160    3
184 #define DIGEST_ALGO_TIGER     6
185
186 #define is_RSA(a)     ((a)==PUBKEY_ALGO_RSA || (a)==PUBKEY_ALGO_RSA_E \
187                        || (a)==PUBKEY_ALGO_RSA_S )
188 #define is_ELGAMAL(a) ((a)==PUBKEY_ALGO_ELGAMAL || (a)==PUBKEY_ALGO_ELGAMAL_E)
189
190 #define G10ERR_GENERAL         1
191 #define G10ERR_PUBKEY_ALGO     4
192 #define G10ERR_DIGEST_ALGO     5
193 #define G10ERR_BAD_PUBKEY      6
194 #define G10ERR_BAD_SECKEY      7
195 #define G10ERR_BAD_SIGN        8
196 #define G10ERR_CIPHER_ALGO    12
197 #define G10ERR_WRONG_SECKEY   18
198 #define G10ERR_UNSUPPORTED    19
199 #define G10ERR_NI_PUBKEY      27
200 #define G10ERR_NI_CIPHER      28
201 #define G10ERR_BAD_MPI        30
202 #define G10ERR_WR_PUBKEY_ALGO 41
203 #endif
204
205 /***********************************************
206  *                                             *
207  *   Some very handy macros                    *
208  *                                             *
209  ***********************************************/
210 #ifndef GCRYPT_NO_MPI_MACROS
211
212 typedef struct gcry_mpi *MPI;
213
214
215 #endif /* GCRYPT_NO_MPI_MACROS */
216
217 #ifdef __cplusplus
218 }
219 #endif
220 #endif /* _GCRYPT_H */