g10: Minor clean up.
[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 int gnupg_pk_is_compliant (int compliance, PKT_public_key *pk,
130                            unsigned int keylength, const char *curvename);
131
132 enum gcry_md_algos map_md_openpgp_to_gcry (digest_algo_t algo);
133 int openpgp_md_test_algo (digest_algo_t algo);
134 const char *openpgp_md_algo_name (int algo);
135
136 struct expando_args
137 {
138   PKT_public_key *pk;
139   PKT_public_key *pksk;
140   byte imagetype;
141   int validity_info;
142   const char *validity_string;
143   const byte *namehash;
144 };
145
146 char *pct_expando(const char *string,struct expando_args *args);
147 void deprecated_warning(const char *configname,unsigned int configlineno,
148                         const char *option,const char *repl1,const char *repl2);
149 void deprecated_command (const char *name);
150 void obsolete_scdaemon_option (const char *configname,
151                                unsigned int configlineno, const char *name);
152
153 int string_to_cipher_algo (const char *string);
154 int string_to_digest_algo (const char *string);
155
156 const char *compress_algo_to_string(int algo);
157 int string_to_compress_algo(const char *string);
158 int check_compress_algo(int algo);
159 int default_cipher_algo(void);
160 int default_compress_algo(void);
161 const char *compliance_option_string(void);
162 void compliance_failure(void);
163
164 struct parse_options
165 {
166   char *name;
167   unsigned int bit;
168   char **value;
169   char *help;
170 };
171
172 char *optsep(char **stringp);
173 char *argsplit(char *string);
174 int parse_options(char *str,unsigned int *options,
175                   struct parse_options *opts,int noisy);
176 const char *get_libexecdir (void);
177 int path_access(const char *file,int mode);
178
179 int pubkey_get_npkey (pubkey_algo_t algo);
180 int pubkey_get_nskey (pubkey_algo_t algo);
181 int pubkey_get_nsig (pubkey_algo_t algo);
182 int pubkey_get_nenc (pubkey_algo_t algo);
183
184 /* Temporary helpers. */
185 unsigned int pubkey_nbits( int algo, gcry_mpi_t *pkey );
186 int mpi_print (estream_t stream, gcry_mpi_t a, int mode);
187 unsigned int ecdsa_qbits_from_Q (unsigned int qbits);
188
189
190 /*-- cpr.c --*/
191 void set_status_fd ( int fd );
192 int  is_status_enabled ( void );
193 void write_status ( int no );
194 void write_status_error (const char *where, gpg_error_t err);
195 void write_status_errcode (const char *where, int errcode);
196 void write_status_failure (const char *where, gpg_error_t err);
197 void write_status_text ( int no, const char *text );
198 void write_status_printf (int no, const char *format,
199                           ...) GPGRT_ATTR_PRINTF(2,3);
200 void write_status_strings (int no, const char *text,
201                            ...) GPGRT_ATTR_SENTINEL(0);
202 void write_status_buffer ( int no,
203                            const char *buffer, size_t len, int wrap );
204 void write_status_text_and_buffer ( int no, const char *text,
205                                     const char *buffer, size_t len, int wrap );
206
207 void write_status_begin_signing (gcry_md_hd_t md);
208
209
210 int cpr_enabled(void);
211 char *cpr_get( const char *keyword, const char *prompt );
212 char *cpr_get_no_help( const char *keyword, const char *prompt );
213 char *cpr_get_utf8( const char *keyword, const char *prompt );
214 char *cpr_get_hidden( const char *keyword, const char *prompt );
215 void cpr_kill_prompt(void);
216 int  cpr_get_answer_is_yes_def (const char *keyword, const char *prompt,
217                                 int def_yes);
218 int  cpr_get_answer_is_yes( const char *keyword, const char *prompt );
219 int  cpr_get_answer_yes_no_quit( const char *keyword, const char *prompt );
220 int  cpr_get_answer_okay_cancel (const char *keyword,
221                                  const char *prompt,
222                                  int def_answer);
223
224 /*-- helptext.c --*/
225 void display_online_help( const char *keyword );
226
227 /*-- encode.c --*/
228 int setup_symkey (STRING2KEY **symkey_s2k,DEK **symkey_dek);
229 void encrypt_seskey (DEK *dek, DEK **seskey, byte *enckey);
230 int use_mdc (pk_list_t pk_list,int algo);
231 int encrypt_symmetric (const char *filename );
232 int encrypt_store (const char *filename );
233 int encrypt_crypt (ctrl_t ctrl, int filefd, const char *filename,
234                    strlist_t remusr, int use_symkey, pk_list_t provided_keys,
235                    int outputfd);
236 void encrypt_crypt_files (ctrl_t ctrl,
237                           int nfiles, char **files, strlist_t remusr);
238 int encrypt_filter (void *opaque, int control,
239                     iobuf_t a, byte *buf, size_t *ret_len);
240
241 int write_pubkey_enc (ctrl_t ctrl, PKT_public_key *pk, int throw_keyid,
242                       DEK *dek, iobuf_t out);
243
244 /*-- sign.c --*/
245 int sign_file (ctrl_t ctrl, strlist_t filenames, int detached, strlist_t locusr,
246                int do_encrypt, strlist_t remusr, const char *outfile );
247 int clearsign_file (ctrl_t ctrl,
248                     const char *fname, strlist_t locusr, const char *outfile);
249 int sign_symencrypt_file (ctrl_t ctrl, const char *fname, strlist_t locusr);
250
251 /*-- sig-check.c --*/
252 void sig_check_dump_stats (void);
253
254 /* SIG is a revocation signature.  Check if any of PK's designated
255    revokers generated it.  If so, return 0.  Note: this function
256    (correctly) doesn't care if the designated revoker is revoked.  */
257 int check_revocation_keys (ctrl_t ctrl, PKT_public_key *pk, PKT_signature *sig);
258 /* Check that the backsig BACKSIG from the subkey SUB_PK to its
259    primary key MAIN_PK is valid.  */
260 int check_backsig(PKT_public_key *main_pk,PKT_public_key *sub_pk,
261                   PKT_signature *backsig);
262 /* Check that the signature SIG over a key (e.g., a key binding or a
263    key revocation) is valid.  (To check signatures over data, use
264    check_signature.)  */
265 int check_key_signature (ctrl_t ctrl, kbnode_t root, kbnode_t sig,
266                          int *is_selfsig );
267 /* Like check_key_signature, but with the ability to specify some
268    additional parameters and get back additional information.  See the
269    documentation for the implementation for details.  */
270 int check_key_signature2 (ctrl_t ctrl, kbnode_t root, kbnode_t node,
271                           PKT_public_key *check_pk, PKT_public_key *ret_pk,
272                           int *is_selfsig, u32 *r_expiredate, int *r_expired);
273
274 /* Returns whether SIGNER generated the signature SIG over the packet
275    PACKET, which is a key, subkey or uid, and comes from the key block
276    KB.  If SIGNER is NULL, it is looked up based on the information in
277    SIG.  If not NULL, sets *IS_SELFSIG to indicate whether the
278    signature is a self-signature and *RET_PK to a copy of the signer's
279    key.  */
280 gpg_error_t check_signature_over_key_or_uid (ctrl_t ctrl,
281                                              PKT_public_key *signer,
282                                              PKT_signature *sig,
283                                              KBNODE kb, PACKET *packet,
284                                              int *is_selfsig,
285                                              PKT_public_key *ret_pk);
286
287
288 /*-- delkey.c --*/
289 gpg_error_t delete_keys (ctrl_t ctrl,
290                          strlist_t names, int secret, int allow_both);
291
292 /*-- keyedit.c --*/
293 void keyedit_menu (ctrl_t ctrl, const char *username, strlist_t locusr,
294                    strlist_t commands, int quiet, int seckey_check );
295 void keyedit_passwd (ctrl_t ctrl, const char *username);
296 void keyedit_quick_adduid (ctrl_t ctrl, const char *username,
297                            const char *newuid);
298 void keyedit_quick_addkey (ctrl_t ctrl, const char *fpr, const char *algostr,
299                            const char *usagestr, const char *expirestr);
300 void keyedit_quick_revuid (ctrl_t ctrl, const char *username,
301                            const char *uidtorev);
302 void keyedit_quick_sign (ctrl_t ctrl, const char *fpr,
303                          strlist_t uids, strlist_t locusr, int local);
304 void keyedit_quick_set_expire (ctrl_t ctrl,
305                                const char *fpr, const char *expirestr);
306 void keyedit_quick_set_primary (ctrl_t ctrl, const char *username,
307                                 const char *primaryuid);
308 void show_basic_key_info (ctrl_t ctrl, kbnode_t keyblock);
309
310 /*-- keygen.c --*/
311 const char *get_default_pubkey_algo (void);
312 u32 parse_expire_string(const char *string);
313 u32 ask_expire_interval(int object,const char *def_expire);
314 u32 ask_expiredate(void);
315 unsigned int ask_key_flags (int algo, int subkey, unsigned int current);
316 void quick_generate_keypair (ctrl_t ctrl, const char *uid, const char *algostr,
317                              const char *usagestr, const char *expirestr);
318 void generate_keypair (ctrl_t ctrl, int full, const char *fname,
319                        const char *card_serialno, int card_backup_key);
320 int keygen_set_std_prefs (const char *string,int personal);
321 PKT_user_id *keygen_get_std_prefs (void);
322 int keygen_add_key_expire( PKT_signature *sig, void *opaque );
323 int keygen_add_key_flags (PKT_signature *sig, void *opaque);
324 int keygen_add_std_prefs( PKT_signature *sig, void *opaque );
325 int keygen_upd_std_prefs( PKT_signature *sig, void *opaque );
326 int keygen_add_keyserver_url(PKT_signature *sig, void *opaque);
327 int keygen_add_notations(PKT_signature *sig,void *opaque);
328 int keygen_add_revkey(PKT_signature *sig, void *opaque);
329 gpg_error_t make_backsig (ctrl_t ctrl,
330                           PKT_signature *sig, PKT_public_key *pk,
331                           PKT_public_key *sub_pk, PKT_public_key *sub_psk,
332                           u32 timestamp, const char *cache_nonce);
333 gpg_error_t generate_subkeypair (ctrl_t ctrl, kbnode_t keyblock,
334                                  const char *algostr,
335                                  const char *usagestr,
336                                  const char *expirestr);
337 #ifdef ENABLE_CARD_SUPPORT
338 gpg_error_t generate_card_subkeypair (ctrl_t ctrl, kbnode_t pub_keyblock,
339                                       int keyno, const char *serialno);
340 #endif
341
342
343 /*-- openfile.c --*/
344 int overwrite_filep( const char *fname );
345 char *make_outfile_name( const char *iname );
346 char *ask_outfile_name( const char *name, size_t namelen );
347 int open_outfile (int inp_fd, const char *iname, int mode,
348                   int restrictedperm, iobuf_t *a);
349 char *get_matching_datafile (const char *sigfilename);
350 iobuf_t open_sigfile (const char *sigfilename, progress_filter_context_t *pfx);
351 void try_make_homedir( const char *fname );
352 char *get_openpgp_revocdir (const char *home);
353
354 /*-- seskey.c --*/
355 void make_session_key( DEK *dek );
356 gcry_mpi_t encode_session_key( int openpgp_pk_algo, DEK *dek, unsigned nbits );
357 gcry_mpi_t encode_md_value (PKT_public_key *pk,
358                             gcry_md_hd_t md, int hash_algo );
359
360 /*-- import.c --*/
361 struct import_stats_s;
362 typedef struct import_stats_s *import_stats_t;
363 struct import_filter_s;
364 typedef struct import_filter_s *import_filter_t;
365 typedef gpg_error_t (*import_screener_t)(kbnode_t keyblock, void *arg);
366
367 int parse_import_options(char *str,unsigned int *options,int noisy);
368
369 gpg_error_t parse_and_set_import_filter (const char *string);
370 import_filter_t save_and_clear_import_filter (void);
371 void            restore_import_filter (import_filter_t filt);
372
373 gpg_error_t read_key_from_file (ctrl_t ctrl, const char *fname,
374                                 kbnode_t *r_keyblock);
375 void import_keys (ctrl_t ctrl, char **fnames, int nnames,
376                   import_stats_t stats_hd, unsigned int options);
377 int import_keys_stream (ctrl_t ctrl, iobuf_t inp, import_stats_t stats_hd,
378                         unsigned char **fpr,
379                         size_t *fpr_len, unsigned int options);
380 int import_keys_es_stream (ctrl_t ctrl, estream_t fp,
381                            import_stats_t stats_handle,
382                            unsigned char **fpr, size_t *fpr_len,
383                            unsigned int options,
384                            import_screener_t screener, void *screener_arg);
385 gpg_error_t import_old_secring (ctrl_t ctrl, const char *fname);
386 import_stats_t import_new_stats_handle (void);
387 void import_release_stats_handle (import_stats_t hd);
388 void import_print_stats (import_stats_t hd);
389 /* Communication for impex_filter_getval */
390 struct impex_filter_parm_s
391 {
392   ctrl_t ctrl;
393   kbnode_t node;
394 };
395
396 const char *impex_filter_getval (void *cookie, const char *propname);
397 gpg_error_t transfer_secret_keys (ctrl_t ctrl, struct import_stats_s *stats,
398                                   kbnode_t sec_keyblock, int batch, int force);
399
400 int collapse_uids( KBNODE *keyblock );
401
402
403 /*-- export.c --*/
404 struct export_stats_s;
405 typedef struct export_stats_s *export_stats_t;
406
407 export_stats_t export_new_stats (void);
408 void export_release_stats (export_stats_t stats);
409 void export_print_stats (export_stats_t stats);
410
411 int parse_export_options(char *str,unsigned int *options,int noisy);
412 gpg_error_t parse_and_set_export_filter (const char *string);
413
414 int export_pubkeys (ctrl_t ctrl, strlist_t users, unsigned int options,
415                     export_stats_t stats);
416 int export_seckeys (ctrl_t ctrl, strlist_t users, unsigned int options,
417                     export_stats_t stats);
418 int export_secsubkeys (ctrl_t ctrl, strlist_t users, unsigned int options,
419                        export_stats_t stats);
420
421 gpg_error_t export_pubkey_buffer (ctrl_t ctrl, const char *keyspec,
422                                   unsigned int options,
423                                   export_stats_t stats,
424                                   kbnode_t *r_keyblock,
425                                   void **r_data, size_t *r_datalen);
426
427 gpg_error_t receive_seckey_from_agent (ctrl_t ctrl, gcry_cipher_hd_t cipherhd,
428                                        int cleartext,
429                                        char **cache_nonce_addr,
430                                        const char *hexgrip,
431                                        PKT_public_key *pk);
432
433 gpg_error_t write_keyblock_to_output (kbnode_t keyblock,
434                                       int with_armor, unsigned int options);
435
436 gpg_error_t export_ssh_key (ctrl_t ctrl, const char *userid);
437
438 /*-- dearmor.c --*/
439 int dearmor_file( const char *fname );
440 int enarmor_file( const char *fname );
441
442 /*-- revoke.c --*/
443 struct revocation_reason_info;
444
445 int gen_standard_revoke (ctrl_t ctrl,
446                          PKT_public_key *psk, const char *cache_nonce);
447 int gen_revoke (ctrl_t ctrl, const char *uname);
448 int gen_desig_revoke (ctrl_t ctrl, const char *uname, strlist_t locusr);
449 int revocation_reason_build_cb( PKT_signature *sig, void *opaque );
450 struct revocation_reason_info *
451                 ask_revocation_reason( int key_rev, int cert_rev, int hint );
452 struct revocation_reason_info * get_default_uid_revocation_reason(void);
453 void release_revocation_reason_info( struct revocation_reason_info *reason );
454
455 /*-- keylist.c --*/
456 void public_key_list (ctrl_t ctrl, strlist_t list, int locate_mode );
457 void secret_key_list (ctrl_t ctrl, strlist_t list );
458 void print_subpackets_colon(PKT_signature *sig);
459 void reorder_keyblock (KBNODE keyblock);
460 void list_keyblock_direct (ctrl_t ctrl, kbnode_t keyblock, int secret,
461                            int has_secret, int fpr, int no_validity);
462 void print_fingerprint (ctrl_t ctrl, estream_t fp,
463                         PKT_public_key *pk, int mode);
464 void print_revokers (estream_t fp, PKT_public_key *pk);
465 void show_policy_url(PKT_signature *sig,int indent,int mode);
466 void show_keyserver_url(PKT_signature *sig,int indent,int mode);
467 void show_notation(PKT_signature *sig,int indent,int mode,int which);
468 void dump_attribs (const PKT_user_id *uid, PKT_public_key *pk);
469 void set_attrib_fd(int fd);
470 char *format_seckey_info (ctrl_t ctrl, PKT_public_key *pk);
471 void print_seckey_info (ctrl_t ctrl, PKT_public_key *pk);
472 void print_pubkey_info (ctrl_t ctrl, estream_t fp, PKT_public_key *pk);
473 void print_card_key_info (estream_t fp, KBNODE keyblock);
474 void print_key_line (ctrl_t ctrl, estream_t fp, PKT_public_key *pk, int secret);
475
476 /*-- verify.c --*/
477 void print_file_status( int status, const char *name, int what );
478 int verify_signatures (ctrl_t ctrl, int nfiles, char **files );
479 int verify_files (ctrl_t ctrl, int nfiles, char **files );
480 int gpg_verify (ctrl_t ctrl, int sig_fd, int data_fd, estream_t out_fp);
481
482 /*-- decrypt.c --*/
483 int decrypt_message (ctrl_t ctrl, const char *filename );
484 gpg_error_t decrypt_message_fd (ctrl_t ctrl, int input_fd, int output_fd);
485 void decrypt_messages (ctrl_t ctrl, int nfiles, char *files[]);
486
487 /*-- plaintext.c --*/
488 int hash_datafiles( gcry_md_hd_t md, gcry_md_hd_t md2,
489                     strlist_t files, const char *sigfilename, int textmode);
490 int hash_datafile_by_fd ( gcry_md_hd_t md, gcry_md_hd_t md2, int data_fd,
491                           int textmode );
492 PKT_plaintext *setup_plaintext_name(const char *filename,IOBUF iobuf);
493
494 /*-- server.c --*/
495 int gpg_server (ctrl_t);
496 gpg_error_t gpg_proxy_pinentry_notify (ctrl_t ctrl,
497                                        const unsigned char *line);
498
499 #ifdef ENABLE_CARD_SUPPORT
500 /*-- card-util.c --*/
501 void change_pin (int no, int allow_admin);
502 void card_status (ctrl_t ctrl, estream_t fp, const char *serialno);
503 void card_edit (ctrl_t ctrl, strlist_t commands);
504 gpg_error_t  card_generate_subkey (ctrl_t ctrl, kbnode_t pub_keyblock);
505 int  card_store_subkey (KBNODE node, int use);
506 #endif
507
508 #define S2K_DECODE_COUNT(_val) ((16ul + ((_val) & 15)) << (((_val) >> 4) + 6))
509
510 /*-- migrate.c --*/
511 void migrate_secring (ctrl_t ctrl);
512
513
514 #endif /*G10_MAIN_H*/