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/>.
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. */
60 STRING2KEY *symkey_s2k;
61 cipher_filter_context_t cfx;
62 } encrypt_filter_context_t;
69 struct groupitem *next;
74 enum gcry_md_algos algo;
76 struct weakhash *next;
81 extern int g10_errors_seen;
83 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 5 )
84 void g10_exit(int rc) __attribute__ ((noreturn));
86 void g10_exit(int rc);
88 void print_pubkey_algo_note (pubkey_algo_t algo);
89 void print_cipher_algo_note (cipher_algo_t algo);
90 void print_digest_algo_note (digest_algo_t algo);
91 void print_digest_rejected_note (enum gcry_md_algos algo);
92 void print_reported_error (gpg_error_t err, gpg_err_code_t skip_if_ec);
93 void print_further_info (const char *format, ...) GPGRT_ATTR_PRINTF(1,2);
94 void additional_weak_digest (const char* digestname);
97 char *make_radix64_string( const byte *data, size_t len );
100 void trap_unaligned(void);
101 void register_secured_file (const char *fname);
102 void unregister_secured_file (const char *fname);
103 int is_secured_file (int fd);
104 int is_secured_filename (const char *fname);
105 u16 checksum_u16( unsigned n );
106 u16 checksum( byte *p, unsigned n );
107 u16 checksum_mpi( gcry_mpi_t a );
108 u32 buffer_to_u32( const byte *buffer );
109 const byte *get_session_marker( size_t *rlen );
111 enum gcry_cipher_algos map_cipher_openpgp_to_gcry (cipher_algo_t algo);
112 #define openpgp_cipher_open(_a,_b,_c,_d) \
113 gcry_cipher_open((_a),map_cipher_openpgp_to_gcry((_b)),(_c),(_d))
114 #define openpgp_cipher_get_algo_keylen(_a) \
115 gcry_cipher_get_algo_keylen(map_cipher_openpgp_to_gcry((_a)))
116 #define openpgp_cipher_get_algo_blklen(_a) \
117 gcry_cipher_get_algo_blklen(map_cipher_openpgp_to_gcry((_a)))
118 int openpgp_cipher_blocklen (cipher_algo_t algo);
119 int openpgp_cipher_test_algo(cipher_algo_t algo);
120 const char *openpgp_cipher_algo_name (cipher_algo_t algo);
122 pubkey_algo_t map_pk_gcry_to_openpgp (enum gcry_pk_algos algo);
123 int openpgp_pk_test_algo (pubkey_algo_t algo);
124 int openpgp_pk_test_algo2 (pubkey_algo_t algo, unsigned int use);
125 int openpgp_pk_algo_usage ( int algo );
126 const char *openpgp_pk_algo_name (pubkey_algo_t algo);
128 enum gcry_md_algos map_md_openpgp_to_gcry (digest_algo_t algo);
129 int openpgp_md_test_algo (digest_algo_t algo);
130 const char *openpgp_md_algo_name (int algo);
135 PKT_public_key *pksk;
138 const char *validity_string;
139 const byte *namehash;
142 char *pct_expando(const char *string,struct expando_args *args);
143 void deprecated_warning(const char *configname,unsigned int configlineno,
144 const char *option,const char *repl1,const char *repl2);
145 void deprecated_command (const char *name);
146 void obsolete_scdaemon_option (const char *configname,
147 unsigned int configlineno, const char *name);
149 int string_to_cipher_algo (const char *string);
150 int string_to_digest_algo (const char *string);
152 const char *compress_algo_to_string(int algo);
153 int string_to_compress_algo(const char *string);
154 int check_compress_algo(int algo);
155 int default_cipher_algo(void);
156 int default_compress_algo(void);
157 const char *compliance_option_string(void);
158 void compliance_failure(void);
168 char *optsep(char **stringp);
169 char *argsplit(char *string);
170 int parse_options(char *str,unsigned int *options,
171 struct parse_options *opts,int noisy);
172 const char *get_libexecdir (void);
173 int path_access(const char *file,int mode);
175 int pubkey_get_npkey (pubkey_algo_t algo);
176 int pubkey_get_nskey (pubkey_algo_t algo);
177 int pubkey_get_nsig (pubkey_algo_t algo);
178 int pubkey_get_nenc (pubkey_algo_t algo);
180 /* Temporary helpers. */
181 unsigned int pubkey_nbits( int algo, gcry_mpi_t *pkey );
182 int mpi_print (estream_t stream, gcry_mpi_t a, int mode);
183 unsigned int ecdsa_qbits_from_Q (unsigned int qbits);
187 void set_status_fd ( int fd );
188 int is_status_enabled ( void );
189 void write_status ( int no );
190 void write_status_error (const char *where, gpg_error_t err);
191 void write_status_errcode (const char *where, int errcode);
192 void write_status_failure (const char *where, gpg_error_t err);
193 void write_status_text ( int no, const char *text );
194 void write_status_printf (int no, const char *format,
195 ...) GPGRT_ATTR_PRINTF(2,3);
196 void write_status_strings (int no, const char *text,
197 ...) GPGRT_ATTR_SENTINEL(0);
198 void write_status_buffer ( int no,
199 const char *buffer, size_t len, int wrap );
200 void write_status_text_and_buffer ( int no, const char *text,
201 const char *buffer, size_t len, int wrap );
203 void write_status_begin_signing (gcry_md_hd_t md);
206 int cpr_enabled(void);
207 char *cpr_get( const char *keyword, const char *prompt );
208 char *cpr_get_no_help( const char *keyword, const char *prompt );
209 char *cpr_get_utf8( const char *keyword, const char *prompt );
210 char *cpr_get_hidden( const char *keyword, const char *prompt );
211 void cpr_kill_prompt(void);
212 int cpr_get_answer_is_yes_def (const char *keyword, const char *prompt,
214 int cpr_get_answer_is_yes( const char *keyword, const char *prompt );
215 int cpr_get_answer_yes_no_quit( const char *keyword, const char *prompt );
216 int cpr_get_answer_okay_cancel (const char *keyword,
221 void display_online_help( const char *keyword );
224 int setup_symkey (STRING2KEY **symkey_s2k,DEK **symkey_dek);
225 void encrypt_seskey (DEK *dek, DEK **seskey, byte *enckey);
226 int use_mdc (pk_list_t pk_list,int algo);
227 int encrypt_symmetric (const char *filename );
228 int encrypt_store (const char *filename );
229 int encrypt_crypt (ctrl_t ctrl, int filefd, const char *filename,
230 strlist_t remusr, int use_symkey, pk_list_t provided_keys,
232 void encrypt_crypt_files (ctrl_t ctrl,
233 int nfiles, char **files, strlist_t remusr);
234 int encrypt_filter (void *opaque, int control,
235 iobuf_t a, byte *buf, size_t *ret_len);
237 int write_pubkey_enc (PKT_public_key *pk, int throw_keyid,
238 DEK *dek, iobuf_t out);
241 int complete_sig (PKT_signature *sig, PKT_public_key *pksk, gcry_md_hd_t md,
242 const char *cache_nonce);
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);
249 /*-- sig-check.c --*/
251 /* SIG is a revocation signature. Check if any of PK's designated
252 revokers generated it. If so, return 0. Note: this function
253 (correctly) doesn't care if the designated revoker is revoked. */
254 int check_revocation_keys (PKT_public_key *pk, PKT_signature *sig);
255 /* Check that the backsig BACKSIG from the subkey SUB_PK to its
256 primary key MAIN_PK is valid. */
257 int check_backsig(PKT_public_key *main_pk,PKT_public_key *sub_pk,
258 PKT_signature *backsig);
259 /* Check that the signature SIG over a key (e.g., a key binding or a
260 key revocation) is valid. (To check signatures over data, use
262 int check_key_signature( KBNODE root, KBNODE sig, int *is_selfsig );
263 /* Like check_key_signature, but with the ability to specify some
264 additional parameters and get back additional information. See the
265 documentation for the implementation for details. */
266 int check_key_signature2( KBNODE root, KBNODE node, PKT_public_key *check_pk,
267 PKT_public_key *ret_pk, int *is_selfsig,
268 u32 *r_expiredate, int *r_expired );
270 /* Returns whether SIGNER generated the signature SIG over the packet
271 PACKET, which is a key, subkey or uid, and comes from the key block
272 KB. If SIGNER is NULL, it is looked up based on the information in
273 SIG. If not NULL, sets *IS_SELFSIG to indicate whether the
274 signature is a self-signature and *RET_PK to a copy of the signer's
276 gpg_error_t check_signature_over_key_or_uid (PKT_public_key *signer,
278 KBNODE kb, PACKET *packet,
280 PKT_public_key *ret_pk);
284 gpg_error_t delete_keys (strlist_t names, int secret, int allow_both);
287 void keyedit_menu (ctrl_t ctrl, const char *username, strlist_t locusr,
288 strlist_t commands, int quiet, int seckey_check );
289 void keyedit_passwd (ctrl_t ctrl, const char *username);
290 void keyedit_quick_adduid (ctrl_t ctrl, const char *username,
292 void keyedit_quick_addkey (ctrl_t ctrl, const char *fpr, const char *algostr,
293 const char *usagestr, const char *expirestr);
294 void keyedit_quick_revuid (ctrl_t ctrl, const char *username,
295 const char *uidtorev);
296 void keyedit_quick_sign (ctrl_t ctrl, const char *fpr,
297 strlist_t uids, strlist_t locusr, int local);
298 void keyedit_quick_set_expire (ctrl_t ctrl,
299 const char *fpr, const char *expirestr);
300 void show_basic_key_info (KBNODE keyblock);
303 const char *get_default_pubkey_algo (void);
304 u32 parse_expire_string(const char *string);
305 u32 ask_expire_interval(int object,const char *def_expire);
306 u32 ask_expiredate(void);
307 unsigned int ask_key_flags (int algo, int subkey, unsigned int current);
308 void quick_generate_keypair (ctrl_t ctrl, const char *uid, const char *algostr,
309 const char *usagestr, const char *expirestr);
310 void generate_keypair (ctrl_t ctrl, int full, const char *fname,
311 const char *card_serialno, int card_backup_key);
312 int keygen_set_std_prefs (const char *string,int personal);
313 PKT_user_id *keygen_get_std_prefs (void);
314 int keygen_add_key_expire( PKT_signature *sig, void *opaque );
315 int keygen_add_key_flags (PKT_signature *sig, void *opaque);
316 int keygen_add_std_prefs( PKT_signature *sig, void *opaque );
317 int keygen_upd_std_prefs( PKT_signature *sig, void *opaque );
318 int keygen_add_keyserver_url(PKT_signature *sig, void *opaque);
319 int keygen_add_notations(PKT_signature *sig,void *opaque);
320 int keygen_add_revkey(PKT_signature *sig, void *opaque);
321 gpg_error_t make_backsig (PKT_signature *sig, PKT_public_key *pk,
322 PKT_public_key *sub_pk, PKT_public_key *sub_psk,
323 u32 timestamp, const char *cache_nonce);
324 gpg_error_t generate_subkeypair (ctrl_t ctrl, kbnode_t keyblock,
326 const char *usagestr,
327 const char *expirestr);
328 #ifdef ENABLE_CARD_SUPPORT
329 gpg_error_t generate_card_subkeypair (kbnode_t pub_keyblock,
330 int keyno, const char *serialno);
335 int overwrite_filep( const char *fname );
336 char *make_outfile_name( const char *iname );
337 char *ask_outfile_name( const char *name, size_t namelen );
338 int open_outfile (int inp_fd, const char *iname, int mode,
339 int restrictedperm, iobuf_t *a);
340 char *get_matching_datafile (const char *sigfilename);
341 iobuf_t open_sigfile (const char *sigfilename, progress_filter_context_t *pfx);
342 void try_make_homedir( const char *fname );
343 char *get_openpgp_revocdir (const char *home);
346 void make_session_key( DEK *dek );
347 gcry_mpi_t encode_session_key( int openpgp_pk_algo, DEK *dek, unsigned nbits );
348 gcry_mpi_t encode_md_value (PKT_public_key *pk,
349 gcry_md_hd_t md, int hash_algo );
352 struct import_stats_s;
353 typedef struct import_stats_s *import_stats_t;
354 struct import_filter_s;
355 typedef struct import_filter_s *import_filter_t;
356 typedef gpg_error_t (*import_screener_t)(kbnode_t keyblock, void *arg);
358 int parse_import_options(char *str,unsigned int *options,int noisy);
360 gpg_error_t parse_and_set_import_filter (const char *string);
361 import_filter_t save_and_clear_import_filter (void);
362 void restore_import_filter (import_filter_t filt);
364 gpg_error_t read_key_from_file (ctrl_t ctrl, const char *fname,
365 kbnode_t *r_keyblock);
366 void import_keys (ctrl_t ctrl, char **fnames, int nnames,
367 import_stats_t stats_hd, unsigned int options);
368 int import_keys_stream (ctrl_t ctrl, iobuf_t inp, import_stats_t stats_hd,
370 size_t *fpr_len, unsigned int options);
371 int import_keys_es_stream (ctrl_t ctrl, estream_t fp,
372 import_stats_t stats_handle,
373 unsigned char **fpr, size_t *fpr_len,
374 unsigned int options,
375 import_screener_t screener, void *screener_arg);
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 const char *impex_filter_getval (void *cookie, const char *propname);
381 gpg_error_t transfer_secret_keys (ctrl_t ctrl, struct import_stats_s *stats,
382 kbnode_t sec_keyblock, int batch, int force);
384 int collapse_uids( KBNODE *keyblock );
388 struct export_stats_s;
389 typedef struct export_stats_s *export_stats_t;
391 export_stats_t export_new_stats (void);
392 void export_release_stats (export_stats_t stats);
393 void export_print_stats (export_stats_t stats);
395 int parse_export_options(char *str,unsigned int *options,int noisy);
396 gpg_error_t parse_and_set_export_filter (const char *string);
398 int export_pubkeys (ctrl_t ctrl, strlist_t users, unsigned int options,
399 export_stats_t stats);
400 int export_seckeys (ctrl_t ctrl, strlist_t users, export_stats_t stats);
401 int export_secsubkeys (ctrl_t ctrl, strlist_t users, export_stats_t stats);
403 gpg_error_t export_pubkey_buffer (ctrl_t ctrl, const char *keyspec,
404 unsigned int options,
405 export_stats_t stats,
406 kbnode_t *r_keyblock,
407 void **r_data, size_t *r_datalen);
409 gpg_error_t receive_seckey_from_agent (ctrl_t ctrl, gcry_cipher_hd_t cipherhd,
411 char **cache_nonce_addr,
415 gpg_error_t write_keyblock_to_output (kbnode_t keyblock,
416 int with_armor, unsigned int options);
418 gpg_error_t export_ssh_key (ctrl_t ctrl, const char *userid);
421 int dearmor_file( const char *fname );
422 int enarmor_file( const char *fname );
425 struct revocation_reason_info;
426 int gen_standard_revoke (PKT_public_key *psk, const char *cache_nonce);
427 int gen_revoke( const char *uname );
428 int gen_desig_revoke (ctrl_t ctrl, const char *uname, strlist_t locusr);
429 int revocation_reason_build_cb( PKT_signature *sig, void *opaque );
430 struct revocation_reason_info *
431 ask_revocation_reason( int key_rev, int cert_rev, int hint );
432 struct revocation_reason_info * get_default_uid_revocation_reason(void);
433 void release_revocation_reason_info( struct revocation_reason_info *reason );
436 void public_key_list (ctrl_t ctrl, strlist_t list, int locate_mode );
437 void secret_key_list (ctrl_t ctrl, strlist_t list );
438 void print_subpackets_colon(PKT_signature *sig);
439 void reorder_keyblock (KBNODE keyblock);
440 void list_keyblock_direct (ctrl_t ctrl, kbnode_t keyblock, int secret,
441 int has_secret, int fpr, int no_validity);
442 void print_fingerprint (estream_t fp, PKT_public_key *pk, int mode);
443 void print_revokers (estream_t fp, PKT_public_key *pk);
444 void show_policy_url(PKT_signature *sig,int indent,int mode);
445 void show_keyserver_url(PKT_signature *sig,int indent,int mode);
446 void show_notation(PKT_signature *sig,int indent,int mode,int which);
447 void dump_attribs (const PKT_user_id *uid, PKT_public_key *pk);
448 void set_attrib_fd(int fd);
449 char *format_seckey_info (PKT_public_key *pk);
450 void print_seckey_info (PKT_public_key *pk);
451 void print_pubkey_info (estream_t fp, PKT_public_key *pk);
452 void print_card_key_info (estream_t fp, KBNODE keyblock);
453 void print_key_line (estream_t fp, PKT_public_key *pk, int secret);
456 void print_file_status( int status, const char *name, int what );
457 int verify_signatures (ctrl_t ctrl, int nfiles, char **files );
458 int verify_files (ctrl_t ctrl, int nfiles, char **files );
459 int gpg_verify (ctrl_t ctrl, int sig_fd, int data_fd, estream_t out_fp);
462 int decrypt_message (ctrl_t ctrl, const char *filename );
463 gpg_error_t decrypt_message_fd (ctrl_t ctrl, int input_fd, int output_fd);
464 void decrypt_messages (ctrl_t ctrl, int nfiles, char *files[]);
466 /*-- plaintext.c --*/
467 int hash_datafiles( gcry_md_hd_t md, gcry_md_hd_t md2,
468 strlist_t files, const char *sigfilename, int textmode);
469 int hash_datafile_by_fd ( gcry_md_hd_t md, gcry_md_hd_t md2, int data_fd,
471 PKT_plaintext *setup_plaintext_name(const char *filename,IOBUF iobuf);
474 int gpg_server (ctrl_t);
475 gpg_error_t gpg_proxy_pinentry_notify (ctrl_t ctrl,
476 const unsigned char *line);
478 #ifdef ENABLE_CARD_SUPPORT
479 /*-- card-util.c --*/
480 void change_pin (int no, int allow_admin);
481 void card_status (estream_t fp, char *serialno, size_t serialnobuflen);
482 void card_edit (ctrl_t ctrl, strlist_t commands);
483 gpg_error_t card_generate_subkey (KBNODE pub_keyblock);
484 int card_store_subkey (KBNODE node, int use);
487 #define S2K_DECODE_COUNT(_val) ((16ul + ((_val) & 15)) << (((_val) >> 4) + 6))
490 void migrate_secring (ctrl_t ctrl);
493 #endif /*G10_MAIN_H*/