2 * Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
3 * 2008, 2009 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 <http://www.gnu.org/licenses/>.
30 /* It could be argued that the default cipher should be 3DES rather
31 than CAST5, and the default compression should be 0
32 (i.e. uncompressed) rather than 1 (zip). However, the real world
33 issues of speed and size come into play here. */
35 #define DEFAULT_CIPHER_ALGO CIPHER_ALGO_CAST5
36 #define DEFAULT_DIGEST_ALGO DIGEST_ALGO_SHA1
37 #define DEFAULT_COMPRESS_ALGO COMPRESS_ALGO_ZIP
38 #define DEFAULT_S2K_DIGEST_ALGO DIGEST_ALGO_SHA1
40 #define S2K_DIGEST_ALGO (opt.s2k_digest_algo?opt.s2k_digest_algo:DEFAULT_S2K_DIGEST_ALGO)
47 STRING2KEY *symkey_s2k;
48 cipher_filter_context_t cfx;
49 } encrypt_filter_context_t;
55 struct groupitem *next;
59 extern int g10_errors_seen;
61 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 5 )
62 void g10_exit(int rc) __attribute__ ((noreturn));
64 void g10_exit(int rc);
66 void print_pubkey_algo_note( int algo );
67 void print_cipher_algo_note( int algo );
68 void print_digest_algo_note( int algo );
71 char *make_radix64_string( const byte *data, size_t len );
74 void trap_unaligned(void);
75 int disable_core_dumps(void);
76 void register_secured_file (const char *fname);
77 void unregister_secured_file (const char *fname);
78 int is_secured_file (int fd);
79 int is_secured_filename (const char *fname);
80 u16 checksum_u16( unsigned n );
81 u16 checksum( byte *p, unsigned n );
82 u16 checksum_mpi( gcry_mpi_t a );
83 u32 buffer_to_u32( const byte *buffer );
84 const byte *get_session_marker( size_t *rlen );
85 int map_cipher_openpgp_to_gcry (int algo);
86 #define openpgp_cipher_open(_a,_b,_c,_d) gcry_cipher_open((_a),map_cipher_openpgp_to_gcry((_b)),(_c),(_d))
87 #define openpgp_cipher_get_algo_keylen(_a) gcry_cipher_get_algo_keylen(map_cipher_openpgp_to_gcry((_a)))
88 #define openpgp_cipher_get_algo_blklen(_a) gcry_cipher_get_algo_blklen(map_cipher_openpgp_to_gcry((_a)))
89 int openpgp_cipher_blocklen (int algo);
90 int openpgp_cipher_test_algo( int algo );
91 const char *openpgp_cipher_algo_name (int algo);
92 int map_pk_openpgp_to_gcry (int algo);
93 int openpgp_pk_test_algo( int algo );
94 int openpgp_pk_test_algo2 ( int algo, unsigned int use );
95 int openpgp_pk_algo_usage ( int algo );
96 const char *openpgp_pk_algo_name (int algo);
97 int openpgp_md_test_algo( int algo );
100 void idea_cipher_warn( int show );
102 #define idea_cipher_warn(a) do { } while (0)
111 const char *validity_string;
112 const byte *namehash;
115 char *pct_expando(const char *string,struct expando_args *args);
116 void deprecated_warning(const char *configname,unsigned int configlineno,
117 const char *option,const char *repl1,const char *repl2);
118 void deprecated_command (const char *name);
119 void obsolete_option (const char *configname, unsigned int configlineno,
122 int string_to_cipher_algo (const char *string);
123 int string_to_digest_algo (const char *string);
125 const char *compress_algo_to_string(int algo);
126 int string_to_compress_algo(const char *string);
127 int check_compress_algo(int algo);
128 int default_cipher_algo(void);
129 int default_compress_algo(void);
130 const char *compliance_option_string(void);
131 void compliance_failure(void);
141 char *optsep(char **stringp);
142 char *argsplit(char *string);
143 int parse_options(char *str,unsigned int *options,
144 struct parse_options *opts,int noisy);
145 int has_invalid_email_chars (const char *s);
146 int is_valid_mailbox (const char *name);
147 const char *get_libexecdir (void);
148 int path_access(const char *file,int mode);
150 /* Temporary helpers. */
151 int pubkey_get_npkey( int algo );
152 int pubkey_get_nskey( int algo );
153 int pubkey_get_nsig( int algo );
154 int pubkey_get_nenc( int algo );
155 unsigned int pubkey_nbits( int algo, gcry_mpi_t *pkey );
156 int mpi_print( FILE *fp, gcry_mpi_t a, int mode );
159 void set_status_fd ( int fd );
160 int is_status_enabled ( void );
161 void write_status ( int no );
162 void write_status_error (const char *where, int errcode);
163 void write_status_text ( int no, const char *text );
164 void write_status_strings (int no, const char *text,
165 ...) GNUPG_GCC_A_SENTINEL(0);
166 void write_status_buffer ( int no,
167 const char *buffer, size_t len, int wrap );
168 void write_status_text_and_buffer ( int no, const char *text,
169 const char *buffer, size_t len, int wrap );
171 void write_status_begin_signing (gcry_md_hd_t md);
174 int cpr_enabled(void);
175 char *cpr_get( const char *keyword, const char *prompt );
176 char *cpr_get_no_help( const char *keyword, const char *prompt );
177 char *cpr_get_utf8( const char *keyword, const char *prompt );
178 char *cpr_get_hidden( const char *keyword, const char *prompt );
179 void cpr_kill_prompt(void);
180 int cpr_get_answer_is_yes( const char *keyword, const char *prompt );
181 int cpr_get_answer_yes_no_quit( const char *keyword, const char *prompt );
182 int cpr_get_answer_okay_cancel (const char *keyword,
187 void display_online_help( const char *keyword );
190 int setup_symkey(STRING2KEY **symkey_s2k,DEK **symkey_dek);
191 int encode_symmetric( const char *filename );
192 int encode_store( const char *filename );
193 int encode_crypt( const char *filename, strlist_t remusr, int use_symkey );
194 void encode_crypt_files(int nfiles, char **files, strlist_t remusr);
195 int encrypt_filter( void *opaque, int control,
196 iobuf_t a, byte *buf, size_t *ret_len);
200 int complete_sig( PKT_signature *sig, PKT_secret_key *sk, gcry_md_hd_t md );
201 int sign_file( strlist_t filenames, int detached, strlist_t locusr,
202 int do_encrypt, strlist_t remusr, const char *outfile );
203 int clearsign_file( const char *fname, strlist_t locusr, const char *outfile );
204 int sign_symencrypt_file (const char *fname, strlist_t locusr);
206 /*-- sig-check.c --*/
207 int check_revocation_keys (PKT_public_key *pk, PKT_signature *sig);
208 int check_backsig(PKT_public_key *main_pk,PKT_public_key *sub_pk,
209 PKT_signature *backsig);
210 int check_key_signature( KBNODE root, KBNODE node, int *is_selfsig );
211 int check_key_signature2( KBNODE root, KBNODE node, PKT_public_key *check_pk,
212 PKT_public_key *ret_pk, int *is_selfsig,
213 u32 *r_expiredate, int *r_expired );
216 int delete_keys( strlist_t names, int secret, int allow_both );
219 void keyedit_menu( const char *username, strlist_t locusr,
220 strlist_t commands, int quiet, int seckey_check );
221 void keyedit_passwd (const char *username);
222 void show_basic_key_info (KBNODE keyblock);
225 u32 parse_expire_string(const char *string);
226 u32 ask_expire_interval(int object,const char *def_expire);
227 u32 ask_expiredate(void);
228 void generate_keypair( const char *fname, const char *card_serialno,
229 const char *backup_encryption_dir );
230 int keygen_set_std_prefs (const char *string,int personal);
231 PKT_user_id *keygen_get_std_prefs (void);
232 int keygen_add_key_expire( PKT_signature *sig, void *opaque );
233 int keygen_add_std_prefs( PKT_signature *sig, void *opaque );
234 int keygen_upd_std_prefs( PKT_signature *sig, void *opaque );
235 int keygen_add_keyserver_url(PKT_signature *sig, void *opaque);
236 int keygen_add_notations(PKT_signature *sig,void *opaque);
237 int keygen_add_revkey(PKT_signature *sig, void *opaque);
238 int make_backsig(PKT_signature *sig,PKT_public_key *pk,
239 PKT_public_key *sub_pk,PKT_secret_key *sub_sk,
241 int generate_subkeypair( KBNODE pub_keyblock, KBNODE sec_keyblock );
242 #ifdef ENABLE_CARD_SUPPORT
243 int generate_card_subkeypair (KBNODE pub_keyblock, KBNODE sec_keyblock,
244 int keyno, const char *serialno);
245 int save_unprotected_key_to_card (PKT_secret_key *sk, int keyno);
249 int overwrite_filep( const char *fname );
250 char *make_outfile_name( const char *iname );
251 char *ask_outfile_name( const char *name, size_t namelen );
252 int open_outfile( const char *iname, int mode, iobuf_t *a );
253 iobuf_t open_sigfile( const char *iname, progress_filter_context_t *pfx );
254 void try_make_homedir( const char *fname );
257 void make_session_key( DEK *dek );
258 gcry_mpi_t encode_session_key( DEK *dek, unsigned nbits );
259 gcry_mpi_t encode_md_value( PKT_public_key *pk, PKT_secret_key *sk,
260 gcry_md_hd_t md, int hash_algo );
264 typedef int (*import_filter_t)(kbnode_t keyblock, void *arg);
266 int parse_import_options(char *str,unsigned int *options,int noisy);
267 void import_keys( char **fnames, int nnames,
268 void *stats_hd, unsigned int options );
269 int import_keys_stream (iobuf_t inp, void *stats_hd, unsigned char **fpr,
270 size_t *fpr_len, unsigned int options,
271 import_filter_t filter, void *filter_arg);
272 void *import_new_stats_handle (void);
273 void import_release_stats_handle (void *p);
274 void import_print_stats (void *hd);
276 int collapse_uids( KBNODE *keyblock );
278 int auto_create_card_key_stub ( const char *serialnostr,
279 const unsigned char *fpr1,
280 const unsigned char *fpr2,
281 const unsigned char *fpr3);
284 int parse_export_options(char *str,unsigned int *options,int noisy);
285 int export_pubkeys( strlist_t users, unsigned int options );
286 int export_pubkeys_stream( iobuf_t out, strlist_t users,
287 KBNODE *keyblock_out, unsigned int options );
288 int export_seckeys( strlist_t users );
289 int export_secsubkeys( strlist_t users );
292 int dearmor_file( const char *fname );
293 int enarmor_file( const char *fname );
296 struct revocation_reason_info;
297 int gen_revoke( const char *uname );
298 int gen_desig_revoke( const char *uname, strlist_t locusr);
299 int revocation_reason_build_cb( PKT_signature *sig, void *opaque );
300 struct revocation_reason_info *
301 ask_revocation_reason( int key_rev, int cert_rev, int hint );
302 void release_revocation_reason_info( struct revocation_reason_info *reason );
305 void public_key_list( strlist_t list, int locate_mode );
306 void secret_key_list( strlist_t list );
307 void print_subpackets_colon(PKT_signature *sig);
308 void reorder_keyblock (KBNODE keyblock);
309 void list_keyblock( KBNODE keyblock, int secret, int fpr, void *opaque );
310 void print_fingerprint (PKT_public_key *pk, PKT_secret_key *sk, int mode);
311 void print_revokers(PKT_public_key *pk);
312 void show_policy_url(PKT_signature *sig,int indent,int mode);
313 void show_keyserver_url(PKT_signature *sig,int indent,int mode);
314 void show_notation(PKT_signature *sig,int indent,int mode,int which);
315 void dump_attribs(const PKT_user_id *uid,
316 PKT_public_key *pk,PKT_secret_key *sk);
317 void set_attrib_fd(int fd);
318 void print_seckey_info (PKT_secret_key *sk);
319 void print_pubkey_info (FILE *fp, PKT_public_key *pk);
320 void print_card_key_info (FILE *fp, KBNODE keyblock);
323 void print_file_status( int status, const char *name, int what );
324 int verify_signatures( int nfiles, char **files );
325 int verify_files( int nfiles, char **files );
326 int gpg_verify (ctrl_t ctrl, int sig_fd, int data_fd, FILE *out_fp);
329 int decrypt_message( const char *filename );
330 void decrypt_messages(int nfiles, char *files[]);
332 /*-- plaintext.c --*/
333 int hash_datafiles( gcry_md_hd_t md, gcry_md_hd_t md2,
334 strlist_t files, const char *sigfilename, int textmode );
335 int hash_datafile_by_fd ( gcry_md_hd_t md, gcry_md_hd_t md2, int data_fd,
337 PKT_plaintext *setup_plaintext_name(const char *filename,IOBUF iobuf);
340 void init_signals(void);
341 void pause_on_sigusr( int which );
342 void block_all_signals(void);
343 void unblock_all_signals(void);
346 int gpg_server (ctrl_t);
348 #ifdef ENABLE_CARD_SUPPORT
349 /*-- card-util.c --*/
350 void change_pin (int no, int allow_admin);
351 void card_status (FILE *fp, char *serialno, size_t serialnobuflen);
352 void card_edit (strlist_t commands);
353 int card_generate_subkey (KBNODE pub_keyblock, KBNODE sec_keyblock);
354 int card_store_subkey (KBNODE node, int use);
357 #define S2K_DECODE_COUNT(_val) ((16ul + ((_val) & 15)) << (((_val) >> 4) + 6))
359 #endif /*G10_MAIN_H*/