2 * Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
3 * 2008, 2009, 2010 Free Software Foundation, Inc.
5 * This file is part of GnuPG.
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.
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.
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/>.
23 #include "../common/types.h"
24 #include "../common/iobuf.h"
26 #include "../common/util.h"
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. */
34 # define DEFAULT_CIPHER_ALGO CIPHER_ALGO_AES
36 # define DEFAULT_CIPHER_ALGO CIPHER_ALGO_CAST5
38 # define DEFAULT_CIPHER_ALGO CIPHER_ALGO_3DES
41 #define DEFAULT_DIGEST_ALGO ((GNUPG)? DIGEST_ALGO_SHA256:DIGEST_ALGO_SHA1)
42 #define DEFAULT_S2K_DIGEST_ALGO DIGEST_ALGO_SHA1
44 # define DEFAULT_COMPRESS_ALGO COMPRESS_ALGO_ZIP
46 # define DEFAULT_COMPRESS_ALGO COMPRESS_ALGO_NONE
50 #define S2K_DIGEST_ALGO (opt.s2k_digest_algo?opt.s2k_digest_algo:DEFAULT_S2K_DIGEST_ALGO)
53 /* Various data objects. */
61 STRING2KEY *symkey_s2k;
62 cipher_filter_context_t cfx;
63 } encrypt_filter_context_t;
70 struct groupitem *next;
75 enum gcry_md_algos algo;
77 struct weakhash *next;
82 extern int g10_errors_seen;
84 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 5 )
85 void g10_exit(int rc) __attribute__ ((noreturn));
87 void g10_exit(int rc);
89 void print_pubkey_algo_note (pubkey_algo_t algo);
90 void print_cipher_algo_note (cipher_algo_t algo);
91 void print_digest_algo_note (digest_algo_t algo);
92 void print_digest_rejected_note (enum gcry_md_algos algo);
93 void print_reported_error (gpg_error_t err, gpg_err_code_t skip_if_ec);
94 void print_further_info (const char *format, ...) GPGRT_ATTR_PRINTF(1,2);
95 void additional_weak_digest (const char* digestname);
98 char *make_radix64_string( const byte *data, size_t len );
101 void trap_unaligned(void);
102 void register_secured_file (const char *fname);
103 void unregister_secured_file (const char *fname);
104 int is_secured_file (int fd);
105 int is_secured_filename (const char *fname);
106 u16 checksum_u16( unsigned n );
107 u16 checksum( byte *p, unsigned n );
108 u16 checksum_mpi( gcry_mpi_t a );
109 u32 buffer_to_u32( const byte *buffer );
110 const byte *get_session_marker( size_t *rlen );
112 enum gcry_cipher_algos map_cipher_openpgp_to_gcry (cipher_algo_t algo);
113 #define openpgp_cipher_open(_a,_b,_c,_d) \
114 gcry_cipher_open((_a),map_cipher_openpgp_to_gcry((_b)),(_c),(_d))
115 #define openpgp_cipher_get_algo_keylen(_a) \
116 gcry_cipher_get_algo_keylen(map_cipher_openpgp_to_gcry((_a)))
117 #define openpgp_cipher_get_algo_blklen(_a) \
118 gcry_cipher_get_algo_blklen(map_cipher_openpgp_to_gcry((_a)))
119 int openpgp_cipher_blocklen (cipher_algo_t algo);
120 int openpgp_cipher_test_algo(cipher_algo_t algo);
121 const char *openpgp_cipher_algo_name (cipher_algo_t algo);
123 pubkey_algo_t map_pk_gcry_to_openpgp (enum gcry_pk_algos algo);
124 int openpgp_pk_test_algo (pubkey_algo_t algo);
125 int openpgp_pk_test_algo2 (pubkey_algo_t algo, unsigned int use);
126 int openpgp_pk_algo_usage ( int algo );
127 const char *openpgp_pk_algo_name (pubkey_algo_t algo);
129 int gnupg_pk_is_compliant (int compliance, PKT_public_key *pk,
130 unsigned int keylength, const char *curvename);
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);
139 PKT_public_key *pksk;
142 const char *validity_string;
143 const byte *namehash;
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);
153 int string_to_cipher_algo (const char *string);
154 int string_to_digest_algo (const char *string);
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 const char *compliance_option_string(void);
162 void compliance_failure(void);
172 char *optsep(char **stringp);
173 char *argsplit(char *string);
174 int parse_options(char *str,unsigned int *options,
175 struct parse_options *opts,int noisy);
176 const char *get_libexecdir (void);
177 int path_access(const char *file,int mode);
179 int pubkey_get_npkey (pubkey_algo_t algo);
180 int pubkey_get_nskey (pubkey_algo_t algo);
181 int pubkey_get_nsig (pubkey_algo_t algo);
182 int pubkey_get_nenc (pubkey_algo_t algo);
184 /* Temporary helpers. */
185 unsigned int pubkey_nbits( int algo, gcry_mpi_t *pkey );
186 int mpi_print (estream_t stream, gcry_mpi_t a, int mode);
187 unsigned int ecdsa_qbits_from_Q (unsigned int qbits);
191 void set_status_fd ( int fd );
192 int is_status_enabled ( void );
193 void write_status ( int no );
194 void write_status_error (const char *where, gpg_error_t err);
195 void write_status_errcode (const char *where, int errcode);
196 void write_status_failure (const char *where, gpg_error_t err);
197 void write_status_text ( int no, const char *text );
198 void write_status_printf (int no, const char *format,
199 ...) GPGRT_ATTR_PRINTF(2,3);
200 void write_status_strings (int no, const char *text,
201 ...) GPGRT_ATTR_SENTINEL(0);
202 void write_status_buffer ( int no,
203 const char *buffer, size_t len, int wrap );
204 void write_status_text_and_buffer ( int no, const char *text,
205 const char *buffer, size_t len, int wrap );
207 void write_status_begin_signing (gcry_md_hd_t md);
210 int cpr_enabled(void);
211 char *cpr_get( const char *keyword, const char *prompt );
212 char *cpr_get_no_help( const char *keyword, const char *prompt );
213 char *cpr_get_utf8( const char *keyword, const char *prompt );
214 char *cpr_get_hidden( const char *keyword, const char *prompt );
215 void cpr_kill_prompt(void);
216 int cpr_get_answer_is_yes_def (const char *keyword, const char *prompt,
218 int cpr_get_answer_is_yes( const char *keyword, const char *prompt );
219 int cpr_get_answer_yes_no_quit( const char *keyword, const char *prompt );
220 int cpr_get_answer_okay_cancel (const char *keyword,
225 void display_online_help( const char *keyword );
228 int setup_symkey (STRING2KEY **symkey_s2k,DEK **symkey_dek);
229 void encrypt_seskey (DEK *dek, DEK **seskey, byte *enckey);
230 int use_mdc (pk_list_t pk_list,int algo);
231 int encrypt_symmetric (const char *filename );
232 int encrypt_store (const char *filename );
233 int encrypt_crypt (ctrl_t ctrl, int filefd, const char *filename,
234 strlist_t remusr, int use_symkey, pk_list_t provided_keys,
236 void encrypt_crypt_files (ctrl_t ctrl,
237 int nfiles, char **files, strlist_t remusr);
238 int encrypt_filter (void *opaque, int control,
239 iobuf_t a, byte *buf, size_t *ret_len);
241 int write_pubkey_enc (ctrl_t ctrl, PKT_public_key *pk, int throw_keyid,
242 DEK *dek, iobuf_t out);
245 int complete_sig (ctrl_t ctrl, PKT_signature *sig, PKT_public_key *pksk,
246 gcry_md_hd_t md, const char *cache_nonce);
247 int sign_file (ctrl_t ctrl, strlist_t filenames, int detached, strlist_t locusr,
248 int do_encrypt, strlist_t remusr, const char *outfile );
249 int clearsign_file (ctrl_t ctrl,
250 const char *fname, strlist_t locusr, const char *outfile);
251 int sign_symencrypt_file (ctrl_t ctrl, const char *fname, strlist_t locusr);
253 /*-- sig-check.c --*/
254 void sig_check_dump_stats (void);
256 /* SIG is a revocation signature. Check if any of PK's designated
257 revokers generated it. If so, return 0. Note: this function
258 (correctly) doesn't care if the designated revoker is revoked. */
259 int check_revocation_keys (ctrl_t ctrl, PKT_public_key *pk, PKT_signature *sig);
260 /* Check that the backsig BACKSIG from the subkey SUB_PK to its
261 primary key MAIN_PK is valid. */
262 int check_backsig(PKT_public_key *main_pk,PKT_public_key *sub_pk,
263 PKT_signature *backsig);
264 /* Check that the signature SIG over a key (e.g., a key binding or a
265 key revocation) is valid. (To check signatures over data, use
267 int check_key_signature (ctrl_t ctrl, kbnode_t root, kbnode_t sig,
269 /* Like check_key_signature, but with the ability to specify some
270 additional parameters and get back additional information. See the
271 documentation for the implementation for details. */
272 int check_key_signature2 (ctrl_t ctrl, kbnode_t root, kbnode_t node,
273 PKT_public_key *check_pk, PKT_public_key *ret_pk,
274 int *is_selfsig, u32 *r_expiredate, int *r_expired);
276 /* Returns whether SIGNER generated the signature SIG over the packet
277 PACKET, which is a key, subkey or uid, and comes from the key block
278 KB. If SIGNER is NULL, it is looked up based on the information in
279 SIG. If not NULL, sets *IS_SELFSIG to indicate whether the
280 signature is a self-signature and *RET_PK to a copy of the signer's
282 gpg_error_t check_signature_over_key_or_uid (ctrl_t ctrl,
283 PKT_public_key *signer,
285 KBNODE kb, PACKET *packet,
287 PKT_public_key *ret_pk);
291 gpg_error_t delete_keys (ctrl_t ctrl,
292 strlist_t names, int secret, int allow_both);
295 void keyedit_menu (ctrl_t ctrl, const char *username, strlist_t locusr,
296 strlist_t commands, int quiet, int seckey_check );
297 void keyedit_passwd (ctrl_t ctrl, const char *username);
298 void keyedit_quick_adduid (ctrl_t ctrl, const char *username,
300 void keyedit_quick_addkey (ctrl_t ctrl, const char *fpr, const char *algostr,
301 const char *usagestr, const char *expirestr);
302 void keyedit_quick_revuid (ctrl_t ctrl, const char *username,
303 const char *uidtorev);
304 void keyedit_quick_sign (ctrl_t ctrl, const char *fpr,
305 strlist_t uids, strlist_t locusr, int local);
306 void keyedit_quick_set_expire (ctrl_t ctrl,
307 const char *fpr, const char *expirestr);
308 void keyedit_quick_set_primary (ctrl_t ctrl, const char *username,
309 const char *primaryuid);
310 void show_basic_key_info (ctrl_t ctrl, kbnode_t keyblock);
313 const char *get_default_pubkey_algo (void);
314 u32 parse_expire_string(const char *string);
315 u32 ask_expire_interval(int object,const char *def_expire);
316 u32 ask_expiredate(void);
317 unsigned int ask_key_flags (int algo, int subkey, unsigned int current);
318 void quick_generate_keypair (ctrl_t ctrl, const char *uid, const char *algostr,
319 const char *usagestr, const char *expirestr);
320 void generate_keypair (ctrl_t ctrl, int full, const char *fname,
321 const char *card_serialno, int card_backup_key);
322 int keygen_set_std_prefs (const char *string,int personal);
323 PKT_user_id *keygen_get_std_prefs (void);
324 int keygen_add_key_expire( PKT_signature *sig, void *opaque );
325 int keygen_add_key_flags (PKT_signature *sig, void *opaque);
326 int keygen_add_std_prefs( PKT_signature *sig, void *opaque );
327 int keygen_upd_std_prefs( PKT_signature *sig, void *opaque );
328 int keygen_add_keyserver_url(PKT_signature *sig, void *opaque);
329 int keygen_add_notations(PKT_signature *sig,void *opaque);
330 int keygen_add_revkey(PKT_signature *sig, void *opaque);
331 gpg_error_t make_backsig (ctrl_t ctrl,
332 PKT_signature *sig, PKT_public_key *pk,
333 PKT_public_key *sub_pk, PKT_public_key *sub_psk,
334 u32 timestamp, const char *cache_nonce);
335 gpg_error_t generate_subkeypair (ctrl_t ctrl, kbnode_t keyblock,
337 const char *usagestr,
338 const char *expirestr);
339 #ifdef ENABLE_CARD_SUPPORT
340 gpg_error_t generate_card_subkeypair (ctrl_t ctrl, kbnode_t pub_keyblock,
341 int keyno, const char *serialno);
346 int overwrite_filep( const char *fname );
347 char *make_outfile_name( const char *iname );
348 char *ask_outfile_name( const char *name, size_t namelen );
349 int open_outfile (int inp_fd, const char *iname, int mode,
350 int restrictedperm, iobuf_t *a);
351 char *get_matching_datafile (const char *sigfilename);
352 iobuf_t open_sigfile (const char *sigfilename, progress_filter_context_t *pfx);
353 void try_make_homedir( const char *fname );
354 char *get_openpgp_revocdir (const char *home);
357 void make_session_key( DEK *dek );
358 gcry_mpi_t encode_session_key( int openpgp_pk_algo, DEK *dek, unsigned nbits );
359 gcry_mpi_t encode_md_value (PKT_public_key *pk,
360 gcry_md_hd_t md, int hash_algo );
363 struct import_stats_s;
364 typedef struct import_stats_s *import_stats_t;
365 struct import_filter_s;
366 typedef struct import_filter_s *import_filter_t;
367 typedef gpg_error_t (*import_screener_t)(kbnode_t keyblock, void *arg);
369 int parse_import_options(char *str,unsigned int *options,int noisy);
371 gpg_error_t parse_and_set_import_filter (const char *string);
372 import_filter_t save_and_clear_import_filter (void);
373 void restore_import_filter (import_filter_t filt);
375 gpg_error_t read_key_from_file (ctrl_t ctrl, const char *fname,
376 kbnode_t *r_keyblock);
377 void import_keys (ctrl_t ctrl, char **fnames, int nnames,
378 import_stats_t stats_hd, unsigned int options);
379 int import_keys_stream (ctrl_t ctrl, iobuf_t inp, import_stats_t stats_hd,
381 size_t *fpr_len, unsigned int options);
382 int import_keys_es_stream (ctrl_t ctrl, estream_t fp,
383 import_stats_t stats_handle,
384 unsigned char **fpr, size_t *fpr_len,
385 unsigned int options,
386 import_screener_t screener, void *screener_arg);
387 gpg_error_t import_old_secring (ctrl_t ctrl, const char *fname);
388 import_stats_t import_new_stats_handle (void);
389 void import_release_stats_handle (import_stats_t hd);
390 void import_print_stats (import_stats_t hd);
391 /* Communication for impex_filter_getval */
392 struct impex_filter_parm_s
398 const char *impex_filter_getval (void *cookie, const char *propname);
399 gpg_error_t transfer_secret_keys (ctrl_t ctrl, struct import_stats_s *stats,
400 kbnode_t sec_keyblock, int batch, int force);
402 int collapse_uids( KBNODE *keyblock );
406 struct export_stats_s;
407 typedef struct export_stats_s *export_stats_t;
409 export_stats_t export_new_stats (void);
410 void export_release_stats (export_stats_t stats);
411 void export_print_stats (export_stats_t stats);
413 int parse_export_options(char *str,unsigned int *options,int noisy);
414 gpg_error_t parse_and_set_export_filter (const char *string);
416 int export_pubkeys (ctrl_t ctrl, strlist_t users, unsigned int options,
417 export_stats_t stats);
418 int export_seckeys (ctrl_t ctrl, strlist_t users, unsigned int options,
419 export_stats_t stats);
420 int export_secsubkeys (ctrl_t ctrl, strlist_t users, unsigned int options,
421 export_stats_t stats);
423 gpg_error_t export_pubkey_buffer (ctrl_t ctrl, const char *keyspec,
424 unsigned int options,
425 export_stats_t stats,
426 kbnode_t *r_keyblock,
427 void **r_data, size_t *r_datalen);
429 gpg_error_t receive_seckey_from_agent (ctrl_t ctrl, gcry_cipher_hd_t cipherhd,
431 char **cache_nonce_addr,
435 gpg_error_t write_keyblock_to_output (kbnode_t keyblock,
436 int with_armor, unsigned int options);
438 gpg_error_t export_ssh_key (ctrl_t ctrl, const char *userid);
441 int dearmor_file( const char *fname );
442 int enarmor_file( const char *fname );
445 struct revocation_reason_info;
447 int gen_standard_revoke (ctrl_t ctrl,
448 PKT_public_key *psk, const char *cache_nonce);
449 int gen_revoke (ctrl_t ctrl, const char *uname);
450 int gen_desig_revoke (ctrl_t ctrl, const char *uname, strlist_t locusr);
451 int revocation_reason_build_cb( PKT_signature *sig, void *opaque );
452 struct revocation_reason_info *
453 ask_revocation_reason( int key_rev, int cert_rev, int hint );
454 struct revocation_reason_info * get_default_uid_revocation_reason(void);
455 void release_revocation_reason_info( struct revocation_reason_info *reason );
458 void public_key_list (ctrl_t ctrl, strlist_t list, int locate_mode );
459 void secret_key_list (ctrl_t ctrl, strlist_t list );
460 void print_subpackets_colon(PKT_signature *sig);
461 void reorder_keyblock (KBNODE keyblock);
462 void list_keyblock_direct (ctrl_t ctrl, kbnode_t keyblock, int secret,
463 int has_secret, int fpr, int no_validity);
464 void print_fingerprint (ctrl_t ctrl, estream_t fp,
465 PKT_public_key *pk, int mode);
466 void print_revokers (estream_t fp, PKT_public_key *pk);
467 void show_policy_url(PKT_signature *sig,int indent,int mode);
468 void show_keyserver_url(PKT_signature *sig,int indent,int mode);
469 void show_notation(PKT_signature *sig,int indent,int mode,int which);
470 void dump_attribs (const PKT_user_id *uid, PKT_public_key *pk);
471 void set_attrib_fd(int fd);
472 char *format_seckey_info (ctrl_t ctrl, PKT_public_key *pk);
473 void print_seckey_info (ctrl_t ctrl, PKT_public_key *pk);
474 void print_pubkey_info (ctrl_t ctrl, estream_t fp, PKT_public_key *pk);
475 void print_card_key_info (estream_t fp, KBNODE keyblock);
476 void print_key_line (ctrl_t ctrl, estream_t fp, PKT_public_key *pk, int secret);
479 void print_file_status( int status, const char *name, int what );
480 int verify_signatures (ctrl_t ctrl, int nfiles, char **files );
481 int verify_files (ctrl_t ctrl, int nfiles, char **files );
482 int gpg_verify (ctrl_t ctrl, int sig_fd, int data_fd, estream_t out_fp);
485 int decrypt_message (ctrl_t ctrl, const char *filename );
486 gpg_error_t decrypt_message_fd (ctrl_t ctrl, int input_fd, int output_fd);
487 void decrypt_messages (ctrl_t ctrl, int nfiles, char *files[]);
489 /*-- plaintext.c --*/
490 int hash_datafiles( gcry_md_hd_t md, gcry_md_hd_t md2,
491 strlist_t files, const char *sigfilename, int textmode);
492 int hash_datafile_by_fd ( gcry_md_hd_t md, gcry_md_hd_t md2, int data_fd,
494 PKT_plaintext *setup_plaintext_name(const char *filename,IOBUF iobuf);
497 int gpg_server (ctrl_t);
498 gpg_error_t gpg_proxy_pinentry_notify (ctrl_t ctrl,
499 const unsigned char *line);
501 #ifdef ENABLE_CARD_SUPPORT
502 /*-- card-util.c --*/
503 void change_pin (int no, int allow_admin);
504 void card_status (ctrl_t ctrl, estream_t fp, const char *serialno);
505 void card_edit (ctrl_t ctrl, strlist_t commands);
506 gpg_error_t card_generate_subkey (ctrl_t ctrl, kbnode_t pub_keyblock);
507 int card_store_subkey (KBNODE node, int use);
510 #define S2K_DECODE_COUNT(_val) ((16ul + ((_val) & 15)) << (((_val) >> 4) + 6))
513 void migrate_secring (ctrl_t ctrl);
516 #endif /*G10_MAIN_H*/