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