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