Imported Upstream version 2.2.20
[platform/upstream/gpg2.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 "../common/util.h"
26 #include "keydb.h"
27 #include "keyedit.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_sha1_keysig_rejected_note (void);
95 void print_reported_error (gpg_error_t err, gpg_err_code_t skip_if_ec);
96 void print_further_info (const char *format, ...) GPGRT_ATTR_PRINTF(1,2);
97 void additional_weak_digest (const char* digestname);
98
99 /*-- armor.c --*/
100 char *make_radix64_string( const byte *data, size_t len );
101
102 /*-- misc.c --*/
103 void trap_unaligned(void);
104 void register_secured_file (const char *fname);
105 void unregister_secured_file (const char *fname);
106 int  is_secured_file (int fd);
107 int  is_secured_filename (const char *fname);
108 u16 checksum_u16( unsigned n );
109 u16 checksum( byte *p, unsigned n );
110 u16 checksum_mpi( gcry_mpi_t a );
111 u32 buffer_to_u32( const byte *buffer );
112 const byte *get_session_marker( size_t *rlen );
113
114 enum gcry_cipher_algos map_cipher_openpgp_to_gcry (cipher_algo_t algo);
115 #define openpgp_cipher_open(_a,_b,_c,_d) \
116   gcry_cipher_open((_a),map_cipher_openpgp_to_gcry((_b)),(_c),(_d))
117 #define openpgp_cipher_get_algo_keylen(_a) \
118   gcry_cipher_get_algo_keylen(map_cipher_openpgp_to_gcry((_a)))
119 #define openpgp_cipher_get_algo_blklen(_a) \
120   gcry_cipher_get_algo_blklen(map_cipher_openpgp_to_gcry((_a)))
121 int openpgp_cipher_blocklen (cipher_algo_t algo);
122 int openpgp_cipher_test_algo(cipher_algo_t algo);
123 const char *openpgp_cipher_algo_name (cipher_algo_t algo);
124
125 pubkey_algo_t map_pk_gcry_to_openpgp (enum gcry_pk_algos algo);
126 int openpgp_pk_test_algo (pubkey_algo_t algo);
127 int openpgp_pk_test_algo2 (pubkey_algo_t algo, unsigned int use);
128 int openpgp_pk_algo_usage ( int algo );
129 const char *openpgp_pk_algo_name (pubkey_algo_t algo);
130
131 enum gcry_md_algos map_md_openpgp_to_gcry (digest_algo_t algo);
132 int openpgp_md_test_algo (digest_algo_t algo);
133 const char *openpgp_md_algo_name (int algo);
134
135 struct expando_args
136 {
137   PKT_public_key *pk;
138   PKT_public_key *pksk;
139   byte imagetype;
140   int validity_info;
141   const char *validity_string;
142   const byte *namehash;
143 };
144
145 char *pct_expando(const char *string,struct expando_args *args);
146 void deprecated_warning(const char *configname,unsigned int configlineno,
147                         const char *option,const char *repl1,const char *repl2);
148 void deprecated_command (const char *name);
149 void obsolete_scdaemon_option (const char *configname,
150                                unsigned int configlineno, const char *name);
151
152 int string_to_cipher_algo (const char *string);
153 int string_to_digest_algo (const char *string);
154
155 const char *compress_algo_to_string(int algo);
156 int string_to_compress_algo(const char *string);
157 int check_compress_algo(int algo);
158 int default_cipher_algo(void);
159 int default_compress_algo(void);
160 void compliance_failure(void);
161
162 struct parse_options
163 {
164   char *name;
165   unsigned int bit;
166   char **value;
167   char *help;
168 };
169
170 char *optsep(char **stringp);
171 char *argsplit(char *string);
172 int parse_options(char *str,unsigned int *options,
173                   struct parse_options *opts,int noisy);
174 const char *get_libexecdir (void);
175 int path_access(const char *file,int mode);
176
177 int pubkey_get_npkey (pubkey_algo_t algo);
178 int pubkey_get_nskey (pubkey_algo_t algo);
179 int pubkey_get_nsig (pubkey_algo_t algo);
180 int pubkey_get_nenc (pubkey_algo_t algo);
181
182 /* Temporary helpers. */
183 unsigned int pubkey_nbits( int algo, gcry_mpi_t *pkey );
184 int mpi_print (estream_t stream, gcry_mpi_t a, int mode);
185 unsigned int ecdsa_qbits_from_Q (unsigned int qbits);
186
187
188 /*-- cpr.c --*/
189 void set_status_fd ( int fd );
190 int  is_status_enabled ( void );
191 void write_status ( int no );
192 void write_status_error (const char *where, gpg_error_t err);
193 void write_status_errcode (const char *where, int errcode);
194 void write_status_failure (const char *where, gpg_error_t err);
195 void write_status_text ( int no, const char *text );
196 void write_status_printf (int no, const char *format,
197                           ...) GPGRT_ATTR_PRINTF(2,3);
198 void write_status_strings (int no, const char *text,
199                            ...) GPGRT_ATTR_SENTINEL(0);
200 void write_status_buffer ( int no,
201                            const char *buffer, size_t len, int wrap );
202 void write_status_text_and_buffer ( int no, const char *text,
203                                     const char *buffer, size_t len, int wrap );
204
205 void write_status_begin_signing (gcry_md_hd_t md);
206
207
208 int cpr_enabled(void);
209 char *cpr_get( const char *keyword, const char *prompt );
210 char *cpr_get_no_help( const char *keyword, const char *prompt );
211 char *cpr_get_utf8( const char *keyword, const char *prompt );
212 char *cpr_get_hidden( const char *keyword, const char *prompt );
213 void cpr_kill_prompt(void);
214 int  cpr_get_answer_is_yes_def (const char *keyword, const char *prompt,
215                                 int def_yes);
216 int  cpr_get_answer_is_yes( const char *keyword, const char *prompt );
217 int  cpr_get_answer_yes_no_quit( const char *keyword, const char *prompt );
218 int  cpr_get_answer_okay_cancel (const char *keyword,
219                                  const char *prompt,
220                                  int def_answer);
221
222 /*-- helptext.c --*/
223 void display_online_help( const char *keyword );
224
225 /*-- encode.c --*/
226 int setup_symkey (STRING2KEY **symkey_s2k,DEK **symkey_dek);
227 void encrypt_seskey (DEK *dek, DEK **seskey, byte *enckey);
228 int use_mdc (pk_list_t pk_list,int algo);
229 int encrypt_symmetric (const char *filename );
230 int encrypt_store (const char *filename );
231 int encrypt_crypt (ctrl_t ctrl, int filefd, const char *filename,
232                    strlist_t remusr, int use_symkey, pk_list_t provided_keys,
233                    int outputfd);
234 void encrypt_crypt_files (ctrl_t ctrl,
235                           int nfiles, char **files, strlist_t remusr);
236 int encrypt_filter (void *opaque, int control,
237                     iobuf_t a, byte *buf, size_t *ret_len);
238
239 int write_pubkey_enc (ctrl_t ctrl, PKT_public_key *pk, int throw_keyid,
240                       DEK *dek, iobuf_t out);
241
242 /*-- sign.c --*/
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 void sig_check_dump_stats (void);
251
252 /* SIG is a revocation signature.  Check if any of PK's designated
253    revokers generated it.  If so, return 0.  Note: this function
254    (correctly) doesn't care if the designated revoker is revoked.  */
255 int check_revocation_keys (ctrl_t ctrl, PKT_public_key *pk, PKT_signature *sig);
256 /* Check that the backsig BACKSIG from the subkey SUB_PK to its
257    primary key MAIN_PK is valid.  */
258 int check_backsig(PKT_public_key *main_pk,PKT_public_key *sub_pk,
259                   PKT_signature *backsig);
260 /* Check that the signature SIG over a key (e.g., a key binding or a
261    key revocation) is valid.  (To check signatures over data, use
262    check_signature.)  */
263 int check_key_signature (ctrl_t ctrl, kbnode_t root, kbnode_t sig,
264                          int *is_selfsig );
265 /* Like check_key_signature, but with the ability to specify some
266    additional parameters and get back additional information.  See the
267    documentation for the implementation for details.  */
268 int check_key_signature2 (ctrl_t ctrl, kbnode_t root, kbnode_t node,
269                           PKT_public_key *check_pk, PKT_public_key *ret_pk,
270                           int *is_selfsig, u32 *r_expiredate, int *r_expired);
271
272 /* Returns whether SIGNER generated the signature SIG over the packet
273    PACKET, which is a key, subkey or uid, and comes from the key block
274    KB.  If SIGNER is NULL, it is looked up based on the information in
275    SIG.  If not NULL, sets *IS_SELFSIG to indicate whether the
276    signature is a self-signature and *RET_PK to a copy of the signer's
277    key.  */
278 gpg_error_t check_signature_over_key_or_uid (ctrl_t ctrl,
279                                              PKT_public_key *signer,
280                                              PKT_signature *sig,
281                                              KBNODE kb, PACKET *packet,
282                                              int *is_selfsig,
283                                              PKT_public_key *ret_pk);
284
285
286 /*-- delkey.c --*/
287 gpg_error_t delete_keys (ctrl_t ctrl,
288                          strlist_t names, int secret, int allow_both);
289
290 /*-- keygen.c --*/
291 const char *get_default_pubkey_algo (void);
292 u32 parse_expire_string(const char *string);
293 u32 ask_expire_interval(int object,const char *def_expire);
294 u32 ask_expiredate(void);
295 unsigned int ask_key_flags (int algo, int subkey, unsigned int current);
296 const char *ask_curve (int *algo, int *subkey_algo, const char *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_or_buffer (ctrl_t ctrl, const char *fname,
355                                           const void *buffer, size_t buflen,
356                                           kbnode_t *r_keyblock);
357 gpg_error_t import_included_key_block (ctrl_t ctrl, kbnode_t keyblock);
358 void import_keys (ctrl_t ctrl, char **fnames, int nnames,
359                   import_stats_t stats_hd, unsigned int options,
360                   int origin, const char *url);
361 gpg_error_t import_keys_es_stream (ctrl_t ctrl, estream_t fp,
362                            import_stats_t stats_handle,
363                            unsigned char **fpr, size_t *fpr_len,
364                            unsigned int options,
365                            import_screener_t screener, void *screener_arg,
366                            int origin, const char *url);
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 /* Communication for impex_filter_getval */
372 struct impex_filter_parm_s
373 {
374   ctrl_t ctrl;
375   kbnode_t node;
376   char hexfpr[2*MAX_FINGERPRINT_LEN + 1];
377 };
378
379 const char *impex_filter_getval (void *cookie, const char *propname);
380 gpg_error_t transfer_secret_keys (ctrl_t ctrl, struct import_stats_s *stats,
381                                   kbnode_t sec_keyblock, int batch, int force,
382                                   int only_marked);
383
384 int collapse_uids( KBNODE *keyblock );
385
386 int get_revocation_reason (PKT_signature *sig, char **r_reason,
387                            char **r_comment, size_t *r_commentlen);
388
389
390 /*-- export.c --*/
391 struct export_stats_s;
392 typedef struct export_stats_s *export_stats_t;
393
394 export_stats_t export_new_stats (void);
395 void export_release_stats (export_stats_t stats);
396 void export_print_stats (export_stats_t stats);
397
398 int parse_export_options(char *str,unsigned int *options,int noisy);
399 gpg_error_t parse_and_set_export_filter (const char *string);
400 void push_export_filters (void);
401 void pop_export_filters (void);
402
403 int exact_subkey_match_p (KEYDB_SEARCH_DESC *desc, kbnode_t node);
404
405 int export_pubkeys (ctrl_t ctrl, strlist_t users, unsigned int options,
406                     export_stats_t stats);
407 int export_seckeys (ctrl_t ctrl, strlist_t users, unsigned int options,
408                     export_stats_t stats);
409 int export_secsubkeys (ctrl_t ctrl, strlist_t users, unsigned int options,
410                        export_stats_t stats);
411
412 gpg_error_t export_pubkey_buffer (ctrl_t ctrl, const char *keyspec,
413                                   unsigned int options,
414                                   const void *prefix, size_t prefixlen,
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,
449                       int locate_mode, int no_local);
450 void secret_key_list (ctrl_t ctrl, strlist_t list );
451 void print_subpackets_colon(PKT_signature *sig);
452 void reorder_keyblock (KBNODE keyblock);
453 void list_keyblock_direct (ctrl_t ctrl, kbnode_t keyblock, int secret,
454                            int has_secret, int fpr, int no_validity);
455 void print_fingerprint (ctrl_t ctrl, estream_t fp,
456                         PKT_public_key *pk, int mode);
457 void print_revokers (estream_t fp, PKT_public_key *pk);
458 void show_policy_url(PKT_signature *sig,int indent,int mode);
459 void show_keyserver_url(PKT_signature *sig,int indent,int mode);
460 void show_notation(PKT_signature *sig,int indent,int mode,int which);
461 void dump_attribs (const PKT_user_id *uid, PKT_public_key *pk);
462 void set_attrib_fd(int fd);
463 char *format_seckey_info (ctrl_t ctrl, PKT_public_key *pk);
464 void print_seckey_info (ctrl_t ctrl, PKT_public_key *pk);
465 void print_pubkey_info (ctrl_t ctrl, estream_t fp, PKT_public_key *pk);
466 void print_card_key_info (estream_t fp, KBNODE keyblock);
467 void print_key_line (ctrl_t ctrl, estream_t fp, PKT_public_key *pk, int secret);
468
469 /*-- verify.c --*/
470 void print_file_status( int status, const char *name, int what );
471 int verify_signatures (ctrl_t ctrl, int nfiles, char **files );
472 int verify_files (ctrl_t ctrl, int nfiles, char **files );
473 int gpg_verify (ctrl_t ctrl, int sig_fd, int data_fd, estream_t out_fp);
474
475 /*-- decrypt.c --*/
476 int decrypt_message (ctrl_t ctrl, const char *filename );
477 gpg_error_t decrypt_message_fd (ctrl_t ctrl, int input_fd, int output_fd);
478 void decrypt_messages (ctrl_t ctrl, int nfiles, char *files[]);
479
480 /*-- plaintext.c --*/
481 int hash_datafiles( gcry_md_hd_t md, gcry_md_hd_t md2,
482                     strlist_t files, const char *sigfilename, int textmode);
483 int hash_datafile_by_fd ( gcry_md_hd_t md, gcry_md_hd_t md2, int data_fd,
484                           int textmode );
485 PKT_plaintext *setup_plaintext_name(const char *filename,IOBUF iobuf);
486
487 /*-- server.c --*/
488 int gpg_server (ctrl_t);
489 gpg_error_t gpg_proxy_pinentry_notify (ctrl_t ctrl,
490                                        const unsigned char *line);
491
492 #ifdef ENABLE_CARD_SUPPORT
493 /*-- card-util.c --*/
494 void change_pin (int no, int allow_admin);
495 void card_status (ctrl_t ctrl, estream_t fp, const char *serialno);
496 void card_edit (ctrl_t ctrl, strlist_t commands);
497 gpg_error_t  card_generate_subkey (ctrl_t ctrl, kbnode_t pub_keyblock);
498 int  card_store_subkey (KBNODE node, int use);
499 #endif
500
501 #define S2K_DECODE_COUNT(_val) ((16ul + ((_val) & 15)) << (((_val) >> 4) + 6))
502
503 /*-- migrate.c --*/
504 void migrate_secring (ctrl_t ctrl);
505
506
507 #endif /*G10_MAIN_H*/