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);
100 char *make_radix64_string( const byte *data, size_t len );
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 );
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);
125 gpg_error_t openpgp_aead_test_algo (aead_algo_t algo);
126 const char *openpgp_aead_algo_name (aead_algo_t algo);
127 gpg_error_t openpgp_aead_algo_info (aead_algo_t algo,
128 enum gcry_cipher_modes *r_mode,
129 unsigned int *r_noncelen);
131 pubkey_algo_t map_pk_gcry_to_openpgp (enum gcry_pk_algos algo);
132 int openpgp_pk_test_algo (pubkey_algo_t algo);
133 int openpgp_pk_test_algo2 (pubkey_algo_t algo, unsigned int use);
134 int openpgp_pk_algo_usage ( int algo );
135 const char *openpgp_pk_algo_name (pubkey_algo_t algo);
137 enum gcry_md_algos map_md_openpgp_to_gcry (digest_algo_t algo);
138 int openpgp_md_test_algo (digest_algo_t algo);
139 const char *openpgp_md_algo_name (int algo);
144 PKT_public_key *pksk;
147 const char *validity_string;
148 const byte *namehash;
151 char *pct_expando(const char *string,struct expando_args *args);
152 void deprecated_warning(const char *configname,unsigned int configlineno,
153 const char *option,const char *repl1,const char *repl2);
154 void deprecated_command (const char *name);
155 void obsolete_scdaemon_option (const char *configname,
156 unsigned int configlineno, const char *name);
158 int string_to_cipher_algo (const char *string);
159 int string_to_digest_algo (const char *string);
161 const char *compress_algo_to_string(int algo);
162 int string_to_compress_algo(const char *string);
163 int check_compress_algo(int algo);
164 int default_cipher_algo(void);
165 int default_compress_algo(void);
166 void compliance_failure(void);
176 char *optsep(char **stringp);
177 char *argsplit(char *string);
178 int parse_options(char *str,unsigned int *options,
179 struct parse_options *opts,int noisy);
180 const char *get_libexecdir (void);
181 int path_access(const char *file,int mode);
183 int pubkey_get_npkey (pubkey_algo_t algo);
184 int pubkey_get_nskey (pubkey_algo_t algo);
185 int pubkey_get_nsig (pubkey_algo_t algo);
186 int pubkey_get_nenc (pubkey_algo_t algo);
188 /* Temporary helpers. */
189 unsigned int pubkey_nbits( int algo, gcry_mpi_t *pkey );
190 int mpi_print (estream_t stream, gcry_mpi_t a, int mode);
191 unsigned int ecdsa_qbits_from_Q (unsigned int qbits);
195 void set_status_fd ( int fd );
196 int is_status_enabled ( void );
197 void write_status ( int no );
198 void write_status_error (const char *where, gpg_error_t err);
199 void write_status_errcode (const char *where, int errcode);
200 void write_status_failure (const char *where, gpg_error_t err);
201 void write_status_text ( int no, const char *text );
202 void write_status_printf (int no, const char *format,
203 ...) GPGRT_ATTR_PRINTF(2,3);
204 void write_status_strings (int no, const char *text,
205 ...) GPGRT_ATTR_SENTINEL(0);
206 void write_status_buffer ( int no,
207 const char *buffer, size_t len, int wrap );
208 void write_status_text_and_buffer ( int no, const char *text,
209 const char *buffer, size_t len, int wrap );
211 void write_status_begin_signing (gcry_md_hd_t md);
214 int cpr_enabled(void);
215 char *cpr_get( const char *keyword, const char *prompt );
216 char *cpr_get_no_help( const char *keyword, const char *prompt );
217 char *cpr_get_utf8( const char *keyword, const char *prompt );
218 char *cpr_get_hidden( const char *keyword, const char *prompt );
219 void cpr_kill_prompt(void);
220 int cpr_get_answer_is_yes_def (const char *keyword, const char *prompt,
222 int cpr_get_answer_is_yes( const char *keyword, const char *prompt );
223 int cpr_get_answer_yes_no_quit( const char *keyword, const char *prompt );
224 int cpr_get_answer_okay_cancel (const char *keyword,
229 void display_online_help( const char *keyword );
232 gpg_error_t setup_symkey (STRING2KEY **symkey_s2k,DEK **symkey_dek);
233 void encrypt_seskey (DEK *dek, DEK **seskey, byte *enckey);
234 int use_mdc (pk_list_t pk_list,int algo);
235 int encrypt_symmetric (const char *filename );
236 int encrypt_store (const char *filename );
237 int encrypt_crypt (ctrl_t ctrl, int filefd, const char *filename,
238 strlist_t remusr, int use_symkey, pk_list_t provided_keys,
240 void encrypt_crypt_files (ctrl_t ctrl,
241 int nfiles, char **files, strlist_t remusr);
242 int encrypt_filter (void *opaque, int control,
243 iobuf_t a, byte *buf, size_t *ret_len);
245 int write_pubkey_enc (ctrl_t ctrl, PKT_public_key *pk, int throw_keyid,
246 DEK *dek, iobuf_t out);
249 int sign_file (ctrl_t ctrl, strlist_t filenames, int detached, strlist_t locusr,
250 int do_encrypt, strlist_t remusr, const char *outfile );
251 int clearsign_file (ctrl_t ctrl,
252 const char *fname, strlist_t locusr, const char *outfile);
253 int sign_symencrypt_file (ctrl_t ctrl, const char *fname, strlist_t locusr);
255 /*-- sig-check.c --*/
256 void sig_check_dump_stats (void);
258 /* SIG is a revocation signature. Check if any of PK's designated
259 revokers generated it. If so, return 0. Note: this function
260 (correctly) doesn't care if the designated revoker is revoked. */
261 int check_revocation_keys (ctrl_t ctrl, PKT_public_key *pk, PKT_signature *sig);
262 /* Check that the backsig BACKSIG from the subkey SUB_PK to its
263 primary key MAIN_PK is valid. */
264 int check_backsig(PKT_public_key *main_pk,PKT_public_key *sub_pk,
265 PKT_signature *backsig);
266 /* Check that the signature SIG over a key (e.g., a key binding or a
267 key revocation) is valid. (To check signatures over data, use
269 int check_key_signature (ctrl_t ctrl, kbnode_t root, kbnode_t sig,
271 /* Like check_key_signature, but with the ability to specify some
272 additional parameters and get back additional information. See the
273 documentation for the implementation for details. */
274 int check_key_signature2 (ctrl_t ctrl, kbnode_t root, kbnode_t node,
275 PKT_public_key *check_pk, PKT_public_key *ret_pk,
276 int *is_selfsig, u32 *r_expiredate, int *r_expired);
278 /* Returns whether SIGNER generated the signature SIG over the packet
279 PACKET, which is a key, subkey or uid, and comes from the key block
280 KB. If SIGNER is NULL, it is looked up based on the information in
281 SIG. If not NULL, sets *IS_SELFSIG to indicate whether the
282 signature is a self-signature and *RET_PK to a copy of the signer's
284 gpg_error_t check_signature_over_key_or_uid (ctrl_t ctrl,
285 PKT_public_key *signer,
287 KBNODE kb, PACKET *packet,
289 PKT_public_key *ret_pk);
293 gpg_error_t delete_keys (ctrl_t ctrl,
294 strlist_t names, int secret, int allow_both);
297 const char *get_default_pubkey_algo (void);
298 u32 parse_expire_string(const char *string);
299 u32 ask_expire_interval(int object,const char *def_expire);
300 u32 ask_expiredate(void);
301 unsigned int ask_key_flags (int algo, int subkey, unsigned int current);
302 const char *ask_curve (int *algo, int *subkey_algo, const char *current);
303 void quick_generate_keypair (ctrl_t ctrl, const char *uid, const char *algostr,
304 const char *usagestr, const char *expirestr);
305 void generate_keypair (ctrl_t ctrl, int full, const char *fname,
306 const char *card_serialno, int card_backup_key);
307 int keygen_set_std_prefs (const char *string,int personal);
308 PKT_user_id *keygen_get_std_prefs (void);
309 int keygen_add_key_expire( PKT_signature *sig, void *opaque );
310 int keygen_add_key_flags (PKT_signature *sig, void *opaque);
311 int keygen_add_std_prefs( PKT_signature *sig, void *opaque );
312 int keygen_upd_std_prefs( PKT_signature *sig, void *opaque );
313 int keygen_add_keyserver_url(PKT_signature *sig, void *opaque);
314 int keygen_add_notations(PKT_signature *sig,void *opaque);
315 int keygen_add_revkey(PKT_signature *sig, void *opaque);
316 gpg_error_t make_backsig (ctrl_t ctrl,
317 PKT_signature *sig, PKT_public_key *pk,
318 PKT_public_key *sub_pk, PKT_public_key *sub_psk,
319 u32 timestamp, const char *cache_nonce);
320 gpg_error_t generate_subkeypair (ctrl_t ctrl, kbnode_t keyblock,
322 const char *usagestr,
323 const char *expirestr);
324 #ifdef ENABLE_CARD_SUPPORT
325 gpg_error_t generate_card_subkeypair (ctrl_t ctrl, kbnode_t pub_keyblock,
326 int keyno, const char *serialno);
331 int overwrite_filep( const char *fname );
332 char *make_outfile_name( const char *iname );
333 char *ask_outfile_name( const char *name, size_t namelen );
334 int open_outfile (int inp_fd, const char *iname, int mode,
335 int restrictedperm, iobuf_t *a);
336 char *get_matching_datafile (const char *sigfilename);
337 iobuf_t open_sigfile (const char *sigfilename, progress_filter_context_t *pfx);
338 void try_make_homedir( const char *fname );
339 char *get_openpgp_revocdir (const char *home);
342 void make_session_key( DEK *dek );
343 gcry_mpi_t encode_session_key( int openpgp_pk_algo, DEK *dek, unsigned nbits );
344 gcry_mpi_t encode_md_value (PKT_public_key *pk,
345 gcry_md_hd_t md, int hash_algo );
348 struct import_stats_s;
349 typedef struct import_stats_s *import_stats_t;
350 struct import_filter_s;
351 typedef struct import_filter_s *import_filter_t;
352 typedef gpg_error_t (*import_screener_t)(kbnode_t keyblock, void *arg);
354 int parse_import_options(char *str,unsigned int *options,int noisy);
356 gpg_error_t parse_and_set_import_filter (const char *string);
357 import_filter_t save_and_clear_import_filter (void);
358 void restore_import_filter (import_filter_t filt);
360 gpg_error_t read_key_from_file_or_buffer (ctrl_t ctrl, const char *fname,
361 const void *buffer, size_t buflen,
362 kbnode_t *r_keyblock);
363 gpg_error_t import_included_key_block (ctrl_t ctrl, kbnode_t keyblock);
364 void import_keys (ctrl_t ctrl, char **fnames, int nnames,
365 import_stats_t stats_hd, unsigned int options,
366 int origin, const char *url);
367 gpg_error_t import_keys_es_stream (ctrl_t ctrl, estream_t fp,
368 import_stats_t stats_handle,
369 unsigned char **fpr, size_t *fpr_len,
370 unsigned int options,
371 import_screener_t screener, void *screener_arg,
372 int origin, const char *url);
373 gpg_error_t import_old_secring (ctrl_t ctrl, const char *fname);
374 import_stats_t import_new_stats_handle (void);
375 void import_release_stats_handle (import_stats_t hd);
376 void import_print_stats (import_stats_t hd);
377 /* Communication for impex_filter_getval */
378 struct impex_filter_parm_s
382 char hexfpr[2*MAX_FINGERPRINT_LEN + 1];
385 const char *impex_filter_getval (void *cookie, const char *propname);
386 gpg_error_t transfer_secret_keys (ctrl_t ctrl, struct import_stats_s *stats,
387 kbnode_t sec_keyblock, int batch, int force,
390 int collapse_uids( KBNODE *keyblock );
392 int get_revocation_reason (PKT_signature *sig, char **r_reason,
393 char **r_comment, size_t *r_commentlen);
397 struct export_stats_s;
398 typedef struct export_stats_s *export_stats_t;
400 export_stats_t export_new_stats (void);
401 void export_release_stats (export_stats_t stats);
402 void export_print_stats (export_stats_t stats);
404 int parse_export_options(char *str,unsigned int *options,int noisy);
405 gpg_error_t parse_and_set_export_filter (const char *string);
406 void push_export_filters (void);
407 void pop_export_filters (void);
409 int exact_subkey_match_p (KEYDB_SEARCH_DESC *desc, kbnode_t node);
411 int export_pubkeys (ctrl_t ctrl, strlist_t users, unsigned int options,
412 export_stats_t stats);
413 int export_seckeys (ctrl_t ctrl, strlist_t users, unsigned int options,
414 export_stats_t stats);
415 int export_secsubkeys (ctrl_t ctrl, strlist_t users, unsigned int options,
416 export_stats_t stats);
418 gpg_error_t export_pubkey_buffer (ctrl_t ctrl, const char *keyspec,
419 unsigned int options,
420 const void *prefix, size_t prefixlen,
421 export_stats_t stats,
422 kbnode_t *r_keyblock,
423 void **r_data, size_t *r_datalen);
425 gpg_error_t receive_seckey_from_agent (ctrl_t ctrl, gcry_cipher_hd_t cipherhd,
427 char **cache_nonce_addr,
431 gpg_error_t write_keyblock_to_output (kbnode_t keyblock,
432 int with_armor, unsigned int options);
434 gpg_error_t export_ssh_key (ctrl_t ctrl, const char *userid);
437 int dearmor_file( const char *fname );
438 int enarmor_file( const char *fname );
441 struct revocation_reason_info;
443 int gen_standard_revoke (ctrl_t ctrl,
444 PKT_public_key *psk, const char *cache_nonce);
445 int gen_revoke (ctrl_t ctrl, const char *uname);
446 int gen_desig_revoke (ctrl_t ctrl, const char *uname, strlist_t locusr);
447 int revocation_reason_build_cb( PKT_signature *sig, void *opaque );
448 struct revocation_reason_info *
449 ask_revocation_reason( int key_rev, int cert_rev, int hint );
450 struct revocation_reason_info * get_default_uid_revocation_reason(void);
451 void release_revocation_reason_info( struct revocation_reason_info *reason );
454 void public_key_list (ctrl_t ctrl, strlist_t list,
455 int locate_mode, int no_local);
456 void secret_key_list (ctrl_t ctrl, strlist_t list );
457 void print_subpackets_colon(PKT_signature *sig);
458 void reorder_keyblock (KBNODE keyblock);
459 void list_keyblock_direct (ctrl_t ctrl, kbnode_t keyblock, int secret,
460 int has_secret, int fpr, int no_validity);
461 void print_fingerprint (ctrl_t ctrl, estream_t fp,
462 PKT_public_key *pk, int mode);
463 void print_revokers (estream_t fp, PKT_public_key *pk);
464 void show_policy_url(PKT_signature *sig,int indent,int mode);
465 void show_keyserver_url(PKT_signature *sig,int indent,int mode);
466 void show_notation(PKT_signature *sig,int indent,int mode,int which);
467 void dump_attribs (const PKT_user_id *uid, PKT_public_key *pk);
468 void set_attrib_fd(int fd);
469 char *format_seckey_info (ctrl_t ctrl, PKT_public_key *pk);
470 void print_seckey_info (ctrl_t ctrl, PKT_public_key *pk);
471 void print_pubkey_info (ctrl_t ctrl, estream_t fp, PKT_public_key *pk);
472 void print_card_key_info (estream_t fp, KBNODE keyblock);
473 void print_key_line (ctrl_t ctrl, estream_t fp, PKT_public_key *pk, int secret);
476 void print_file_status( int status, const char *name, int what );
477 int verify_signatures (ctrl_t ctrl, int nfiles, char **files );
478 int verify_files (ctrl_t ctrl, int nfiles, char **files );
479 int gpg_verify (ctrl_t ctrl, int sig_fd, int data_fd, estream_t out_fp);
482 int decrypt_message (ctrl_t ctrl, const char *filename );
483 gpg_error_t decrypt_message_fd (ctrl_t ctrl, int input_fd, int output_fd);
484 void decrypt_messages (ctrl_t ctrl, int nfiles, char *files[]);
486 /*-- plaintext.c --*/
487 int hash_datafiles( gcry_md_hd_t md, gcry_md_hd_t md2,
488 strlist_t files, const char *sigfilename, int textmode);
489 int hash_datafile_by_fd ( gcry_md_hd_t md, gcry_md_hd_t md2, int data_fd,
491 PKT_plaintext *setup_plaintext_name(const char *filename,IOBUF iobuf);
494 int gpg_server (ctrl_t);
495 gpg_error_t gpg_proxy_pinentry_notify (ctrl_t ctrl,
496 const unsigned char *line);
498 #ifdef ENABLE_CARD_SUPPORT
499 /*-- card-util.c --*/
500 void change_pin (int no, int allow_admin);
501 void card_status (ctrl_t ctrl, estream_t fp, const char *serialno);
502 void card_edit (ctrl_t ctrl, strlist_t commands);
503 gpg_error_t card_generate_subkey (ctrl_t ctrl, kbnode_t pub_keyblock);
504 int card_store_subkey (KBNODE node, int use);
507 #define S2K_DECODE_COUNT(_val) ((16ul + ((_val) & 15)) << (((_val) >> 4) + 6))
510 void migrate_secring (ctrl_t ctrl);
513 #endif /*G10_MAIN_H*/