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