gpg: Disable an MD5 workaround for pgp2 by default.
[gnupg.git] / g10 / main.h
1 /* main.h
2  * Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
3  *               2008, 2009, 2010 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_MAIN_H
21 #define G10_MAIN_H
22
23 #include "types.h"
24 #include "iobuf.h"
25 #include "keydb.h"
26 #include "util.h"
27
28 /* It could be argued that the default cipher should be 3DES rather
29    than CAST5, and the default compression should be 0
30    (i.e. uncompressed) rather than 1 (zip).  However, the real world
31    issues of speed and size come into play here. */
32
33 #define DEFAULT_CIPHER_ALGO     CIPHER_ALGO_CAST5
34 #define DEFAULT_DIGEST_ALGO     DIGEST_ALGO_SHA1
35 #define DEFAULT_S2K_DIGEST_ALGO DIGEST_ALGO_SHA1
36 #ifdef HAVE_ZIP
37 # define DEFAULT_COMPRESS_ALGO   COMPRESS_ALGO_ZIP
38 #else
39 # define DEFAULT_COMPRESS_ALGO   COMPRESS_ALGO_NONE
40 #endif
41
42
43 #define S2K_DIGEST_ALGO (opt.s2k_digest_algo?opt.s2k_digest_algo:DEFAULT_S2K_DIGEST_ALGO)
44
45
46 /* Various data objects.  */
47
48 typedef struct
49 {
50   int header_okay;
51   PK_LIST pk_list;
52   DEK *symkey_dek;
53   STRING2KEY *symkey_s2k;
54   cipher_filter_context_t cfx;
55 } encrypt_filter_context_t;
56
57
58 struct groupitem
59 {
60   char *name;
61   strlist_t values;
62   struct groupitem *next;
63 };
64
65
66 /*-- gpg.c --*/
67 extern int g10_errors_seen;
68
69 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 5 )
70   void g10_exit(int rc) __attribute__ ((noreturn));
71 #else
72   void g10_exit(int rc);
73 #endif
74 void print_pubkey_algo_note (pubkey_algo_t algo);
75 void print_cipher_algo_note (cipher_algo_t algo);
76 void print_digest_algo_note (digest_algo_t algo);
77 void print_md5_rejected_note (void);
78
79 /*-- armor.c --*/
80 char *make_radix64_string( const byte *data, size_t len );
81
82 /*-- misc.c --*/
83 void trap_unaligned(void);
84 int disable_core_dumps(void);
85 void register_secured_file (const char *fname);
86 void unregister_secured_file (const char *fname);
87 int  is_secured_file (int fd);
88 int  is_secured_filename (const char *fname);
89 u16 checksum_u16( unsigned n );
90 u16 checksum( byte *p, unsigned n );
91 u16 checksum_mpi( gcry_mpi_t a );
92 u32 buffer_to_u32( const byte *buffer );
93 const byte *get_session_marker( size_t *rlen );
94
95 enum gcry_cipher_algos map_cipher_openpgp_to_gcry (cipher_algo_t algo);
96 #define openpgp_cipher_open(_a,_b,_c,_d) \
97   gcry_cipher_open((_a),map_cipher_openpgp_to_gcry((_b)),(_c),(_d))
98 #define openpgp_cipher_get_algo_keylen(_a) \
99   gcry_cipher_get_algo_keylen(map_cipher_openpgp_to_gcry((_a)))
100 #define openpgp_cipher_get_algo_blklen(_a) \
101   gcry_cipher_get_algo_blklen(map_cipher_openpgp_to_gcry((_a)))
102 int openpgp_cipher_blocklen (cipher_algo_t algo);
103 int openpgp_cipher_test_algo(cipher_algo_t algo);
104 const char *openpgp_cipher_algo_name (cipher_algo_t algo);
105
106 pubkey_algo_t map_pk_gcry_to_openpgp (enum gcry_pk_algos algo);
107 int openpgp_pk_test_algo (pubkey_algo_t algo);
108 int openpgp_pk_test_algo2 (pubkey_algo_t algo, unsigned int use);
109 int openpgp_pk_algo_usage ( int algo );
110 const char *openpgp_pk_algo_name (pubkey_algo_t algo);
111
112 enum gcry_md_algos map_md_openpgp_to_gcry (digest_algo_t algo);
113 int openpgp_md_test_algo (digest_algo_t algo);
114 const char *openpgp_md_algo_name (int algo);
115
116 struct expando_args
117 {
118   PKT_public_key *pk;
119   PKT_public_key *pksk;
120   byte imagetype;
121   int validity_info;
122   const char *validity_string;
123   const byte *namehash;
124 };
125
126 char *pct_expando(const char *string,struct expando_args *args);
127 void deprecated_warning(const char *configname,unsigned int configlineno,
128                         const char *option,const char *repl1,const char *repl2);
129 void deprecated_command (const char *name);
130 void obsolete_option (const char *configname, unsigned int configlineno,
131                       const char *name);
132
133 int string_to_cipher_algo (const char *string);
134 int string_to_digest_algo (const char *string);
135
136 const char *compress_algo_to_string(int algo);
137 int string_to_compress_algo(const char *string);
138 int check_compress_algo(int algo);
139 int default_cipher_algo(void);
140 int default_compress_algo(void);
141 const char *compliance_option_string(void);
142 void compliance_failure(void);
143
144 struct parse_options
145 {
146   char *name;
147   unsigned int bit;
148   char **value;
149   char *help;
150 };
151
152 char *optsep(char **stringp);
153 char *argsplit(char *string);
154 int parse_options(char *str,unsigned int *options,
155                   struct parse_options *opts,int noisy);
156 int has_invalid_email_chars (const char *s);
157 int is_valid_mailbox (const char *name);
158 int is_valid_user_id (const char *uid);
159 const char *get_libexecdir (void);
160 int path_access(const char *file,int mode);
161
162 int pubkey_get_npkey (pubkey_algo_t algo);
163 int pubkey_get_nskey (pubkey_algo_t algo);
164 int pubkey_get_nsig (pubkey_algo_t algo);
165 int pubkey_get_nenc (pubkey_algo_t algo);
166
167 /* Temporary helpers. */
168 unsigned int pubkey_nbits( int algo, gcry_mpi_t *pkey );
169 int mpi_print (estream_t stream, gcry_mpi_t a, int mode);
170 unsigned int ecdsa_qbits_from_Q (unsigned int qbits);
171
172
173 /*-- status.c --*/
174 void set_status_fd ( int fd );
175 int  is_status_enabled ( void );
176 void write_status ( int no );
177 void write_status_error (const char *where, gpg_error_t err);
178 void write_status_errcode (const char *where, int errcode);
179 void write_status_text ( int no, const char *text );
180 void write_status_strings (int no, const char *text,
181                            ...) GNUPG_GCC_A_SENTINEL(0);
182 void write_status_buffer ( int no,
183                            const char *buffer, size_t len, int wrap );
184 void write_status_text_and_buffer ( int no, const char *text,
185                                     const char *buffer, size_t len, int wrap );
186
187 void write_status_begin_signing (gcry_md_hd_t md);
188
189
190 int cpr_enabled(void);
191 char *cpr_get( const char *keyword, const char *prompt );
192 char *cpr_get_no_help( const char *keyword, const char *prompt );
193 char *cpr_get_utf8( const char *keyword, const char *prompt );
194 char *cpr_get_hidden( const char *keyword, const char *prompt );
195 void cpr_kill_prompt(void);
196 int  cpr_get_answer_is_yes_def (const char *keyword, const char *prompt,
197                                 int def_yes);
198 int  cpr_get_answer_is_yes( const char *keyword, const char *prompt );
199 int  cpr_get_answer_yes_no_quit( const char *keyword, const char *prompt );
200 int  cpr_get_answer_okay_cancel (const char *keyword,
201                                  const char *prompt,
202                                  int def_answer);
203
204 /*-- helptext.c --*/
205 void display_online_help( const char *keyword );
206
207 /*-- encode.c --*/
208 int setup_symkey (STRING2KEY **symkey_s2k,DEK **symkey_dek);
209 int encrypt_symmetric (const char *filename );
210 int encrypt_store (const char *filename );
211 int encrypt_crypt (ctrl_t ctrl, int filefd, const char *filename,
212                    strlist_t remusr, int use_symkey, pk_list_t provided_keys,
213                    int outputfd);
214 void encrypt_crypt_files (ctrl_t ctrl,
215                           int nfiles, char **files, strlist_t remusr);
216 int encrypt_filter (void *opaque, int control,
217                     iobuf_t a, byte *buf, size_t *ret_len);
218
219
220 /*-- sign.c --*/
221 int complete_sig (PKT_signature *sig, PKT_public_key *pksk, gcry_md_hd_t md,
222                   const char *cache_nonce);
223 int sign_file (ctrl_t ctrl, strlist_t filenames, int detached, strlist_t locusr,
224                int do_encrypt, strlist_t remusr, const char *outfile );
225 int clearsign_file( const char *fname, strlist_t locusr, const char *outfile );
226 int sign_symencrypt_file (const char *fname, strlist_t locusr);
227
228 /*-- sig-check.c --*/
229 int check_revocation_keys (PKT_public_key *pk, PKT_signature *sig);
230 int check_backsig(PKT_public_key *main_pk,PKT_public_key *sub_pk,
231                   PKT_signature *backsig);
232 int check_key_signature( KBNODE root, KBNODE node, int *is_selfsig );
233 int check_key_signature2( KBNODE root, KBNODE node, PKT_public_key *check_pk,
234                           PKT_public_key *ret_pk, int *is_selfsig,
235                           u32 *r_expiredate, int *r_expired );
236
237 /*-- delkey.c --*/
238 gpg_error_t delete_keys (strlist_t names, int secret, int allow_both);
239
240 /*-- keyedit.c --*/
241 void keyedit_menu (ctrl_t ctrl, const char *username, strlist_t locusr,
242                    strlist_t commands, int quiet, int seckey_check );
243 void keyedit_passwd (ctrl_t ctrl, const char *username);
244 void keyedit_quick_sign (ctrl_t ctrl, const char *fpr,
245                          strlist_t uids, strlist_t locusr, int local);
246 void show_basic_key_info (KBNODE keyblock);
247
248 /*-- keygen.c --*/
249 u32 parse_expire_string(const char *string);
250 u32 ask_expire_interval(int object,const char *def_expire);
251 u32 ask_expiredate(void);
252 void quick_generate_keypair (const char *uid);
253 void generate_keypair (ctrl_t ctrl, const char *fname,
254                        const char *card_serialno, int card_backup_key);
255 int keygen_set_std_prefs (const char *string,int personal);
256 PKT_user_id *keygen_get_std_prefs (void);
257 int keygen_add_key_expire( PKT_signature *sig, void *opaque );
258 int keygen_add_std_prefs( PKT_signature *sig, void *opaque );
259 int keygen_upd_std_prefs( PKT_signature *sig, void *opaque );
260 int keygen_add_keyserver_url(PKT_signature *sig, void *opaque);
261 int keygen_add_notations(PKT_signature *sig,void *opaque);
262 int keygen_add_revkey(PKT_signature *sig, void *opaque);
263 gpg_error_t make_backsig (PKT_signature *sig, PKT_public_key *pk,
264                           PKT_public_key *sub_pk, PKT_public_key *sub_psk,
265                           u32 timestamp, const char *cache_nonce);
266 gpg_error_t generate_subkeypair (ctrl_t ctrl, kbnode_t pub_keyblock);
267 #ifdef ENABLE_CARD_SUPPORT
268 gpg_error_t generate_card_subkeypair (kbnode_t pub_keyblock,
269                                       int keyno, const char *serialno);
270 int save_unprotected_key_to_card (PKT_public_key *sk, int keyno);
271 #endif
272
273
274 /*-- openfile.c --*/
275 int overwrite_filep( const char *fname );
276 char *make_outfile_name( const char *iname );
277 char *ask_outfile_name( const char *name, size_t namelen );
278 int open_outfile (int inp_fd, const char *iname, int mode,
279                   int restrictedperm, iobuf_t *a);
280 iobuf_t open_sigfile( const char *iname, progress_filter_context_t *pfx );
281 void try_make_homedir( const char *fname );
282 char *get_openpgp_revocdir (const char *home);
283
284 /*-- seskey.c --*/
285 void make_session_key( DEK *dek );
286 gcry_mpi_t encode_session_key( int openpgp_pk_algo, DEK *dek, unsigned nbits );
287 gcry_mpi_t encode_md_value (PKT_public_key *pk,
288                             gcry_md_hd_t md, int hash_algo );
289
290 /*-- import.c --*/
291 int parse_import_options(char *str,unsigned int *options,int noisy);
292 void import_keys (ctrl_t ctrl, char **fnames, int nnames,
293                   void *stats_hd, unsigned int options);
294 int import_keys_stream (ctrl_t ctrl, iobuf_t inp, void *stats_hd,
295                         unsigned char **fpr,
296                         size_t *fpr_len, unsigned int options);
297 int import_keys_es_stream (ctrl_t ctrl, estream_t fp, void *stats_handle,
298                            unsigned char **fpr, size_t *fpr_len,
299                            unsigned int options);
300 gpg_error_t import_old_secring (ctrl_t ctrl, const char *fname);
301 void *import_new_stats_handle (void);
302 void import_release_stats_handle (void *p);
303 void import_print_stats (void *hd);
304
305 int collapse_uids( KBNODE *keyblock );
306
307
308 /*-- export.c --*/
309 int parse_export_options(char *str,unsigned int *options,int noisy);
310 int export_pubkeys (ctrl_t ctrl, strlist_t users, unsigned int options );
311 int export_pubkeys_stream (ctrl_t ctrl, iobuf_t out, strlist_t users,
312                            kbnode_t *keyblock_out, unsigned int options );
313 gpg_error_t export_pubkey_buffer (ctrl_t ctrl, const char *keyspec,
314                                   unsigned int options,
315                                   kbnode_t *r_keyblock,
316                                   void **r_data, size_t *r_datalen);
317 int export_seckeys (ctrl_t ctrl, strlist_t users);
318 int export_secsubkeys (ctrl_t ctrl, strlist_t users);
319
320 /*-- dearmor.c --*/
321 int dearmor_file( const char *fname );
322 int enarmor_file( const char *fname );
323
324 /*-- revoke.c --*/
325 struct revocation_reason_info;
326 int gen_standard_revoke (PKT_public_key *psk);
327 int gen_revoke( const char *uname );
328 int gen_desig_revoke( const char *uname, strlist_t locusr);
329 int revocation_reason_build_cb( PKT_signature *sig, void *opaque );
330 struct revocation_reason_info *
331                 ask_revocation_reason( int key_rev, int cert_rev, int hint );
332 void release_revocation_reason_info( struct revocation_reason_info *reason );
333
334 /*-- keylist.c --*/
335 void public_key_list (ctrl_t ctrl, strlist_t list, int locate_mode );
336 void secret_key_list (ctrl_t ctrl, strlist_t list );
337 void print_subpackets_colon(PKT_signature *sig);
338 void reorder_keyblock (KBNODE keyblock);
339 void list_keyblock (kbnode_t keyblock, int secret, int has_secret,
340                     int fpr, void *opaque);
341 void print_fingerprint (estream_t fp, PKT_public_key *pk, int mode);
342 void print_revokers (estream_t fp, PKT_public_key *pk);
343 void show_policy_url(PKT_signature *sig,int indent,int mode);
344 void show_keyserver_url(PKT_signature *sig,int indent,int mode);
345 void show_notation(PKT_signature *sig,int indent,int mode,int which);
346 void dump_attribs (const PKT_user_id *uid, PKT_public_key *pk);
347 void set_attrib_fd(int fd);
348 void print_seckey_info (PKT_public_key *pk);
349 void print_pubkey_info (estream_t fp, PKT_public_key *pk);
350 void print_card_key_info (estream_t fp, KBNODE keyblock);
351
352 /*-- verify.c --*/
353 void print_file_status( int status, const char *name, int what );
354 int verify_signatures (ctrl_t ctrl, int nfiles, char **files );
355 int verify_files (ctrl_t ctrl, int nfiles, char **files );
356 int gpg_verify (ctrl_t ctrl, int sig_fd, int data_fd, estream_t out_fp);
357
358 /*-- decrypt.c --*/
359 int decrypt_message (ctrl_t ctrl, const char *filename );
360 gpg_error_t decrypt_message_fd (ctrl_t ctrl, int input_fd, int output_fd);
361 void decrypt_messages (ctrl_t ctrl, int nfiles, char *files[]);
362
363 /*-- plaintext.c --*/
364 int hash_datafiles( gcry_md_hd_t md, gcry_md_hd_t md2,
365                     strlist_t files, const char *sigfilename, int textmode );
366 int hash_datafile_by_fd ( gcry_md_hd_t md, gcry_md_hd_t md2, int data_fd,
367                           int textmode );
368 PKT_plaintext *setup_plaintext_name(const char *filename,IOBUF iobuf);
369
370 /*-- signal.c --*/
371 void init_signals(void);
372 void block_all_signals(void);
373 void unblock_all_signals(void);
374
375 /*-- server.c --*/
376 int gpg_server (ctrl_t);
377 gpg_error_t gpg_proxy_pinentry_notify (ctrl_t ctrl,
378                                        const unsigned char *line);
379
380 #ifdef ENABLE_CARD_SUPPORT
381 /*-- card-util.c --*/
382 void change_pin (int no, int allow_admin);
383 void card_status (estream_t fp, char *serialno, size_t serialnobuflen);
384 void card_edit (ctrl_t ctrl, strlist_t commands);
385 gpg_error_t  card_generate_subkey (KBNODE pub_keyblock);
386 int  card_store_subkey (KBNODE node, int use);
387 #endif
388
389 #define S2K_DECODE_COUNT(_val) ((16ul + ((_val) & 15)) << (((_val) >> 4) + 6))
390
391 /*-- migrate.c --*/
392 void migrate_secring (ctrl_t ctrl);
393
394
395 #endif /*G10_MAIN_H*/