Fixed minor card related bugs and enhanced status messages
[gnupg.git] / include / cipher.h
1 /* cipher.h
2  * Copyright (C) 1998, 1999, 2000, 2001, 2003, 2004,
3  *               2005 Free Software Foundation, Inc.
4  *
5  * This file is part of GNUPG.
6  *
7  * GNUPG is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * GNUPG is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
20  * USA.
21  */
22 #ifndef G10_CIPHER_H
23 #define G10_CIPHER_H
24
25 #define DBG_CIPHER g10c_debug_mode
26
27 #include "mpi.h"
28 #include "../cipher/random.h"
29
30
31 #define CIPHER_ALGO_NONE         0
32 #define CIPHER_ALGO_IDEA         1
33 #define CIPHER_ALGO_3DES         2
34 #define CIPHER_ALGO_CAST5        3
35 #define CIPHER_ALGO_BLOWFISH     4  /* blowfish 128 bit key */
36 /* 5 & 6 are reserved */
37 #define CIPHER_ALGO_AES          7
38 #define CIPHER_ALGO_AES192       8
39 #define CIPHER_ALGO_AES256       9
40 #define CIPHER_ALGO_TWOFISH     10  /* twofish 256 bit */
41 #define CIPHER_ALGO_DUMMY      110  /* no encryption at all */
42
43 #define PUBKEY_ALGO_RSA        1
44 #define PUBKEY_ALGO_RSA_E      2     /* RSA encrypt only */
45 #define PUBKEY_ALGO_RSA_S      3     /* RSA sign only */
46 #define PUBKEY_ALGO_ELGAMAL_E 16     /* encrypt only ElGamal (but not for v3)*/
47 #define PUBKEY_ALGO_DSA       17
48 #define PUBKEY_ALGO_ELGAMAL   20     /* sign and encrypt elgamal */
49
50 #define PUBKEY_USAGE_SIG     1      /* key is good for signatures */
51 #define PUBKEY_USAGE_ENC     2      /* key is good for encryption */
52 #define PUBKEY_USAGE_CERT    4      /* key is also good to certify other keys*/
53 #define PUBKEY_USAGE_AUTH    8      /* key is good for authentication */
54 #define PUBKEY_USAGE_UNKNOWN 128    /* key has an unknown usage bit */
55
56 #define DIGEST_ALGO_MD5       1
57 #define DIGEST_ALGO_SHA1      2
58 #define DIGEST_ALGO_RMD160    3
59 /* 4, 5, 6, and 7 are reserved */
60 #define DIGEST_ALGO_SHA256    8
61 #define DIGEST_ALGO_SHA384    9
62 #define DIGEST_ALGO_SHA512   10
63
64 #define COMPRESS_ALGO_NONE   0
65 #define COMPRESS_ALGO_ZIP    1
66 #define COMPRESS_ALGO_ZLIB   2
67 #define COMPRESS_ALGO_BZIP2  3
68
69 #define is_RSA(a)     ((a)==PUBKEY_ALGO_RSA || (a)==PUBKEY_ALGO_RSA_E \
70                        || (a)==PUBKEY_ALGO_RSA_S )
71 #define is_ELGAMAL(a) ((a)==PUBKEY_ALGO_ELGAMAL_E)
72 #define is_DSA(a)     ((a)==PUBKEY_ALGO_DSA)
73
74 typedef struct
75 {
76   int algo;
77   int keylen;
78   int algo_info_printed;
79   int use_mdc;
80   int symmetric;
81   byte key[32]; /* this is the largest used keylen (256 bit) */
82 } DEK;
83
84 struct cipher_handle_s;
85 typedef struct cipher_handle_s *CIPHER_HANDLE;
86
87
88 #define CIPHER_MODE_ECB       1
89 #define CIPHER_MODE_CFB       2
90 #define CIPHER_MODE_PHILS_CFB 3
91 #define CIPHER_MODE_AUTO_CFB  4
92 #define CIPHER_MODE_DUMMY     5  /* used with algo DUMMY for no encryption */
93 #define CIPHER_MODE_CBC       6
94
95 struct md_digest_list_s;
96
97 struct gcry_md_context {
98     int  secure;
99     FILE  *debug;
100     int finalized;
101     struct md_digest_list_s *list;
102     int  bufcount;
103     int  bufsize;
104     byte buffer[1];
105 };
106
107 typedef struct gcry_md_context *MD_HANDLE;
108
109 #ifndef EXTERN_UNLESS_MAIN_MODULE
110 #if defined (__riscos__) && !defined (INCLUDED_BY_MAIN_MODULE)
111 #define EXTERN_UNLESS_MAIN_MODULE extern
112 #else
113 #define EXTERN_UNLESS_MAIN_MODULE 
114 #endif
115 #endif
116 EXTERN_UNLESS_MAIN_MODULE int g10c_debug_mode;
117 EXTERN_UNLESS_MAIN_MODULE int g10_opt_verbose;
118 EXTERN_UNLESS_MAIN_MODULE const char *g10_opt_homedir;
119
120
121 /*-- dynload.c --*/
122 void register_cipher_extension( const char *mainpgm, const char *fname );
123
124 /*-- md.c --*/
125 int string_to_digest_algo( const char *string );
126 const char * digest_algo_to_string( int algo );
127 int check_digest_algo( int algo );
128 MD_HANDLE md_open( int algo, int secure );
129 void md_enable( MD_HANDLE hd, int algo );
130 MD_HANDLE md_copy( MD_HANDLE a );
131 void md_reset( MD_HANDLE a );
132 void md_close(MD_HANDLE a);
133 void md_write( MD_HANDLE a, const byte *inbuf, size_t inlen);
134 void md_final(MD_HANDLE a);
135 byte *md_read( MD_HANDLE a, int algo );
136 int md_digest( MD_HANDLE a, int algo, byte *buffer, int buflen );
137 int md_get_algo( MD_HANDLE a );
138 int md_algo_present( MD_HANDLE a, int algo );
139 int md_digest_length( int algo );
140 const byte *md_asn_oid( int algo, size_t *asnlen, size_t *mdlen );
141 void md_start_debug( MD_HANDLE a, const char *suffix );
142 void md_stop_debug( MD_HANDLE a );
143 #define md_is_secure(a) ((a)->secure)
144 #define md_putc(h,c)  \
145             do {                                            \
146                 if( (h)->bufcount == (h)->bufsize )         \
147                     md_write( (h), NULL, 0 );               \
148                 (h)->buffer[(h)->bufcount++] = (c) & 0xff;  \
149             } while(0)
150
151 void rmd160_hash_buffer (char *outbuf, const char *buffer, size_t length);
152
153
154 /*-- cipher.c --*/
155 int string_to_cipher_algo( const char *string );
156 const char * cipher_algo_to_string( int algo );
157 void disable_cipher_algo( int algo );
158 int check_cipher_algo( int algo );
159 unsigned cipher_get_keylen( int algo );
160 unsigned cipher_get_blocksize( int algo );
161 CIPHER_HANDLE cipher_open( int algo, int mode, int secure );
162 void cipher_close( CIPHER_HANDLE c );
163 int  cipher_setkey( CIPHER_HANDLE c, byte *key, unsigned keylen );
164 void cipher_setiv( CIPHER_HANDLE c, const byte *iv, unsigned ivlen );
165 void cipher_encrypt( CIPHER_HANDLE c, byte *out, byte *in, unsigned nbytes );
166 void cipher_decrypt( CIPHER_HANDLE c, byte *out, byte *in, unsigned nbytes );
167 void cipher_sync( CIPHER_HANDLE c );
168
169 /*-- pubkey.c --*/
170 #define PUBKEY_MAX_NPKEY  4
171 #define PUBKEY_MAX_NSKEY  6
172 #define PUBKEY_MAX_NSIG   2
173 #define PUBKEY_MAX_NENC   2
174
175 int string_to_pubkey_algo( const char *string );
176 const char * pubkey_algo_to_string( int algo );
177 void disable_pubkey_algo( int algo );
178 int check_pubkey_algo( int algo );
179 int check_pubkey_algo2( int algo, unsigned use );
180 int pubkey_get_npkey( int algo );
181 int pubkey_get_nskey( int algo );
182 int pubkey_get_nsig( int algo );
183 int pubkey_get_nenc( int algo );
184 unsigned pubkey_nbits( int algo, MPI *pkey );
185 int pubkey_generate( int algo, unsigned nbits, MPI *skey, MPI **retfactors );
186 int pubkey_check_secret_key( int algo, MPI *skey );
187 int pubkey_encrypt( int algo, MPI *resarr, MPI data, MPI *pkey );
188 int pubkey_decrypt( int algo, MPI *result, MPI *data, MPI *skey );
189 int pubkey_sign( int algo, MPI *resarr, MPI hash, MPI *skey );
190 int pubkey_verify( int algo, MPI hash, MPI *data, MPI *pkey );
191
192 /*-- smallprime.c --*/
193 extern ushort small_prime_numbers[];
194
195 /*-- primegen.c --*/
196 void register_primegen_progress ( void (*cb)( void *, int), void *cb_data );
197 MPI generate_secret_prime( unsigned nbits );
198 MPI generate_public_prime( unsigned nbits );
199 MPI generate_elg_prime( int mode, unsigned pbits, unsigned qbits,
200                                            MPI g, MPI **factors );
201
202 /*-- elsewhere --*/
203 void register_pk_dsa_progress ( void (*cb)( void *, int), void *cb_data );
204 void register_pk_elg_progress ( void (*cb)( void *, int), void *cb_data );
205
206 #endif /*G10_CIPHER_H*/