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