The big extension module removal.
[gnupg.git] / include / cipher.h
1 /* cipher.h
2  *      Copyright (C) 1998, 1999, 2000, 2001 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 #ifndef G10_CIPHER_H
21 #define G10_CIPHER_H
22
23 #define DBG_CIPHER g10c_debug_mode
24
25 #include "mpi.h"
26 #include "../cipher/random.h"
27
28
29 #define CIPHER_ALGO_NONE         0
30 #define CIPHER_ALGO_IDEA         1
31 #define CIPHER_ALGO_3DES         2
32 #define CIPHER_ALGO_CAST5        3
33 #define CIPHER_ALGO_BLOWFISH     4  /* blowfish 128 bit key */
34 #define CIPHER_ALGO_SAFER_SK128  5
35 #define CIPHER_ALGO_DES_SK       6
36 #define CIPHER_ALGO_RIJNDAEL     7
37 #define CIPHER_ALGO_RIJNDAEL192  8
38 #define CIPHER_ALGO_RIJNDAEL256  9
39 #define CIPHER_ALGO_TWOFISH     10  /* twofish 256 bit */
40 #define CIPHER_ALGO_SKIPJACK   101  /* experimental: skipjack */
41 #define CIPHER_ALGO_TWOFISH_OLD 102 /* experimental: twofish 128 bit */
42 #define CIPHER_ALGO_DUMMY      110  /* no encryption at all */
43
44 #define PUBKEY_ALGO_RSA        1
45 #define PUBKEY_ALGO_RSA_E      2     /* RSA encrypt only */
46 #define PUBKEY_ALGO_RSA_S      3     /* RSA sign only */
47 #define PUBKEY_ALGO_ELGAMAL_E 16     /* encrypt only ElGamal (but not for v3)*/
48 #define PUBKEY_ALGO_DSA       17
49 #define PUBKEY_ALGO_ELGAMAL   20     /* sign and encrypt elgamal */
50
51 #define PUBKEY_USAGE_SIG     1      /* key is good for signatures */
52 #define PUBKEY_USAGE_ENC     2      /* key is good for encryption */
53 #define PUBKEY_USAGE_CERT    4      /* key is also good to certify other keys*/
54
55 #define DIGEST_ALGO_MD5       1
56 #define DIGEST_ALGO_SHA1      2
57 #define DIGEST_ALGO_RMD160    3
58 #define DIGEST_ALGO_TIGER     6
59
60 #define is_RSA(a)     ((a)==PUBKEY_ALGO_RSA || (a)==PUBKEY_ALGO_RSA_E \
61                        || (a)==PUBKEY_ALGO_RSA_S )
62 #define is_ELGAMAL(a) ((a)==PUBKEY_ALGO_ELGAMAL || (a)==PUBKEY_ALGO_ELGAMAL_E)
63
64 typedef struct {
65     int algo;
66     int keylen;
67     int algo_info_printed;
68     int use_mdc;
69     byte key[32]; /* this is the largest used keylen (256 bit) */
70 } DEK;
71
72 struct cipher_handle_s;
73 typedef struct cipher_handle_s *CIPHER_HANDLE;
74
75
76 #define CIPHER_MODE_ECB       1
77 #define CIPHER_MODE_CFB       2
78 #define CIPHER_MODE_PHILS_CFB 3
79 #define CIPHER_MODE_AUTO_CFB  4
80 #define CIPHER_MODE_DUMMY     5  /* used with algo DUMMY for no encryption */
81 #define CIPHER_MODE_CBC       6
82
83 struct md_digest_list_s;
84
85 struct gcry_md_context {
86     int  secure;
87     FILE  *debug;
88     int finalized;
89     struct md_digest_list_s *list;
90     int  bufcount;
91     int  bufsize;
92     byte buffer[1];
93 };
94
95 typedef struct gcry_md_context *MD_HANDLE;
96
97 #ifndef EXTERN_UNLESS_MAIN_MODULE
98  #if defined (__riscos__) && !defined (INCLUDED_BY_MAIN_MODULE)
99   #define EXTERN_UNLESS_MAIN_MODULE extern
100  #else
101   #define EXTERN_UNLESS_MAIN_MODULE 
102  #endif
103 #endif
104 EXTERN_UNLESS_MAIN_MODULE int g10c_debug_mode;
105 EXTERN_UNLESS_MAIN_MODULE int g10_opt_verbose;
106 EXTERN_UNLESS_MAIN_MODULE const char *g10_opt_homedir;
107
108
109 /*-- dynload.c --*/
110 void register_cipher_extension( const char *mainpgm, const char *fname );
111
112 /*-- md.c --*/
113 int string_to_digest_algo( const char *string );
114 const char * digest_algo_to_string( int algo );
115 int check_digest_algo( int algo );
116 MD_HANDLE md_open( int algo, int secure );
117 void md_enable( MD_HANDLE hd, int algo );
118 MD_HANDLE md_copy( MD_HANDLE a );
119 void md_reset( MD_HANDLE a );
120 void md_close(MD_HANDLE a);
121 void md_write( MD_HANDLE a, const byte *inbuf, size_t inlen);
122 void md_final(MD_HANDLE a);
123 byte *md_read( MD_HANDLE a, int algo );
124 int md_digest( MD_HANDLE a, int algo, byte *buffer, int buflen );
125 int md_get_algo( MD_HANDLE a );
126 int md_digest_length( int algo );
127 const byte *md_asn_oid( int algo, size_t *asnlen, size_t *mdlen );
128 void md_start_debug( MD_HANDLE a, const char *suffix );
129 void md_stop_debug( MD_HANDLE a );
130 #define md_is_secure(a) ((a)->secure)
131 #define md_putc(h,c)  \
132             do {                                            \
133                 if( (h)->bufcount == (h)->bufsize )         \
134                     md_write( (h), NULL, 0 );               \
135                 (h)->buffer[(h)->bufcount++] = (c) & 0xff;  \
136             } while(0)
137
138 void rmd160_hash_buffer (char *outbuf, const char *buffer, size_t length);
139
140
141 /*-- cipher.c --*/
142 int string_to_cipher_algo( const char *string );
143 const char * cipher_algo_to_string( int algo );
144 void disable_cipher_algo( int algo );
145 int check_cipher_algo( int algo );
146 unsigned cipher_get_keylen( int algo );
147 unsigned cipher_get_blocksize( int algo );
148 CIPHER_HANDLE cipher_open( int algo, int mode, int secure );
149 void cipher_close( CIPHER_HANDLE c );
150 int  cipher_setkey( CIPHER_HANDLE c, byte *key, unsigned keylen );
151 void cipher_setiv( CIPHER_HANDLE c, const byte *iv, unsigned ivlen );
152 void cipher_encrypt( CIPHER_HANDLE c, byte *out, byte *in, unsigned nbytes );
153 void cipher_decrypt( CIPHER_HANDLE c, byte *out, byte *in, unsigned nbytes );
154 void cipher_sync( CIPHER_HANDLE c );
155
156 /*-- pubkey.c --*/
157 #define PUBKEY_MAX_NPKEY  4
158 #define PUBKEY_MAX_NSKEY  6
159 #define PUBKEY_MAX_NSIG   2
160 #define PUBKEY_MAX_NENC   2
161
162 int string_to_pubkey_algo( const char *string );
163 const char * pubkey_algo_to_string( int algo );
164 void disable_pubkey_algo( int algo );
165 int check_pubkey_algo( int algo );
166 int check_pubkey_algo2( int algo, unsigned use );
167 int pubkey_get_npkey( int algo );
168 int pubkey_get_nskey( int algo );
169 int pubkey_get_nsig( int algo );
170 int pubkey_get_nenc( int algo );
171 unsigned pubkey_nbits( int algo, MPI *pkey );
172 int pubkey_generate( int algo, unsigned nbits, MPI *skey, MPI **retfactors );
173 int pubkey_check_secret_key( int algo, MPI *skey );
174 int pubkey_encrypt( int algo, MPI *resarr, MPI data, MPI *pkey );
175 int pubkey_decrypt( int algo, MPI *result, MPI *data, MPI *skey );
176 int pubkey_sign( int algo, MPI *resarr, MPI hash, MPI *skey );
177 int pubkey_verify( int algo, MPI hash, MPI *data, MPI *pkey,
178                       int (*cmp)(void *, MPI), void *opaque );
179
180 /*-- smallprime.c --*/
181 extern ushort small_prime_numbers[];
182
183 /*-- primegen.c --*/
184 void register_primegen_progress ( void (*cb)( void *, int), void *cb_data );
185 MPI generate_secret_prime( unsigned nbits );
186 MPI generate_public_prime( unsigned nbits );
187 MPI generate_elg_prime( int mode, unsigned pbits, unsigned qbits,
188                                            MPI g, MPI **factors );
189
190 /*-- elsewhere --*/
191 void register_pk_dsa_progress ( void (*cb)( void *, int), void *cb_data );
192 void register_pk_elg_progress ( void (*cb)( void *, int), void *cb_data );
193
194 #endif /*G10_CIPHER_H*/