common: Fix -Wswitch warning.
[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 <https://www.gnu.org/licenses/>.
19  */
20 #ifndef G10_MAIN_H
21 #define G10_MAIN_H
22
23 #include "../common/types.h"
24 #include "../common/iobuf.h"
25 #include "keydb.h"
26 #include "../common/util.h"
27
28 /* It could be argued that the default cipher should be 3DES rather
29    than AES128, 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 #if GPG_USE_AES128
34 # define DEFAULT_CIPHER_ALGO     CIPHER_ALGO_AES
35 #elif GPG_USE_CAST5
36 # define DEFAULT_CIPHER_ALGO     CIPHER_ALGO_CAST5
37 #else
38 # define DEFAULT_CIPHER_ALGO     CIPHER_ALGO_3DES
39 #endif
40
41 #define DEFAULT_DIGEST_ALGO     ((GNUPG)? DIGEST_ALGO_SHA256:DIGEST_ALGO_SHA1)
42 #define DEFAULT_S2K_DIGEST_ALGO DIGEST_ALGO_SHA1
43 #ifdef HAVE_ZIP
44 # define DEFAULT_COMPRESS_ALGO   COMPRESS_ALGO_ZIP
45 #else
46 # define DEFAULT_COMPRESS_ALGO   COMPRESS_ALGO_NONE
47 #endif
48
49
50 #define S2K_DIGEST_ALGO (opt.s2k_digest_algo?opt.s2k_digest_algo:DEFAULT_S2K_DIGEST_ALGO)
51
52
53 /* Various data objects.  */
54
55 typedef struct
56 {
57   ctrl_t ctrl;
58   int header_okay;
59   PK_LIST pk_list;
60   DEK *symkey_dek;
61   STRING2KEY *symkey_s2k;
62   cipher_filter_context_t cfx;
63 } encrypt_filter_context_t;
64
65
66 struct groupitem
67 {
68   char *name;
69   strlist_t values;
70   struct groupitem *next;
71 };
72
73 struct weakhash
74 {
75   enum gcry_md_algos algo;
76   int rejection_shown;
77   struct weakhash *next;
78 };
79
80
81 /*-- gpg.c --*/
82 extern int g10_errors_seen;
83
84 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 5 )
85   void g10_exit(int rc) __attribute__ ((noreturn));
86 #else
87   void g10_exit(int rc);
88 #endif
89 void print_pubkey_algo_note (pubkey_algo_t algo);
90 void print_cipher_algo_note (cipher_algo_t algo);
91 void print_digest_algo_note (digest_algo_t algo);
92 void print_digest_rejected_note (enum gcry_md_algos algo);
93 void print_reported_error (gpg_error_t err, gpg_err_code_t skip_if_ec);
94 void print_further_info (const char *format, ...) GPGRT_ATTR_PRINTF(1,2);
95 void additional_weak_digest (const char* digestname);
96
97 /*-- armor.c --*/
98 char *make_radix64_string( const byte *data, size_t len );
99
100 /*-- misc.c --*/
101 void trap_unaligned(void);
102 void register_secured_file (const char *fname);
103 void unregister_secured_file (const char *fname);
104 int  is_secured_file (int fd);
105 int  is_secured_filename (const char *fname);
106 u16 checksum_u16( unsigned n );
107 u16 checksum( byte *p, unsigned n );
108 u16 checksum_mpi( gcry_mpi_t a );
109 u32 buffer_to_u32( const byte *buffer );
110 const byte *get_session_marker( size_t *rlen );
111
112 enum gcry_cipher_algos map_cipher_openpgp_to_gcry (cipher_algo_t algo);
113 #define openpgp_cipher_open(_a,_b,_c,_d) \
114   gcry_cipher_open((_a),map_cipher_openpgp_to_gcry((_b)),(_c),(_d))
115 #define openpgp_cipher_get_algo_keylen(_a) \
116   gcry_cipher_get_algo_keylen(map_cipher_openpgp_to_gcry((_a)))
117 #define openpgp_cipher_get_algo_blklen(_a) \
118   gcry_cipher_get_algo_blklen(map_cipher_openpgp_to_gcry((_a)))
119 int openpgp_cipher_blocklen (cipher_algo_t algo);
120 int openpgp_cipher_test_algo(cipher_algo_t algo);
121 const char *openpgp_cipher_algo_name (cipher_algo_t algo);
122
123 pubkey_algo_t map_pk_gcry_to_openpgp (enum gcry_pk_algos algo);
124 int openpgp_pk_test_algo (pubkey_algo_t algo);
125 int openpgp_pk_test_algo2 (pubkey_algo_t algo, unsigned int use);
126 int openpgp_pk_algo_usage ( int algo );
127 const char *openpgp_pk_algo_name (pubkey_algo_t algo);
128
129 enum gcry_md_algos map_md_openpgp_to_gcry (digest_algo_t algo);
130 int openpgp_md_test_algo (digest_algo_t algo);
131 const char *openpgp_md_algo_name (int algo);
132
133 struct expando_args
134 {
135   PKT_public_key *pk;
136   PKT_public_key *pksk;
137   byte imagetype;
138   int validity_info;
139   const char *validity_string;
140   const byte *namehash;
141 };
142
143 char *pct_expando(const char *string,struct expando_args *args);
144 void deprecated_warning(const char *configname,unsigned int configlineno,
145                         const char *option,const char *repl1,const char *repl2);
146 void deprecated_command (const char *name);
147 void obsolete_scdaemon_option (const char *configname,
148                                unsigned int configlineno, const char *name);
149
150 int string_to_cipher_algo (const char *string);
151 int string_to_digest_algo (const char *string);
152
153 const char *compress_algo_to_string(int algo);
154 int string_to_compress_algo(const char *string);
155 int check_compress_algo(int algo);
156 int default_cipher_algo(void);
157 int default_compress_algo(void);
158 void compliance_failure(void);
159
160 struct parse_options
161 {
162   char *name;
163   unsigned int bit;
164   char **value;
165   char *help;
166 };
167
168 char *optsep(char **stringp);
169 char *argsplit(char *string);
170 int parse_options(char *str,unsigned int *options,
171                   struct parse_options *opts,int noisy);
172 const char *get_libexecdir (void);
173 int path_access(const char *file,int mode);
174
175 int pubkey_get_npkey (pubkey_algo_t algo);
176 int pubkey_get_nskey (pubkey_algo_t algo);
177 int pubkey_get_nsig (pubkey_algo_t algo);
178 int pubkey_get_nenc (pubkey_algo_t algo);
179
180 /* Temporary helpers. */
181 unsigned int pubkey_nbits( int algo, gcry_mpi_t *pkey );
182 int mpi_print (estream_t stream, gcry_mpi_t a, int mode);
183 unsigned int ecdsa_qbits_from_Q (unsigned int qbits);
184
185
186 /*-- cpr.c --*/
187 void set_status_fd ( int fd );
188 int  is_status_enabled ( void );
189 void write_status ( int no );
190 void write_status_error (const char *where, gpg_error_t err);
191 void write_status_errcode (const char *where, int errcode);
192 void write_status_failure (const char *where, gpg_error_t err);
193 void write_status_text ( int no, const char *text );
194 void write_status_printf (int no, const char *format,
195                           ...) GPGRT_ATTR_PRINTF(2,3);
196 void write_status_strings (int no, const char *text,
197                            ...) GPGRT_ATTR_SENTINEL(0);
198 void write_status_buffer ( int no,
199                            const char *buffer, size_t len, int wrap );
200 void write_status_text_and_buffer ( int no, const char *text,
201                                     const char *buffer, size_t len, int wrap );
202
203 void write_status_begin_signing (gcry_md_hd_t md);
204
205
206 int cpr_enabled(void);
207 char *cpr_get( const char *keyword, const char *prompt );
208 char *cpr_get_no_help( const char *keyword, const char *prompt );
209 char *cpr_get_utf8( const char *keyword, const char *prompt );
210 char *cpr_get_hidden( const char *keyword, const char *prompt );
211 void cpr_kill_prompt(void);
212 int  cpr_get_answer_is_yes_def (const char *keyword, const char *prompt,
213                                 int def_yes);
214 int  cpr_get_answer_is_yes( const char *keyword, const char *prompt );
215 int  cpr_get_answer_yes_no_quit( const char *keyword, const char *prompt );
216 int  cpr_get_answer_okay_cancel (const char *keyword,
217                                  const char *prompt,
218                                  int def_answer);
219
220 /*-- helptext.c --*/
221 void display_online_help( const char *keyword );
222
223 /*-- encode.c --*/
224 int setup_symkey (STRING2KEY **symkey_s2k,DEK **symkey_dek);
225 void encrypt_seskey (DEK *dek, DEK **seskey, byte *enckey);
226 int use_mdc (pk_list_t pk_list,int algo);
227 int encrypt_symmetric (const char *filename );
228 int encrypt_store (const char *filename );
229 int encrypt_crypt (ctrl_t ctrl, int filefd, const char *filename,
230                    strlist_t remusr, int use_symkey, pk_list_t provided_keys,
231                    int outputfd);
232 void encrypt_crypt_files (ctrl_t ctrl,
233                           int nfiles, char **files, strlist_t remusr);
234 int encrypt_filter (void *opaque, int control,
235                     iobuf_t a, byte *buf, size_t *ret_len);
236
237 int write_pubkey_enc (ctrl_t ctrl, PKT_public_key *pk, int throw_keyid,
238                       DEK *dek, iobuf_t out);
239
240 /*-- sign.c --*/
241 int sign_file (ctrl_t ctrl, strlist_t filenames, int detached, strlist_t locusr,
242                int do_encrypt, strlist_t remusr, const char *outfile );
243 int clearsign_file (ctrl_t ctrl,
244                     const char *fname, strlist_t locusr, const char *outfile);
245 int sign_symencrypt_file (ctrl_t ctrl, const char *fname, strlist_t locusr);
246
247 /*-- sig-check.c --*/
248 void sig_check_dump_stats (void);
249
250 /* SIG is a revocation signature.  Check if any of PK's designated
251    revokers generated it.  If so, return 0.  Note: this function
252    (correctly) doesn't care if the designated revoker is revoked.  */
253 int check_revocation_keys (ctrl_t ctrl, PKT_public_key *pk, PKT_signature *sig);
254 /* Check that the backsig BACKSIG from the subkey SUB_PK to its
255    primary key MAIN_PK is valid.  */
256 int check_backsig(PKT_public_key *main_pk,PKT_public_key *sub_pk,
257                   PKT_signature *backsig);
258 /* Check that the signature SIG over a key (e.g., a key binding or a
259    key revocation) is valid.  (To check signatures over data, use
260    check_signature.)  */
261 int check_key_signature (ctrl_t ctrl, kbnode_t root, kbnode_t sig,
262                          int *is_selfsig );
263 /* Like check_key_signature, but with the ability to specify some
264    additional parameters and get back additional information.  See the
265    documentation for the implementation for details.  */
266 int check_key_signature2 (ctrl_t ctrl, kbnode_t root, kbnode_t node,
267                           PKT_public_key *check_pk, PKT_public_key *ret_pk,
268                           int *is_selfsig, u32 *r_expiredate, int *r_expired);
269
270 /* Returns whether SIGNER generated the signature SIG over the packet
271    PACKET, which is a key, subkey or uid, and comes from the key block
272    KB.  If SIGNER is NULL, it is looked up based on the information in
273    SIG.  If not NULL, sets *IS_SELFSIG to indicate whether the
274    signature is a self-signature and *RET_PK to a copy of the signer's
275    key.  */
276 gpg_error_t check_signature_over_key_or_uid (ctrl_t ctrl,
277                                              PKT_public_key *signer,
278                                              PKT_signature *sig,
279                                              KBNODE kb, PACKET *packet,
280                                              int *is_selfsig,
281                                              PKT_public_key *ret_pk);
282
283
284 /*-- delkey.c --*/
285 gpg_error_t delete_keys (ctrl_t ctrl,
286                          strlist_t names, int secret, int allow_both);
287
288 /*-- keyedit.c --*/
289 void keyedit_menu (ctrl_t ctrl, const char *username, strlist_t locusr,
290                    strlist_t commands, int quiet, int seckey_check );
291 void keyedit_passwd (ctrl_t ctrl, const char *username);
292 void keyedit_quick_adduid (ctrl_t ctrl, const char *username,
293                            const char *newuid);
294 void keyedit_quick_addkey (ctrl_t ctrl, const char *fpr, const char *algostr,
295                            const char *usagestr, const char *expirestr);
296 void keyedit_quick_revuid (ctrl_t ctrl, const char *username,
297                            const char *uidtorev);
298 void keyedit_quick_sign (ctrl_t ctrl, const char *fpr,
299                          strlist_t uids, strlist_t locusr, int local);
300 void keyedit_quick_set_expire (ctrl_t ctrl,
301                                const char *fpr, const char *expirestr);
302 void keyedit_quick_set_primary (ctrl_t ctrl, const char *username,
303                                 const char *primaryuid);
304 void show_basic_key_info (ctrl_t ctrl, kbnode_t keyblock);
305
306 /*-- keygen.c --*/
307 const char *get_default_pubkey_algo (void);
308 u32 parse_expire_string(const char *string);
309 u32 ask_expire_interval(int object,const char *def_expire);
310 u32 ask_expiredate(void);
311 unsigned int ask_key_flags (int algo, int subkey, unsigned int current);
312 void quick_generate_keypair (ctrl_t ctrl, const char *uid, const char *algostr,
313                              const char *usagestr, const char *expirestr);
314 void generate_keypair (ctrl_t ctrl, int full, const char *fname,
315                        const char *card_serialno, int card_backup_key);
316 int keygen_set_std_prefs (const char *string,int personal);
317 PKT_user_id *keygen_get_std_prefs (void);
318 int keygen_add_key_expire( PKT_signature *sig, void *opaque );
319 int keygen_add_key_flags (PKT_signature *sig, void *opaque);
320 int keygen_add_std_prefs( PKT_signature *sig, void *opaque );
321 int keygen_upd_std_prefs( PKT_signature *sig, void *opaque );
322 int keygen_add_keyserver_url(PKT_signature *sig, void *opaque);
323 int keygen_add_notations(PKT_signature *sig,void *opaque);
324 int keygen_add_revkey(PKT_signature *sig, void *opaque);
325 gpg_error_t make_backsig (ctrl_t ctrl,
326                           PKT_signature *sig, PKT_public_key *pk,
327                           PKT_public_key *sub_pk, PKT_public_key *sub_psk,
328                           u32 timestamp, const char *cache_nonce);
329 gpg_error_t generate_subkeypair (ctrl_t ctrl, kbnode_t keyblock,
330                                  const char *algostr,
331                                  const char *usagestr,
332                                  const char *expirestr);
333 #ifdef ENABLE_CARD_SUPPORT
334 gpg_error_t generate_card_subkeypair (ctrl_t ctrl, kbnode_t pub_keyblock,
335                                       int keyno, const char *serialno);
336 #endif
337
338
339 /*-- openfile.c --*/
340 int overwrite_filep( const char *fname );
341 char *make_outfile_name( const char *iname );
342 char *ask_outfile_name( const char *name, size_t namelen );
343 int open_outfile (int inp_fd, const char *iname, int mode,
344                   int restrictedperm, iobuf_t *a);
345 char *get_matching_datafile (const char *sigfilename);
346 iobuf_t open_sigfile (const char *sigfilename, progress_filter_context_t *pfx);
347 void try_make_homedir( const char *fname );
348 char *get_openpgp_revocdir (const char *home);
349
350 /*-- seskey.c --*/
351 void make_session_key( DEK *dek );
352 gcry_mpi_t encode_session_key( int openpgp_pk_algo, DEK *dek, unsigned nbits );
353 gcry_mpi_t encode_md_value (PKT_public_key *pk,
354                             gcry_md_hd_t md, int hash_algo );
355
356 /*-- import.c --*/
357 struct import_stats_s;
358 typedef struct import_stats_s *import_stats_t;
359 struct import_filter_s;
360 typedef struct import_filter_s *import_filter_t;
361 typedef gpg_error_t (*import_screener_t)(kbnode_t keyblock, void *arg);
362
363 int parse_import_options(char *str,unsigned int *options,int noisy);
364
365 gpg_error_t parse_and_set_import_filter (const char *string);
366 import_filter_t save_and_clear_import_filter (void);
367 void            restore_import_filter (import_filter_t filt);
368
369 gpg_error_t read_key_from_file (ctrl_t ctrl, const char *fname,
370                                 kbnode_t *r_keyblock);
371 void import_keys (ctrl_t ctrl, char **fnames, int nnames,
372                   import_stats_t stats_hd, unsigned int options);
373 int import_keys_stream (ctrl_t ctrl, iobuf_t inp, import_stats_t stats_hd,
374                         unsigned char **fpr,
375                         size_t *fpr_len, unsigned int options);
376 int import_keys_es_stream (ctrl_t ctrl, estream_t fp,
377                            import_stats_t stats_handle,
378                            unsigned char **fpr, size_t *fpr_len,
379                            unsigned int options,
380                            import_screener_t screener, void *screener_arg);
381 gpg_error_t import_old_secring (ctrl_t ctrl, const char *fname);
382 import_stats_t import_new_stats_handle (void);
383 void import_release_stats_handle (import_stats_t hd);
384 void import_print_stats (import_stats_t hd);
385 /* Communication for impex_filter_getval */
386 struct impex_filter_parm_s
387 {
388   ctrl_t ctrl;
389   kbnode_t node;
390 };
391
392 const char *impex_filter_getval (void *cookie, const char *propname);
393 gpg_error_t transfer_secret_keys (ctrl_t ctrl, struct import_stats_s *stats,
394                                   kbnode_t sec_keyblock, int batch, int force);
395
396 int collapse_uids( KBNODE *keyblock );
397
398
399 /*-- export.c --*/
400 struct export_stats_s;
401 typedef struct export_stats_s *export_stats_t;
402
403 export_stats_t export_new_stats (void);
404 void export_release_stats (export_stats_t stats);
405 void export_print_stats (export_stats_t stats);
406
407 int parse_export_options(char *str,unsigned int *options,int noisy);
408 gpg_error_t parse_and_set_export_filter (const char *string);
409
410 int export_pubkeys (ctrl_t ctrl, strlist_t users, unsigned int options,
411                     export_stats_t stats);
412 int export_seckeys (ctrl_t ctrl, strlist_t users, unsigned int options,
413                     export_stats_t stats);
414 int export_secsubkeys (ctrl_t ctrl, strlist_t users, unsigned int options,
415                        export_stats_t stats);
416
417 gpg_error_t export_pubkey_buffer (ctrl_t ctrl, const char *keyspec,
418                                   unsigned int options,
419                                   export_stats_t stats,
420                                   kbnode_t *r_keyblock,
421                                   void **r_data, size_t *r_datalen);
422
423 gpg_error_t receive_seckey_from_agent (ctrl_t ctrl, gcry_cipher_hd_t cipherhd,
424                                        int cleartext,
425                                        char **cache_nonce_addr,
426                                        const char *hexgrip,
427                                        PKT_public_key *pk);
428
429 gpg_error_t write_keyblock_to_output (kbnode_t keyblock,
430                                       int with_armor, unsigned int options);
431
432 gpg_error_t export_ssh_key (ctrl_t ctrl, const char *userid);
433
434 /*-- dearmor.c --*/
435 int dearmor_file( const char *fname );
436 int enarmor_file( const char *fname );
437
438 /*-- revoke.c --*/
439 struct revocation_reason_info;
440
441 int gen_standard_revoke (ctrl_t ctrl,
442                          PKT_public_key *psk, const char *cache_nonce);
443 int gen_revoke (ctrl_t ctrl, const char *uname);
444 int gen_desig_revoke (ctrl_t ctrl, const char *uname, strlist_t locusr);
445 int revocation_reason_build_cb( PKT_signature *sig, void *opaque );
446 struct revocation_reason_info *
447                 ask_revocation_reason( int key_rev, int cert_rev, int hint );
448 struct revocation_reason_info * get_default_uid_revocation_reason(void);
449 void release_revocation_reason_info( struct revocation_reason_info *reason );
450
451 /*-- keylist.c --*/
452 void public_key_list (ctrl_t ctrl, strlist_t list, int locate_mode );
453 void secret_key_list (ctrl_t ctrl, strlist_t list );
454 void print_subpackets_colon(PKT_signature *sig);
455 void reorder_keyblock (KBNODE keyblock);
456 void list_keyblock_direct (ctrl_t ctrl, kbnode_t keyblock, int secret,
457                            int has_secret, int fpr, int no_validity);
458 void print_fingerprint (ctrl_t ctrl, estream_t fp,
459                         PKT_public_key *pk, int mode);
460 void print_revokers (estream_t fp, PKT_public_key *pk);
461 void show_policy_url(PKT_signature *sig,int indent,int mode);
462 void show_keyserver_url(PKT_signature *sig,int indent,int mode);
463 void show_notation(PKT_signature *sig,int indent,int mode,int which);
464 void dump_attribs (const PKT_user_id *uid, PKT_public_key *pk);
465 void set_attrib_fd(int fd);
466 char *format_seckey_info (ctrl_t ctrl, PKT_public_key *pk);
467 void print_seckey_info (ctrl_t ctrl, PKT_public_key *pk);
468 void print_pubkey_info (ctrl_t ctrl, estream_t fp, PKT_public_key *pk);
469 void print_card_key_info (estream_t fp, KBNODE keyblock);
470 void print_key_line (ctrl_t ctrl, estream_t fp, PKT_public_key *pk, int secret);
471
472 /*-- verify.c --*/
473 void print_file_status( int status, const char *name, int what );
474 int verify_signatures (ctrl_t ctrl, int nfiles, char **files );
475 int verify_files (ctrl_t ctrl, int nfiles, char **files );
476 int gpg_verify (ctrl_t ctrl, int sig_fd, int data_fd, estream_t out_fp);
477
478 /*-- decrypt.c --*/
479 int decrypt_message (ctrl_t ctrl, const char *filename );
480 gpg_error_t decrypt_message_fd (ctrl_t ctrl, int input_fd, int output_fd);
481 void decrypt_messages (ctrl_t ctrl, int nfiles, char *files[]);
482
483 /*-- plaintext.c --*/
484 int hash_datafiles( gcry_md_hd_t md, gcry_md_hd_t md2,
485                     strlist_t files, const char *sigfilename, int textmode);
486 int hash_datafile_by_fd ( gcry_md_hd_t md, gcry_md_hd_t md2, int data_fd,
487                           int textmode );
488 PKT_plaintext *setup_plaintext_name(const char *filename,IOBUF iobuf);
489
490 /*-- server.c --*/
491 int gpg_server (ctrl_t);
492 gpg_error_t gpg_proxy_pinentry_notify (ctrl_t ctrl,
493                                        const unsigned char *line);
494
495 #ifdef ENABLE_CARD_SUPPORT
496 /*-- card-util.c --*/
497 void change_pin (int no, int allow_admin);
498 void card_status (ctrl_t ctrl, estream_t fp, const char *serialno);
499 void card_edit (ctrl_t ctrl, strlist_t commands);
500 gpg_error_t  card_generate_subkey (ctrl_t ctrl, kbnode_t pub_keyblock);
501 int  card_store_subkey (KBNODE node, int use);
502 #endif
503
504 #define S2K_DECODE_COUNT(_val) ((16ul + ((_val) & 15)) << (((_val) >> 4) + 6))
505
506 /*-- migrate.c --*/
507 void migrate_secring (ctrl_t ctrl);
508
509
510 #endif /*G10_MAIN_H*/