Pth tweaks and improved estream.c
[gnupg.git] / g10 / main.h
1 /* main.h
2  * Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
3  *               2006 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_MAIN_H
23 #define G10_MAIN_H
24
25 #include "types.h"
26 #include "../common/iobuf.h"
27 #include "cipher.h"
28 #include "keydb.h"
29
30 /* It could be argued that the default cipher should be 3DES rather
31    than CAST5, and the default compression should be 0
32    (i.e. uncompressed) rather than 1 (zip).  However, the real world
33    issues of speed and size come into play here. */
34
35 #define DEFAULT_CIPHER_ALGO     CIPHER_ALGO_CAST5
36 #define DEFAULT_DIGEST_ALGO     DIGEST_ALGO_SHA1
37 #define DEFAULT_COMPRESS_ALGO   COMPRESS_ALGO_ZIP
38 #define DEFAULT_S2K_DIGEST_ALGO DIGEST_ALGO_SHA1
39
40 #define S2K_DIGEST_ALGO (opt.s2k_digest_algo?opt.s2k_digest_algo:DEFAULT_S2K_DIGEST_ALGO)
41
42 typedef struct
43 {
44   int header_okay;
45   PK_LIST pk_list;
46   DEK *symkey_dek;
47   STRING2KEY *symkey_s2k;
48   cipher_filter_context_t cfx;
49 } encrypt_filter_context_t;
50
51 struct groupitem
52 {
53   char *name;
54   strlist_t values;
55   struct groupitem *next;
56 };
57
58 /*-- gpg.c --*/
59 extern int g10_errors_seen;
60
61 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 5 )
62   void g10_exit(int rc) __attribute__ ((noreturn));
63 #else
64   void g10_exit(int rc);
65 #endif
66 void print_pubkey_algo_note( int algo );
67 void print_cipher_algo_note( int algo );
68 void print_digest_algo_note( int algo );
69
70 /*-- armor.c --*/
71 char *make_radix64_string( const byte *data, size_t len );
72
73 /*-- misc.c --*/
74 void trap_unaligned(void);
75 int disable_core_dumps(void);
76 void register_secured_file (const char *fname);
77 void unregister_secured_file (const char *fname);
78 int  is_secured_file (int fd);
79 int  is_secured_filename (const char *fname);
80 u16 checksum_u16( unsigned n );
81 u16 checksum( byte *p, unsigned n );
82 u16 checksum_mpi( gcry_mpi_t a );
83 u32 buffer_to_u32( const byte *buffer );
84 const byte *get_session_marker( size_t *rlen );
85 int openpgp_cipher_test_algo( int algo );
86 int openpgp_pk_test_algo( int algo );
87 int openpgp_pk_test_algo2 ( int algo, unsigned int use );
88 int openpgp_pk_algo_usage ( int algo );
89 int openpgp_md_test_algo( int algo );
90
91 #ifdef USE_IDEA
92 void idea_cipher_warn( int show );
93 #else
94 #define idea_cipher_warn(a)
95 #endif
96
97 struct expando_args
98 {
99   PKT_public_key *pk;
100   PKT_secret_key *sk;
101   byte imagetype;
102 };
103
104 char *pct_expando(const char *string,struct expando_args *args);
105 void deprecated_warning(const char *configname,unsigned int configlineno,
106                         const char *option,const char *repl1,const char *repl2);
107 void deprecated_command (const char *name);
108
109 int string_to_cipher_algo (const char *string);
110 int string_to_digest_algo (const char *string);
111
112 const char *compress_algo_to_string(int algo);
113 int string_to_compress_algo(const char *string);
114 int check_compress_algo(int algo);
115 int default_cipher_algo(void);
116 int default_compress_algo(void);
117 const char *compliance_option_string(void);
118 void compliance_failure(void);
119
120 struct parse_options
121 {
122   char *name;
123   unsigned int bit;
124   char **value;
125   char *help;
126 };
127
128 char *optsep(char **stringp);
129 char *argsplit(char *string);
130 int parse_options(char *str,unsigned int *options,
131                   struct parse_options *opts,int noisy);
132 char *unescape_percent_string (const unsigned char *s);
133 int has_invalid_email_chars (const char *s);
134 int is_valid_mailbox (const char *name);
135 const char *get_libexecdir (void);
136 int path_access(const char *file,int mode);
137
138 /* Temporary helpers. */
139 int pubkey_get_npkey( int algo );
140 int pubkey_get_nskey( int algo );
141 int pubkey_get_nsig( int algo );
142 int pubkey_get_nenc( int algo );
143 unsigned int pubkey_nbits( int algo, gcry_mpi_t *pkey );
144 int mpi_print( FILE *fp, gcry_mpi_t a, int mode );
145
146
147 /*-- helptext.c --*/
148 void display_online_help( const char *keyword );
149
150 /*-- encode.c --*/
151 int setup_symkey(STRING2KEY **symkey_s2k,DEK **symkey_dek);
152 int encode_symmetric( const char *filename );
153 int encode_store( const char *filename );
154 int encode_crypt( const char *filename, strlist_t remusr, int use_symkey );
155 void encode_crypt_files(int nfiles, char **files, strlist_t remusr);
156 int encrypt_filter( void *opaque, int control,
157                     iobuf_t a, byte *buf, size_t *ret_len);
158
159
160 /*-- sign.c --*/
161 int complete_sig( PKT_signature *sig, PKT_secret_key *sk, gcry_md_hd_t md );
162 int sign_file( strlist_t filenames, int detached, strlist_t locusr,
163                int do_encrypt, strlist_t remusr, const char *outfile );
164 int clearsign_file( const char *fname, strlist_t locusr, const char *outfile );
165 int sign_symencrypt_file (const char *fname, strlist_t locusr);
166
167 /*-- sig-check.c --*/
168 int check_revocation_keys (PKT_public_key *pk, PKT_signature *sig);
169 int check_backsig(PKT_public_key *main_pk,PKT_public_key *sub_pk,
170                   PKT_signature *backsig);
171 int check_key_signature( KBNODE root, KBNODE node, int *is_selfsig );
172 int check_key_signature2( KBNODE root, KBNODE node, PKT_public_key *check_pk,
173                           PKT_public_key *ret_pk, int *is_selfsig,
174                           u32 *r_expiredate, int *r_expired );
175
176 /*-- delkey.c --*/
177 int delete_keys( strlist_t names, int secret, int allow_both );
178
179 /*-- keyedit.c --*/
180 void keyedit_menu( const char *username, strlist_t locusr,
181                    strlist_t commands, int quiet, int seckey_check );
182 void show_basic_key_info (KBNODE keyblock);
183
184 /*-- keygen.c --*/
185 u32 parse_expire_string(const char *string);
186 u32 ask_expire_interval(int object,const char *def_expire);
187 u32 ask_expiredate(void);
188 void generate_keypair( const char *fname, const char *card_serialno,
189                        const char *backup_encryption_dir );
190 int keygen_set_std_prefs (const char *string,int personal);
191 PKT_user_id *keygen_get_std_prefs (void);
192 int keygen_add_key_expire( PKT_signature *sig, void *opaque );
193 int keygen_add_std_prefs( PKT_signature *sig, void *opaque );
194 int keygen_upd_std_prefs( PKT_signature *sig, void *opaque );
195 int keygen_add_keyserver_url(PKT_signature *sig, void *opaque);
196 int keygen_add_notations(PKT_signature *sig,void *opaque);
197 int keygen_add_revkey(PKT_signature *sig, void *opaque);
198 int make_backsig(PKT_signature *sig,PKT_public_key *pk,
199                  PKT_public_key *sub_pk,PKT_secret_key *sub_sk);
200 int generate_subkeypair( KBNODE pub_keyblock, KBNODE sec_keyblock );
201 #ifdef ENABLE_CARD_SUPPORT
202 int generate_card_subkeypair (KBNODE pub_keyblock, KBNODE sec_keyblock,
203                               int keyno, const char *serialno);
204 int save_unprotected_key_to_card (PKT_secret_key *sk, int keyno);
205 #endif
206
207 /*-- openfile.c --*/
208 int overwrite_filep( const char *fname );
209 char *make_outfile_name( const char *iname );
210 char *ask_outfile_name( const char *name, size_t namelen );
211 int   open_outfile( const char *iname, int mode, iobuf_t *a );
212 iobuf_t open_sigfile( const char *iname, progress_filter_context_t *pfx );
213 void try_make_homedir( const char *fname );
214
215 /*-- seskey.c --*/
216 void make_session_key( DEK *dek );
217 gcry_mpi_t encode_session_key( DEK *dek, unsigned nbits );
218 gcry_mpi_t encode_md_value( PKT_public_key *pk, PKT_secret_key *sk,
219                             gcry_md_hd_t md, int hash_algo );
220
221 /*-- import.c --*/
222 int parse_import_options(char *str,unsigned int *options,int noisy);
223 void import_keys( char **fnames, int nnames,
224                   void *stats_hd, unsigned int options );
225 int import_keys_stream( iobuf_t inp,void *stats_hd,unsigned char **fpr,
226                         size_t *fpr_len,unsigned int options );
227 void *import_new_stats_handle (void);
228 void import_release_stats_handle (void *p);
229 void import_print_stats (void *hd);
230
231 int collapse_uids( KBNODE *keyblock );
232
233 int auto_create_card_key_stub ( const char *serialnostr, 
234                                 const unsigned char *fpr1,
235                                 const unsigned char *fpr2,
236                                 const unsigned char *fpr3);
237
238 /*-- export.c --*/
239 int parse_export_options(char *str,unsigned int *options,int noisy);
240 int export_pubkeys( strlist_t users, unsigned int options );
241 int export_pubkeys_stream( iobuf_t out, strlist_t users,
242                            KBNODE *keyblock_out, unsigned int options );
243 int export_seckeys( strlist_t users );
244 int export_secsubkeys( strlist_t users );
245
246 /* dearmor.c --*/
247 int dearmor_file( const char *fname );
248 int enarmor_file( const char *fname );
249
250 /*-- revoke.c --*/
251 struct revocation_reason_info;
252 int gen_revoke( const char *uname );
253 int gen_desig_revoke( const char *uname, strlist_t locusr);
254 int revocation_reason_build_cb( PKT_signature *sig, void *opaque );
255 struct revocation_reason_info *
256                 ask_revocation_reason( int key_rev, int cert_rev, int hint );
257 void release_revocation_reason_info( struct revocation_reason_info *reason );
258
259 /*-- keylist.c --*/
260 void public_key_list( strlist_t list );
261 void secret_key_list( strlist_t list );
262 void print_subpackets_colon(PKT_signature *sig);
263 void reorder_keyblock (KBNODE keyblock);
264 void list_keyblock( KBNODE keyblock, int secret, int fpr, void *opaque );
265 void print_fingerprint (PKT_public_key *pk, PKT_secret_key *sk, int mode);
266 void print_revokers(PKT_public_key *pk);
267 void show_policy_url(PKT_signature *sig,int indent,int mode);
268 void show_keyserver_url(PKT_signature *sig,int indent,int mode);
269 void show_notation(PKT_signature *sig,int indent,int mode,int which);
270 void dump_attribs(const PKT_user_id *uid,
271                   PKT_public_key *pk,PKT_secret_key *sk);
272 void set_attrib_fd(int fd);
273 void print_seckey_info (PKT_secret_key *sk);
274 void print_pubkey_info (FILE *fp, PKT_public_key *pk);
275 void print_card_key_info (FILE *fp, KBNODE keyblock);
276
277 /*-- verify.c --*/
278 void print_file_status( int status, const char *name, int what );
279 int verify_signatures( int nfiles, char **files );
280 int verify_files( int nfiles, char **files );
281
282 /*-- decrypt.c --*/
283 int decrypt_message( const char *filename );
284 void decrypt_messages(int nfiles, char *files[]);
285
286 /*-- plaintext.c --*/
287 int hash_datafiles( gcry_md_hd_t md, gcry_md_hd_t md2,
288                     strlist_t files, const char *sigfilename, int textmode );
289 PKT_plaintext *setup_plaintext_name(const char *filename,IOBUF iobuf);
290
291 /*-- signal.c --*/
292 void init_signals(void);
293 void pause_on_sigusr( int which );
294 void block_all_signals(void);
295 void unblock_all_signals(void);
296
297
298 #ifdef ENABLE_CARD_SUPPORT
299 /*-- card-util.c --*/
300 void change_pin (int no, int allow_admin);
301 void card_status (FILE *fp, char *serialno, size_t serialnobuflen);
302 void card_edit (strlist_t commands);
303 int  card_generate_subkey (KBNODE pub_keyblock, KBNODE sec_keyblock);
304 int  card_store_subkey (KBNODE node, int use);
305 #endif
306
307 #define S2K_DECODE_COUNT(_val) ((16ul + ((_val) & 15)) << (((_val) >> 4) + 6))
308
309 #endif /*G10_MAIN_H*/