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