gpg: New options import-drop-uids and export-drop-uids.
[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 #if GCRYPT_VERSION_NUMBER < 0x019000
45 # define DEFAULT_AEAD_ALGO  AEAD_ALGO_OCB
46 #else
47 # define DEFAULT_AEAD_ALGO  AEAD_ALGO_EAX
48 #endif
49
50 #define DEFAULT_DIGEST_ALGO     ((GNUPG)? DIGEST_ALGO_SHA256:DIGEST_ALGO_SHA1)
51 #define DEFAULT_S2K_DIGEST_ALGO DIGEST_ALGO_SHA1
52 #ifdef HAVE_ZIP
53 # define DEFAULT_COMPRESS_ALGO   COMPRESS_ALGO_ZIP
54 #else
55 # define DEFAULT_COMPRESS_ALGO   COMPRESS_ALGO_NONE
56 #endif
57
58
59 #define S2K_DIGEST_ALGO (opt.s2k_digest_algo?opt.s2k_digest_algo:DEFAULT_S2K_DIGEST_ALGO)
60
61
62 /* Various data objects.  */
63
64 typedef struct
65 {
66   ctrl_t ctrl;
67   int header_okay;
68   PK_LIST pk_list;
69   DEK *symkey_dek;
70   STRING2KEY *symkey_s2k;
71   cipher_filter_context_t cfx;
72 } encrypt_filter_context_t;
73
74
75 struct groupitem
76 {
77   char *name;
78   strlist_t values;
79   struct groupitem *next;
80 };
81
82 struct weakhash
83 {
84   enum gcry_md_algos algo;
85   int rejection_shown;
86   struct weakhash *next;
87 };
88
89
90 /*-- gpg.c --*/
91 extern int g10_errors_seen;
92
93 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 5 )
94   void g10_exit(int rc) __attribute__ ((noreturn));
95 #else
96   void g10_exit(int rc);
97 #endif
98 void print_pubkey_algo_note (pubkey_algo_t algo);
99 void print_cipher_algo_note (cipher_algo_t algo);
100 void print_digest_algo_note (digest_algo_t algo);
101 void print_digest_rejected_note (enum gcry_md_algos algo);
102 void print_reported_error (gpg_error_t err, gpg_err_code_t skip_if_ec);
103 void print_further_info (const char *format, ...) GPGRT_ATTR_PRINTF(1,2);
104 void additional_weak_digest (const char* digestname);
105
106 /*-- armor.c --*/
107 char *make_radix64_string( const byte *data, size_t len );
108
109 /*-- misc.c --*/
110 void trap_unaligned(void);
111 void register_secured_file (const char *fname);
112 void unregister_secured_file (const char *fname);
113 int  is_secured_file (int fd);
114 int  is_secured_filename (const char *fname);
115 u16 checksum_u16( unsigned n );
116 u16 checksum( byte *p, unsigned n );
117 u16 checksum_mpi( gcry_mpi_t a );
118 u32 buffer_to_u32( const byte *buffer );
119 const byte *get_session_marker( size_t *rlen );
120
121 enum gcry_cipher_algos map_cipher_openpgp_to_gcry (cipher_algo_t algo);
122 #define openpgp_cipher_open(_a,_b,_c,_d) \
123   gcry_cipher_open((_a),map_cipher_openpgp_to_gcry((_b)),(_c),(_d))
124 #define openpgp_cipher_get_algo_keylen(_a) \
125   gcry_cipher_get_algo_keylen(map_cipher_openpgp_to_gcry((_a)))
126 #define openpgp_cipher_get_algo_blklen(_a) \
127   gcry_cipher_get_algo_blklen(map_cipher_openpgp_to_gcry((_a)))
128 int openpgp_cipher_blocklen (cipher_algo_t algo);
129 int openpgp_cipher_test_algo(cipher_algo_t algo);
130 const char *openpgp_cipher_algo_name (cipher_algo_t algo);
131
132 gpg_error_t openpgp_aead_test_algo (aead_algo_t algo);
133 const char *openpgp_aead_algo_name (aead_algo_t algo);
134 gpg_error_t openpgp_aead_algo_info (aead_algo_t algo,
135                                     enum gcry_cipher_modes *r_mode,
136                                     unsigned int *r_noncelen);
137
138 pubkey_algo_t map_pk_gcry_to_openpgp (enum gcry_pk_algos algo);
139 int openpgp_pk_test_algo (pubkey_algo_t algo);
140 int openpgp_pk_test_algo2 (pubkey_algo_t algo, unsigned int use);
141 int openpgp_pk_algo_usage ( int algo );
142 const char *openpgp_pk_algo_name (pubkey_algo_t algo);
143
144 enum gcry_md_algos map_md_openpgp_to_gcry (digest_algo_t algo);
145 int openpgp_md_test_algo (digest_algo_t algo);
146 const char *openpgp_md_algo_name (int algo);
147
148 struct expando_args
149 {
150   PKT_public_key *pk;
151   PKT_public_key *pksk;
152   byte imagetype;
153   int validity_info;
154   const char *validity_string;
155   const byte *namehash;
156 };
157
158 char *pct_expando(const char *string,struct expando_args *args);
159 void deprecated_warning(const char *configname,unsigned int configlineno,
160                         const char *option,const char *repl1,const char *repl2);
161 void deprecated_command (const char *name);
162 void obsolete_scdaemon_option (const char *configname,
163                                unsigned int configlineno, const char *name);
164
165 int string_to_cipher_algo (const char *string);
166 aead_algo_t string_to_aead_algo (const char *string);
167 int string_to_digest_algo (const char *string);
168
169 const char *compress_algo_to_string(int algo);
170 int string_to_compress_algo(const char *string);
171 int check_compress_algo(int algo);
172 int default_cipher_algo(void);
173 aead_algo_t default_aead_algo(void);
174 int default_compress_algo(void);
175 void compliance_failure(void);
176
177 struct parse_options
178 {
179   char *name;
180   unsigned int bit;
181   char **value;
182   char *help;
183 };
184
185 char *optsep(char **stringp);
186 char *argsplit(char *string);
187 int parse_options(char *str,unsigned int *options,
188                   struct parse_options *opts,int noisy);
189 const char *get_libexecdir (void);
190 int path_access(const char *file,int mode);
191
192 int pubkey_get_npkey (pubkey_algo_t algo);
193 int pubkey_get_nskey (pubkey_algo_t algo);
194 int pubkey_get_nsig (pubkey_algo_t algo);
195 int pubkey_get_nenc (pubkey_algo_t algo);
196
197 /* Temporary helpers. */
198 unsigned int pubkey_nbits( int algo, gcry_mpi_t *pkey );
199 int mpi_print (estream_t stream, gcry_mpi_t a, int mode);
200 unsigned int ecdsa_qbits_from_Q (unsigned int qbits);
201
202
203 /*-- cpr.c --*/
204 void set_status_fd ( int fd );
205 int  is_status_enabled ( void );
206 void write_status ( int no );
207 void write_status_error (const char *where, gpg_error_t err);
208 void write_status_errcode (const char *where, int errcode);
209 void write_status_failure (const char *where, gpg_error_t err);
210 void write_status_text ( int no, const char *text );
211 void write_status_printf (int no, const char *format,
212                           ...) GPGRT_ATTR_PRINTF(2,3);
213 void write_status_strings (int no, const char *text,
214                            ...) GPGRT_ATTR_SENTINEL(0);
215 void write_status_buffer ( int no,
216                            const char *buffer, size_t len, int wrap );
217 void write_status_text_and_buffer ( int no, const char *text,
218                                     const char *buffer, size_t len, int wrap );
219
220 void write_status_begin_signing (gcry_md_hd_t md);
221
222
223 int cpr_enabled(void);
224 char *cpr_get( const char *keyword, const char *prompt );
225 char *cpr_get_no_help( const char *keyword, const char *prompt );
226 char *cpr_get_utf8( const char *keyword, const char *prompt );
227 char *cpr_get_hidden( const char *keyword, const char *prompt );
228 void cpr_kill_prompt(void);
229 int  cpr_get_answer_is_yes_def (const char *keyword, const char *prompt,
230                                 int def_yes);
231 int  cpr_get_answer_is_yes( const char *keyword, const char *prompt );
232 int  cpr_get_answer_yes_no_quit( const char *keyword, const char *prompt );
233 int  cpr_get_answer_okay_cancel (const char *keyword,
234                                  const char *prompt,
235                                  int def_answer);
236
237 /*-- helptext.c --*/
238 void display_online_help( const char *keyword );
239
240 /*-- encode.c --*/
241 int setup_symkey (STRING2KEY **symkey_s2k,DEK **symkey_dek);
242 gpg_error_t encrypt_seskey (DEK *dek, aead_algo_t aead_algo, DEK **r_seskey,
243                             void **r_enckey, size_t *r_enckeylen);
244 aead_algo_t use_aead (pk_list_t pk_list, int algo);
245 int use_mdc (pk_list_t pk_list,int algo);
246 int encrypt_symmetric (const char *filename );
247 int encrypt_store (const char *filename );
248 int encrypt_crypt (ctrl_t ctrl, int filefd, const char *filename,
249                    strlist_t remusr, int use_symkey, pk_list_t provided_keys,
250                    int outputfd);
251 void encrypt_crypt_files (ctrl_t ctrl,
252                           int nfiles, char **files, strlist_t remusr);
253 int encrypt_filter (void *opaque, int control,
254                     iobuf_t a, byte *buf, size_t *ret_len);
255
256 int write_pubkey_enc (ctrl_t ctrl, PKT_public_key *pk, int throw_keyid,
257                       DEK *dek, iobuf_t out);
258
259 /*-- sign.c --*/
260 int sign_file (ctrl_t ctrl, strlist_t filenames, int detached, strlist_t locusr,
261                int do_encrypt, strlist_t remusr, const char *outfile );
262 int clearsign_file (ctrl_t ctrl,
263                     const char *fname, strlist_t locusr, const char *outfile);
264 int sign_symencrypt_file (ctrl_t ctrl, const char *fname, strlist_t locusr);
265
266 /*-- sig-check.c --*/
267 void sig_check_dump_stats (void);
268
269 /* SIG is a revocation signature.  Check if any of PK's designated
270    revokers generated it.  If so, return 0.  Note: this function
271    (correctly) doesn't care if the designated revoker is revoked.  */
272 int check_revocation_keys (ctrl_t ctrl, PKT_public_key *pk, PKT_signature *sig);
273 /* Check that the backsig BACKSIG from the subkey SUB_PK to its
274    primary key MAIN_PK is valid.  */
275 int check_backsig(PKT_public_key *main_pk,PKT_public_key *sub_pk,
276                   PKT_signature *backsig);
277 /* Check that the signature SIG over a key (e.g., a key binding or a
278    key revocation) is valid.  (To check signatures over data, use
279    check_signature.)  */
280 int check_key_signature (ctrl_t ctrl, kbnode_t root, kbnode_t sig,
281                          int *is_selfsig );
282 /* Like check_key_signature, but with the ability to specify some
283    additional parameters and get back additional information.  See the
284    documentation for the implementation for details.  */
285 int check_key_signature2 (ctrl_t ctrl, kbnode_t root, kbnode_t node,
286                           PKT_public_key *check_pk, PKT_public_key *ret_pk,
287                           int *is_selfsig, u32 *r_expiredate, int *r_expired);
288
289 /* Returns whether SIGNER generated the signature SIG over the packet
290    PACKET, which is a key, subkey or uid, and comes from the key block
291    KB.  If SIGNER is NULL, it is looked up based on the information in
292    SIG.  If not NULL, sets *IS_SELFSIG to indicate whether the
293    signature is a self-signature and *RET_PK to a copy of the signer's
294    key.  */
295 gpg_error_t check_signature_over_key_or_uid (ctrl_t ctrl,
296                                              PKT_public_key *signer,
297                                              PKT_signature *sig,
298                                              KBNODE kb, PACKET *packet,
299                                              int *is_selfsig,
300                                              PKT_public_key *ret_pk);
301
302
303 /*-- delkey.c --*/
304 gpg_error_t delete_keys (ctrl_t ctrl,
305                          strlist_t names, int secret, int allow_both);
306
307 /*-- keygen.c --*/
308 const char *get_default_pubkey_algo (void);
309 u32 parse_expire_string(const char *string);
310 u32 ask_expire_interval(int object,const char *def_expire);
311 u32 ask_expiredate(void);
312 unsigned int ask_key_flags (int algo, int subkey, unsigned int current);
313 const char *ask_curve (int *algo, int *subkey_algo, const char *current);
314 void quick_generate_keypair (ctrl_t ctrl, const char *uid, const char *algostr,
315                              const char *usagestr, const char *expirestr);
316 void generate_keypair (ctrl_t ctrl, int full, const char *fname,
317                        const char *card_serialno, int card_backup_key);
318 int keygen_set_std_prefs (const char *string,int personal);
319 PKT_user_id *keygen_get_std_prefs (void);
320 int keygen_add_key_expire( PKT_signature *sig, void *opaque );
321 int keygen_add_key_flags (PKT_signature *sig, void *opaque);
322 int keygen_add_std_prefs( PKT_signature *sig, void *opaque );
323 int keygen_upd_std_prefs( PKT_signature *sig, void *opaque );
324 int keygen_add_keyserver_url(PKT_signature *sig, void *opaque);
325 int keygen_add_notations(PKT_signature *sig,void *opaque);
326 int keygen_add_revkey(PKT_signature *sig, void *opaque);
327 gpg_error_t make_backsig (ctrl_t ctrl,
328                           PKT_signature *sig, PKT_public_key *pk,
329                           PKT_public_key *sub_pk, PKT_public_key *sub_psk,
330                           u32 timestamp, const char *cache_nonce);
331 gpg_error_t generate_subkeypair (ctrl_t ctrl, kbnode_t keyblock,
332                                  const char *algostr,
333                                  const char *usagestr,
334                                  const char *expirestr);
335 #ifdef ENABLE_CARD_SUPPORT
336 gpg_error_t generate_card_subkeypair (ctrl_t ctrl, kbnode_t pub_keyblock,
337                                       int keyno, const char *serialno);
338 #endif
339
340
341 /*-- openfile.c --*/
342 int overwrite_filep( const char *fname );
343 char *make_outfile_name( const char *iname );
344 char *ask_outfile_name( const char *name, size_t namelen );
345 int open_outfile (int out_fd, const char *iname, int mode,
346                   int restrictedperm, iobuf_t *a);
347 char *get_matching_datafile (const char *sigfilename);
348 iobuf_t open_sigfile (const char *sigfilename, progress_filter_context_t *pfx);
349 void try_make_homedir( const char *fname );
350 char *get_openpgp_revocdir (const char *home);
351
352 /*-- seskey.c --*/
353 void make_session_key( DEK *dek );
354 gcry_mpi_t encode_session_key( int openpgp_pk_algo, DEK *dek, unsigned nbits );
355 gcry_mpi_t encode_md_value (PKT_public_key *pk,
356                             gcry_md_hd_t md, int hash_algo );
357
358 /*-- import.c --*/
359 struct import_stats_s;
360 typedef struct import_stats_s *import_stats_t;
361 struct import_filter_s;
362 typedef struct import_filter_s *import_filter_t;
363 typedef gpg_error_t (*import_screener_t)(kbnode_t keyblock, void *arg);
364
365 int parse_import_options(char *str,unsigned int *options,int noisy);
366
367 gpg_error_t parse_and_set_import_filter (const char *string);
368 import_filter_t save_and_clear_import_filter (void);
369 void            restore_import_filter (import_filter_t filt);
370
371 gpg_error_t read_key_from_file (ctrl_t ctrl, const char *fname,
372                                 kbnode_t *r_keyblock);
373 void import_keys (ctrl_t ctrl, char **fnames, int nnames,
374                   import_stats_t stats_hd, unsigned int options,
375                   int origin, const char *url);
376 gpg_error_t 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                            int origin, const char *url);
382 gpg_error_t import_old_secring (ctrl_t ctrl, const char *fname);
383 import_stats_t import_new_stats_handle (void);
384 void import_release_stats_handle (import_stats_t hd);
385 void import_print_stats (import_stats_t hd);
386 /* Communication for impex_filter_getval */
387 struct impex_filter_parm_s
388 {
389   ctrl_t ctrl;
390   kbnode_t node;
391 };
392
393 const char *impex_filter_getval (void *cookie, const char *propname);
394 gpg_error_t transfer_secret_keys (ctrl_t ctrl, struct import_stats_s *stats,
395                                   kbnode_t sec_keyblock, int batch, int force);
396
397 int collapse_uids( KBNODE *keyblock );
398
399 int get_revocation_reason (PKT_signature *sig, char **r_reason,
400                            char **r_comment, size_t *r_commentlen);
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*/