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