Switched to GPLv3.
[gnupg.git] / include / cipher.h
1 /* cipher.h
2  * Copyright (C) 1998, 1999, 2000, 2001, 2003, 2004, 2005, 2006,
3  *               2007 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 3 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, see <http://www.gnu.org/licenses/>.
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 /* 5 & 6 are reserved */
35 #define CIPHER_ALGO_AES          7
36 #define CIPHER_ALGO_AES192       8
37 #define CIPHER_ALGO_AES256       9
38 #define CIPHER_ALGO_TWOFISH     10  /* twofish 256 bit */
39 #define CIPHER_ALGO_CAMELLIA    11  /* camellia 256 bit */
40
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 #define DIGEST_ALGO_SHA224   11
64
65 #define COMPRESS_ALGO_NONE   0
66 #define COMPRESS_ALGO_ZIP    1
67 #define COMPRESS_ALGO_ZLIB   2
68 #define COMPRESS_ALGO_BZIP2  3
69
70 #define is_RSA(a)     ((a)==PUBKEY_ALGO_RSA || (a)==PUBKEY_ALGO_RSA_E \
71                        || (a)==PUBKEY_ALGO_RSA_S )
72 #define is_ELGAMAL(a) ((a)==PUBKEY_ALGO_ELGAMAL_E)
73 #define is_DSA(a)     ((a)==PUBKEY_ALGO_DSA)
74
75 typedef struct
76 {
77   int algo;
78   int keylen;
79   int algo_info_printed;
80   int use_mdc;
81   int symmetric;
82   byte key[32]; /* this is the largest used keylen (256 bit) */
83 } DEK;
84
85 struct cipher_handle_s;
86 typedef struct cipher_handle_s *CIPHER_HANDLE;
87
88
89 #define CIPHER_MODE_ECB       1
90 #define CIPHER_MODE_CFB       2
91 #define CIPHER_MODE_PHILS_CFB 3
92 #define CIPHER_MODE_AUTO_CFB  4
93 #define CIPHER_MODE_DUMMY     5  /* used with algo DUMMY for no encryption */
94 #define CIPHER_MODE_CBC       6
95
96 struct md_digest_list_s;
97
98 struct gcry_md_context {
99     int  secure;
100     FILE  *debug;
101     int finalized;
102     struct md_digest_list_s *list;
103     int  bufcount;
104     int  bufsize;
105     byte buffer[1];
106 };
107
108 typedef struct gcry_md_context *MD_HANDLE;
109
110 #ifndef EXTERN_UNLESS_MAIN_MODULE
111 #if defined (__riscos__) && !defined (INCLUDED_BY_MAIN_MODULE)
112 #define EXTERN_UNLESS_MAIN_MODULE extern
113 #else
114 #define EXTERN_UNLESS_MAIN_MODULE 
115 #endif
116 #endif
117 EXTERN_UNLESS_MAIN_MODULE int g10c_debug_mode;
118 EXTERN_UNLESS_MAIN_MODULE int g10_opt_verbose;
119 EXTERN_UNLESS_MAIN_MODULE const char *g10_opt_homedir;
120
121
122 /*-- dynload.c --*/
123 void register_cipher_extension( const char *mainpgm, const char *fname );
124
125 /*-- md.c --*/
126 int string_to_digest_algo( const char *string );
127 const char * digest_algo_to_string( int algo );
128 int check_digest_algo( int algo );
129 MD_HANDLE md_open( int algo, int secure );
130 void md_enable( MD_HANDLE hd, int algo );
131 MD_HANDLE md_copy( MD_HANDLE a );
132 void md_reset( MD_HANDLE a );
133 void md_close(MD_HANDLE a);
134 void md_write( MD_HANDLE a, const byte *inbuf, size_t inlen);
135 void md_final(MD_HANDLE a);
136 byte *md_read( MD_HANDLE a, int algo );
137 int md_digest( MD_HANDLE a, int algo, byte *buffer, int buflen );
138 int md_get_algo( MD_HANDLE a );
139 int md_algo_present( MD_HANDLE a, int algo );
140 int md_digest_length( int algo );
141 const byte *md_asn_oid( int algo, size_t *asnlen, size_t *mdlen );
142 void md_start_debug( MD_HANDLE a, const char *suffix );
143 void md_stop_debug( MD_HANDLE a );
144 #define md_is_secure(a) ((a)->secure)
145 #define md_putc(h,c)  \
146             do {                                            \
147                 if( (h)->bufcount == (h)->bufsize )         \
148                     md_write( (h), NULL, 0 );               \
149                 (h)->buffer[(h)->bufcount++] = (c) & 0xff;  \
150             } while(0)
151
152 void rmd160_hash_buffer (char *outbuf, const char *buffer, size_t length);
153
154
155 /*-- cipher.c --*/
156 int string_to_cipher_algo( const char *string );
157 const char * cipher_algo_to_string( int algo );
158 void disable_cipher_algo( int algo );
159 int check_cipher_algo( int algo );
160 unsigned cipher_get_keylen( int algo );
161 unsigned cipher_get_blocksize( int algo );
162 CIPHER_HANDLE cipher_open( int algo, int mode, int secure );
163 void cipher_close( CIPHER_HANDLE c );
164 int  cipher_setkey( CIPHER_HANDLE c, byte *key, unsigned keylen );
165 void cipher_setiv( CIPHER_HANDLE c, const byte *iv, unsigned ivlen );
166 void cipher_encrypt( CIPHER_HANDLE c, byte *out, byte *in, unsigned nbytes );
167 void cipher_decrypt( CIPHER_HANDLE c, byte *out, byte *in, unsigned nbytes );
168 void cipher_sync( CIPHER_HANDLE c );
169
170 /*-- pubkey.c --*/
171 #define PUBKEY_MAX_NPKEY  4
172 #define PUBKEY_MAX_NSKEY  6
173 #define PUBKEY_MAX_NSIG   2
174 #define PUBKEY_MAX_NENC   2
175
176 int string_to_pubkey_algo( const char *string );
177 const char * pubkey_algo_to_string( int algo );
178 void disable_pubkey_algo( int algo );
179 int check_pubkey_algo( int algo );
180 int check_pubkey_algo2( int algo, unsigned use );
181 int pubkey_get_npkey( int algo );
182 int pubkey_get_nskey( int algo );
183 int pubkey_get_nsig( int algo );
184 int pubkey_get_nenc( int algo );
185 unsigned pubkey_nbits( int algo, MPI *pkey );
186 int pubkey_generate( int algo, unsigned nbits, MPI *skey, MPI **retfactors );
187 int dsa2_generate( int algo, unsigned nbits, unsigned qbits,
188                    MPI *skey, MPI **retfactors );
189 int pubkey_check_secret_key( int algo, MPI *skey );
190 int pubkey_encrypt( int algo, MPI *resarr, MPI data, MPI *pkey );
191 int pubkey_decrypt( int algo, MPI *result, MPI *data, MPI *skey );
192 int pubkey_sign( int algo, MPI *resarr, MPI hash, MPI *skey );
193 int pubkey_verify( int algo, MPI hash, MPI *data, MPI *pkey );
194
195 /*-- smallprime.c --*/
196 extern ushort small_prime_numbers[];
197
198 /*-- primegen.c --*/
199 void register_primegen_progress ( void (*cb)( void *, int), void *cb_data );
200 MPI generate_secret_prime( unsigned nbits );
201 MPI generate_public_prime( unsigned nbits );
202 MPI generate_elg_prime( int mode, unsigned pbits, unsigned qbits,
203                                            MPI g, MPI **factors );
204
205 /*-- elsewhere --*/
206 void register_pk_dsa_progress ( void (*cb)( void *, int), void *cb_data );
207 void register_pk_elg_progress ( void (*cb)( void *, int), void *cb_data );
208
209 #endif /*G10_CIPHER_H*/