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"
25 #include "../common/util.h"
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. */
35 # define DEFAULT_CIPHER_ALGO CIPHER_ALGO_AES
37 # define DEFAULT_CIPHER_ALGO CIPHER_ALGO_CAST5
39 # define DEFAULT_CIPHER_ALGO CIPHER_ALGO_3DES
42 #define DEFAULT_DIGEST_ALGO ((GNUPG)? DIGEST_ALGO_SHA256:DIGEST_ALGO_SHA1)
43 #define DEFAULT_S2K_DIGEST_ALGO DIGEST_ALGO_SHA1
45 # define DEFAULT_COMPRESS_ALGO COMPRESS_ALGO_ZIP
47 # define DEFAULT_COMPRESS_ALGO COMPRESS_ALGO_NONE
51 #define S2K_DIGEST_ALGO (opt.s2k_digest_algo?opt.s2k_digest_algo:DEFAULT_S2K_DIGEST_ALGO)
54 /* Various data objects. */
62 STRING2KEY *symkey_s2k;
63 cipher_filter_context_t cfx;
64 } encrypt_filter_context_t;
71 struct groupitem *next;
76 enum gcry_md_algos algo;
78 struct weakhash *next;
83 extern int g10_errors_seen;
85 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 5 )
86 void g10_exit(int rc) __attribute__ ((noreturn));
88 void g10_exit(int rc);
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 int is_weak_digest (digest_algo_t algo);
101 char *make_radix64_string( const byte *data, size_t len );
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 );
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 const char *openpgp_cipher_algo_mode_name (cipher_algo_t algo,
128 gpg_error_t openpgp_aead_test_algo (aead_algo_t algo);
129 const char *openpgp_aead_algo_name (aead_algo_t algo);
130 gpg_error_t openpgp_aead_algo_info (aead_algo_t algo,
131 enum gcry_cipher_modes *r_mode,
132 unsigned int *r_noncelen);
134 pubkey_algo_t map_pk_gcry_to_openpgp (enum gcry_pk_algos algo);
135 int openpgp_pk_test_algo (pubkey_algo_t algo);
136 int openpgp_pk_test_algo2 (pubkey_algo_t algo, unsigned int use);
137 int openpgp_pk_algo_usage ( int algo );
138 const char *openpgp_pk_algo_name (pubkey_algo_t algo);
140 enum gcry_md_algos map_md_openpgp_to_gcry (digest_algo_t algo);
141 int openpgp_md_test_algo (digest_algo_t algo);
142 const char *openpgp_md_algo_name (int algo);
147 PKT_public_key *pksk;
150 const char *validity_string;
151 const byte *namehash;
154 char *pct_expando(const char *string,struct expando_args *args);
155 void deprecated_warning(const char *configname,unsigned int configlineno,
156 const char *option,const char *repl1,const char *repl2);
157 void deprecated_command (const char *name);
158 void obsolete_scdaemon_option (const char *configname,
159 unsigned int configlineno, const char *name);
161 int string_to_cipher_algo (const char *string);
162 int string_to_digest_algo (const char *string);
164 const char *compress_algo_to_string(int algo);
165 int string_to_compress_algo(const char *string);
166 int check_compress_algo(int algo);
167 int default_cipher_algo(void);
168 int default_compress_algo(void);
169 void compliance_failure(void);
179 char *optsep(char **stringp);
180 char *argsplit(char *string);
181 int parse_options(char *str,unsigned int *options,
182 struct parse_options *opts,int noisy);
183 const char *get_libexecdir (void);
184 int path_access(const char *file,int mode);
186 int pubkey_get_npkey (pubkey_algo_t algo);
187 int pubkey_get_nskey (pubkey_algo_t algo);
188 int pubkey_get_nsig (pubkey_algo_t algo);
189 int pubkey_get_nenc (pubkey_algo_t algo);
191 /* Temporary helpers. */
192 unsigned int pubkey_nbits( int algo, gcry_mpi_t *pkey );
193 int mpi_print (estream_t stream, gcry_mpi_t a, int mode);
194 unsigned int ecdsa_qbits_from_Q (unsigned int qbits);
198 void set_status_fd ( int fd );
199 int is_status_enabled ( void );
200 void write_status ( int no );
201 void write_status_error (const char *where, gpg_error_t err);
202 void write_status_errcode (const char *where, int errcode);
203 void write_status_failure (const char *where, gpg_error_t err);
204 void write_status_text ( int no, const char *text );
205 void write_status_printf (int no, const char *format,
206 ...) GPGRT_ATTR_PRINTF(2,3);
207 void write_status_strings (int no, const char *text,
208 ...) GPGRT_ATTR_SENTINEL(0);
209 void write_status_buffer ( int no,
210 const char *buffer, size_t len, int wrap );
211 void write_status_text_and_buffer ( int no, const char *text,
212 const char *buffer, size_t len, int wrap );
214 void write_status_begin_signing (gcry_md_hd_t md);
217 int cpr_enabled(void);
218 char *cpr_get( const char *keyword, const char *prompt );
219 char *cpr_get_no_help( const char *keyword, const char *prompt );
220 char *cpr_get_utf8( const char *keyword, const char *prompt );
221 char *cpr_get_hidden( const char *keyword, const char *prompt );
222 void cpr_kill_prompt(void);
223 int cpr_get_answer_is_yes_def (const char *keyword, const char *prompt,
225 int cpr_get_answer_is_yes( const char *keyword, const char *prompt );
226 int cpr_get_answer_yes_no_quit( const char *keyword, const char *prompt );
227 int cpr_get_answer_okay_cancel (const char *keyword,
232 void display_online_help( const char *keyword );
235 gpg_error_t setup_symkey (STRING2KEY **symkey_s2k,DEK **symkey_dek);
236 void encrypt_seskey (DEK *dek, DEK **seskey, byte *enckey);
237 int use_mdc (pk_list_t pk_list,int algo);
238 int encrypt_symmetric (const char *filename );
239 int encrypt_store (const char *filename );
240 int encrypt_crypt (ctrl_t ctrl, int filefd, const char *filename,
241 strlist_t remusr, int use_symkey, pk_list_t provided_keys,
243 void encrypt_crypt_files (ctrl_t ctrl,
244 int nfiles, char **files, strlist_t remusr);
245 int encrypt_filter (void *opaque, int control,
246 iobuf_t a, byte *buf, size_t *ret_len);
248 int write_pubkey_enc (ctrl_t ctrl, PKT_public_key *pk, int throw_keyid,
249 DEK *dek, iobuf_t out);
252 int sign_file (ctrl_t ctrl, strlist_t filenames, int detached, strlist_t locusr,
253 int do_encrypt, strlist_t remusr, const char *outfile );
254 int clearsign_file (ctrl_t ctrl,
255 const char *fname, strlist_t locusr, const char *outfile);
256 int sign_symencrypt_file (ctrl_t ctrl, const char *fname, strlist_t locusr);
258 /*-- sig-check.c --*/
259 void sig_check_dump_stats (void);
261 /* SIG is a revocation signature. Check if any of PK's designated
262 revokers generated it. If so, return 0. Note: this function
263 (correctly) doesn't care if the designated revoker is revoked. */
264 int check_revocation_keys (ctrl_t ctrl, PKT_public_key *pk, PKT_signature *sig);
265 /* Check that the backsig BACKSIG from the subkey SUB_PK to its
266 primary key MAIN_PK is valid. */
267 int check_backsig(PKT_public_key *main_pk,PKT_public_key *sub_pk,
268 PKT_signature *backsig);
269 /* Check that the signature SIG over a key (e.g., a key binding or a
270 key revocation) is valid. (To check signatures over data, use
272 int check_key_signature (ctrl_t ctrl, kbnode_t root, kbnode_t sig,
274 /* Like check_key_signature, but with the ability to specify some
275 additional parameters and get back additional information. See the
276 documentation for the implementation for details. */
277 int check_key_signature2 (ctrl_t ctrl, kbnode_t root, kbnode_t node,
278 PKT_public_key *check_pk, PKT_public_key *ret_pk,
279 int *is_selfsig, u32 *r_expiredate, int *r_expired);
281 /* Returns whether SIGNER generated the signature SIG over the packet
282 PACKET, which is a key, subkey or uid, and comes from the key block
283 KB. If SIGNER is NULL, it is looked up based on the information in
284 SIG. If not NULL, sets *IS_SELFSIG to indicate whether the
285 signature is a self-signature and *RET_PK to a copy of the signer's
287 gpg_error_t check_signature_over_key_or_uid (ctrl_t ctrl,
288 PKT_public_key *signer,
290 KBNODE kb, PACKET *packet,
292 PKT_public_key *ret_pk);
296 gpg_error_t delete_keys (ctrl_t ctrl,
297 strlist_t names, int secret, int allow_both);
300 const char *get_default_pubkey_algo (void);
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 const char *ask_curve (int *algo, int *subkey_algo, const char *current);
306 void quick_generate_keypair (ctrl_t ctrl, const char *uid, const char *algostr,
307 const char *usagestr, const char *expirestr);
308 void generate_keypair (ctrl_t ctrl, int full, const char *fname,
309 const char *card_serialno, int card_backup_key);
310 int keygen_set_std_prefs (const char *string,int personal);
311 PKT_user_id *keygen_get_std_prefs (void);
312 int keygen_add_key_expire( PKT_signature *sig, void *opaque );
313 int keygen_add_key_flags (PKT_signature *sig, void *opaque);
314 int keygen_add_std_prefs( PKT_signature *sig, void *opaque );
315 int keygen_upd_std_prefs( PKT_signature *sig, void *opaque );
316 int keygen_add_keyserver_url(PKT_signature *sig, void *opaque);
317 int keygen_add_notations(PKT_signature *sig,void *opaque);
318 int keygen_add_revkey(PKT_signature *sig, void *opaque);
319 gpg_error_t make_backsig (ctrl_t ctrl,
320 PKT_signature *sig, PKT_public_key *pk,
321 PKT_public_key *sub_pk, PKT_public_key *sub_psk,
322 u32 timestamp, const char *cache_nonce);
323 gpg_error_t generate_subkeypair (ctrl_t ctrl, kbnode_t keyblock,
325 const char *usagestr,
326 const char *expirestr);
327 #ifdef ENABLE_CARD_SUPPORT
328 gpg_error_t generate_card_subkeypair (ctrl_t ctrl, kbnode_t pub_keyblock,
329 int keyno, const char *serialno);
334 int overwrite_filep( const char *fname );
335 char *make_outfile_name( const char *iname );
336 char *ask_outfile_name( const char *name, size_t namelen );
337 int open_outfile (int inp_fd, const char *iname, int mode,
338 int restrictedperm, iobuf_t *a);
339 char *get_matching_datafile (const char *sigfilename);
340 iobuf_t open_sigfile (const char *sigfilename, progress_filter_context_t *pfx);
341 void try_make_homedir( const char *fname );
342 char *get_openpgp_revocdir (const char *home);
345 void make_session_key( DEK *dek );
346 gcry_mpi_t encode_session_key( int openpgp_pk_algo, DEK *dek, unsigned nbits );
347 gcry_mpi_t encode_md_value (PKT_public_key *pk,
348 gcry_md_hd_t md, int hash_algo );
351 struct import_stats_s;
352 typedef struct import_stats_s *import_stats_t;
353 struct import_filter_s;
354 typedef struct import_filter_s *import_filter_t;
355 typedef gpg_error_t (*import_screener_t)(kbnode_t keyblock, void *arg);
357 int parse_import_options(char *str,unsigned int *options,int noisy);
359 gpg_error_t parse_and_set_import_filter (const char *string);
360 import_filter_t save_and_clear_import_filter (void);
361 void restore_import_filter (import_filter_t filt);
363 gpg_error_t read_key_from_file_or_buffer (ctrl_t ctrl, const char *fname,
364 const void *buffer, size_t buflen,
365 kbnode_t *r_keyblock);
366 gpg_error_t import_included_key_block (ctrl_t ctrl, kbnode_t keyblock);
367 void import_keys (ctrl_t ctrl, char **fnames, int nnames,
368 import_stats_t stats_hd, unsigned int options,
369 int origin, const char *url);
370 gpg_error_t import_keys_es_stream (ctrl_t ctrl, estream_t fp,
371 import_stats_t stats_handle,
372 unsigned char **fpr, size_t *fpr_len,
373 unsigned int options,
374 import_screener_t screener, void *screener_arg,
375 int origin, const char *url);
376 gpg_error_t import_old_secring (ctrl_t ctrl, const char *fname);
377 import_stats_t import_new_stats_handle (void);
378 void import_release_stats_handle (import_stats_t hd);
379 void import_print_stats (import_stats_t hd);
380 /* Communication for impex_filter_getval */
381 struct impex_filter_parm_s
385 char hexfpr[2*MAX_FINGERPRINT_LEN + 1];
388 const char *impex_filter_getval (void *cookie, const char *propname);
389 gpg_error_t transfer_secret_keys (ctrl_t ctrl, struct import_stats_s *stats,
390 kbnode_t sec_keyblock, int batch, int force,
393 int collapse_uids( KBNODE *keyblock );
395 int get_revocation_reason (PKT_signature *sig, char **r_reason,
396 char **r_comment, size_t *r_commentlen);
400 struct export_stats_s;
401 typedef struct export_stats_s *export_stats_t;
403 export_stats_t export_new_stats (void);
404 void export_release_stats (export_stats_t stats);
405 void export_print_stats (export_stats_t stats);
407 int parse_export_options(char *str,unsigned int *options,int noisy);
408 gpg_error_t parse_and_set_export_filter (const char *string);
409 void push_export_filters (void);
410 void pop_export_filters (void);
412 int exact_subkey_match_p (KEYDB_SEARCH_DESC *desc, kbnode_t node);
414 int export_pubkeys (ctrl_t ctrl, strlist_t users, unsigned int options,
415 export_stats_t stats);
416 int export_seckeys (ctrl_t ctrl, strlist_t users, unsigned int options,
417 export_stats_t stats);
418 int export_secsubkeys (ctrl_t ctrl, strlist_t users, unsigned int options,
419 export_stats_t stats);
421 gpg_error_t export_pubkey_buffer (ctrl_t ctrl, const char *keyspec,
422 unsigned int options,
423 const void *prefix, size_t prefixlen,
424 export_stats_t stats,
425 kbnode_t *r_keyblock,
426 void **r_data, size_t *r_datalen);
428 gpg_error_t receive_seckey_from_agent (ctrl_t ctrl, gcry_cipher_hd_t cipherhd,
430 char **cache_nonce_addr,
434 gpg_error_t write_keyblock_to_output (kbnode_t keyblock,
435 int with_armor, unsigned int options);
437 gpg_error_t export_ssh_key (ctrl_t ctrl, const char *userid);
440 int dearmor_file( const char *fname );
441 int enarmor_file( const char *fname );
444 struct revocation_reason_info;
446 int gen_standard_revoke (ctrl_t ctrl,
447 PKT_public_key *psk, const char *cache_nonce);
448 int gen_revoke (ctrl_t ctrl, const char *uname);
449 int gen_desig_revoke (ctrl_t ctrl, const char *uname, strlist_t locusr);
450 int revocation_reason_build_cb( PKT_signature *sig, void *opaque );
451 struct revocation_reason_info *
452 ask_revocation_reason( int key_rev, int cert_rev, int hint );
453 struct revocation_reason_info * get_default_uid_revocation_reason (void);
454 struct revocation_reason_info * get_default_sig_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,
459 int locate_mode, int no_local);
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 int cmp_signodes (const void *av, const void *bv);
466 void print_fingerprint (ctrl_t ctrl, estream_t fp,
467 PKT_public_key *pk, int mode);
468 void print_revokers (estream_t fp, PKT_public_key *pk);
469 void show_policy_url(PKT_signature *sig,int indent,int mode);
470 void show_keyserver_url(PKT_signature *sig,int indent,int mode);
471 void show_notation(PKT_signature *sig,int indent,int mode,int which);
472 void dump_attribs (const PKT_user_id *uid, PKT_public_key *pk);
473 void set_attrib_fd(int fd);
474 char *format_seckey_info (ctrl_t ctrl, PKT_public_key *pk);
475 void print_seckey_info (ctrl_t ctrl, PKT_public_key *pk);
476 void print_pubkey_info (ctrl_t ctrl, estream_t fp, PKT_public_key *pk);
477 void print_card_key_info (estream_t fp, KBNODE keyblock);
478 void print_key_line (ctrl_t ctrl, estream_t fp, PKT_public_key *pk, int secret);
481 void print_file_status( int status, const char *name, int what );
482 int verify_signatures (ctrl_t ctrl, int nfiles, char **files );
483 int verify_files (ctrl_t ctrl, int nfiles, char **files );
484 int gpg_verify (ctrl_t ctrl, int sig_fd, int data_fd, estream_t out_fp);
487 int decrypt_message (ctrl_t ctrl, const char *filename );
488 gpg_error_t decrypt_message_fd (ctrl_t ctrl, int input_fd, int output_fd);
489 void decrypt_messages (ctrl_t ctrl, int nfiles, char *files[]);
491 /*-- plaintext.c --*/
492 int hash_datafiles( gcry_md_hd_t md, gcry_md_hd_t md2,
493 strlist_t files, const char *sigfilename, int textmode);
494 int hash_datafile_by_fd ( gcry_md_hd_t md, gcry_md_hd_t md2, int data_fd,
496 PKT_plaintext *setup_plaintext_name(const char *filename,IOBUF iobuf);
499 int gpg_server (ctrl_t);
500 gpg_error_t gpg_proxy_pinentry_notify (ctrl_t ctrl,
501 const unsigned char *line);
503 #ifdef ENABLE_CARD_SUPPORT
504 /*-- card-util.c --*/
505 void change_pin (int no, int allow_admin);
506 void card_status (ctrl_t ctrl, estream_t fp, const char *serialno);
507 void card_edit (ctrl_t ctrl, strlist_t commands);
508 gpg_error_t card_generate_subkey (ctrl_t ctrl, kbnode_t pub_keyblock);
509 int card_store_subkey (KBNODE node, int use);
512 #define S2K_DECODE_COUNT(_val) ((16ul + ((_val) & 15)) << (((_val) >> 4) + 6))
515 void migrate_secring (ctrl_t ctrl);
518 #endif /*G10_MAIN_H*/