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