common: Add cpr_get_answer_is_yes_def()
[gnupg.git] / g10 / main.h
1 /* main.h
2  * Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
3  *               2008, 2009, 2010 Free Software Foundation, Inc.
4  *
5  * This file is part of GnuPG.
6  *
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.
11  *
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.
16  *
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/>.
19  */
20 #ifndef G10_MAIN_H
21 #define G10_MAIN_H
22
23 #include "types.h"
24 #include "iobuf.h"
25 #include "keydb.h"
26 #include "util.h"
27
28 /* It could be argued that the default cipher should be 3DES rather
29    than CAST5, 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. */
32
33 #define DEFAULT_CIPHER_ALGO     CIPHER_ALGO_CAST5
34 #define DEFAULT_DIGEST_ALGO     DIGEST_ALGO_SHA1
35 #define DEFAULT_S2K_DIGEST_ALGO DIGEST_ALGO_SHA1
36 #ifdef HAVE_ZIP
37 # define DEFAULT_COMPRESS_ALGO   COMPRESS_ALGO_ZIP
38 #else
39 # define DEFAULT_COMPRESS_ALGO   COMPRESS_ALGO_NONE
40 #endif
41
42
43 #define S2K_DIGEST_ALGO (opt.s2k_digest_algo?opt.s2k_digest_algo:DEFAULT_S2K_DIGEST_ALGO)
44
45
46 /* Various data objects.  */
47
48 typedef struct
49 {
50   int header_okay;
51   PK_LIST pk_list;
52   DEK *symkey_dek;
53   STRING2KEY *symkey_s2k;
54   cipher_filter_context_t cfx;
55 } encrypt_filter_context_t;
56
57
58 struct groupitem
59 {
60   char *name;
61   strlist_t values;
62   struct groupitem *next;
63 };
64
65
66 /*-- gpg.c --*/
67 extern int g10_errors_seen;
68
69 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 5 )
70   void g10_exit(int rc) __attribute__ ((noreturn));
71 #else
72   void g10_exit(int rc);
73 #endif
74 void print_pubkey_algo_note (pubkey_algo_t algo);
75 void print_cipher_algo_note (cipher_algo_t algo);
76 void print_digest_algo_note (digest_algo_t algo);
77
78 /*-- armor.c --*/
79 char *make_radix64_string( const byte *data, size_t len );
80
81 /*-- misc.c --*/
82 void trap_unaligned(void);
83 int disable_core_dumps(void);
84 void register_secured_file (const char *fname);
85 void unregister_secured_file (const char *fname);
86 int  is_secured_file (int fd);
87 int  is_secured_filename (const char *fname);
88 u16 checksum_u16( unsigned n );
89 u16 checksum( byte *p, unsigned n );
90 u16 checksum_mpi( gcry_mpi_t a );
91 u32 buffer_to_u32( const byte *buffer );
92 const byte *get_session_marker( size_t *rlen );
93
94 enum gcry_cipher_algos map_cipher_openpgp_to_gcry (cipher_algo_t algo);
95 #define openpgp_cipher_open(_a,_b,_c,_d) \
96   gcry_cipher_open((_a),map_cipher_openpgp_to_gcry((_b)),(_c),(_d))
97 #define openpgp_cipher_get_algo_keylen(_a) \
98   gcry_cipher_get_algo_keylen(map_cipher_openpgp_to_gcry((_a)))
99 #define openpgp_cipher_get_algo_blklen(_a) \
100   gcry_cipher_get_algo_blklen(map_cipher_openpgp_to_gcry((_a)))
101 int openpgp_cipher_blocklen (cipher_algo_t algo);
102 int openpgp_cipher_test_algo(cipher_algo_t algo);
103 const char *openpgp_cipher_algo_name (cipher_algo_t algo);
104
105 pubkey_algo_t map_pk_gcry_to_openpgp (enum gcry_pk_algos algo);
106 int openpgp_pk_test_algo (pubkey_algo_t algo);
107 int openpgp_pk_test_algo2 (pubkey_algo_t algo, unsigned int use);
108 int openpgp_pk_algo_usage ( int algo );
109 const char *openpgp_pk_algo_name (pubkey_algo_t algo);
110
111 enum gcry_md_algos map_md_openpgp_to_gcry (digest_algo_t algo);
112 int openpgp_md_test_algo (digest_algo_t algo);
113 const char *openpgp_md_algo_name (int algo);
114
115 struct expando_args
116 {
117   PKT_public_key *pk;
118   PKT_public_key *pksk;
119   byte imagetype;
120   int validity_info;
121   const char *validity_string;
122   const byte *namehash;
123 };
124
125 char *pct_expando(const char *string,struct expando_args *args);
126 void deprecated_warning(const char *configname,unsigned int configlineno,
127                         const char *option,const char *repl1,const char *repl2);
128 void deprecated_command (const char *name);
129 void obsolete_option (const char *configname, unsigned int configlineno,
130                       const char *name);
131
132 int string_to_cipher_algo (const char *string);
133 int string_to_digest_algo (const char *string);
134
135 const char *compress_algo_to_string(int algo);
136 int string_to_compress_algo(const char *string);
137 int check_compress_algo(int algo);
138 int default_cipher_algo(void);
139 int default_compress_algo(void);
140 const char *compliance_option_string(void);
141 void compliance_failure(void);
142
143 struct parse_options
144 {
145   char *name;
146   unsigned int bit;
147   char **value;
148   char *help;
149 };
150
151 char *optsep(char **stringp);
152 char *argsplit(char *string);
153 int parse_options(char *str,unsigned int *options,
154                   struct parse_options *opts,int noisy);
155 int has_invalid_email_chars (const char *s);
156 int is_valid_mailbox (const char *name);
157 const char *get_libexecdir (void);
158 int path_access(const char *file,int mode);
159
160 int pubkey_get_npkey (pubkey_algo_t algo);
161 int pubkey_get_nskey (pubkey_algo_t algo);
162 int pubkey_get_nsig (pubkey_algo_t algo);
163 int pubkey_get_nenc (pubkey_algo_t algo);
164
165 /* Temporary helpers. */
166 unsigned int pubkey_nbits( int algo, gcry_mpi_t *pkey );
167 int mpi_print (estream_t stream, gcry_mpi_t a, int mode);
168 unsigned int ecdsa_qbits_from_Q (unsigned int qbits);
169
170
171 /*-- status.c --*/
172 void set_status_fd ( int fd );
173 int  is_status_enabled ( void );
174 void write_status ( int no );
175 void write_status_error (const char *where, gpg_error_t err);
176 void write_status_errcode (const char *where, int errcode);
177 void write_status_text ( int no, const char *text );
178 void write_status_strings (int no, const char *text,
179                            ...) GNUPG_GCC_A_SENTINEL(0);
180 void write_status_buffer ( int no,
181                            const char *buffer, size_t len, int wrap );
182 void write_status_text_and_buffer ( int no, const char *text,
183                                     const char *buffer, size_t len, int wrap );
184
185 void write_status_begin_signing (gcry_md_hd_t md);
186
187
188 int cpr_enabled(void);
189 char *cpr_get( const char *keyword, const char *prompt );
190 char *cpr_get_no_help( const char *keyword, const char *prompt );
191 char *cpr_get_utf8( const char *keyword, const char *prompt );
192 char *cpr_get_hidden( const char *keyword, const char *prompt );
193 void cpr_kill_prompt(void);
194 int  cpr_get_answer_is_yes_def (const char *keyword, const char *prompt,
195                                 int def_yes);
196 int  cpr_get_answer_is_yes( const char *keyword, const char *prompt );
197 int  cpr_get_answer_yes_no_quit( const char *keyword, const char *prompt );
198 int  cpr_get_answer_okay_cancel (const char *keyword,
199                                  const char *prompt,
200                                  int def_answer);
201
202 /*-- helptext.c --*/
203 void display_online_help( const char *keyword );
204
205 /*-- encode.c --*/
206 int setup_symkey (STRING2KEY **symkey_s2k,DEK **symkey_dek);
207 int encrypt_symmetric (const char *filename );
208 int encrypt_store (const char *filename );
209 int encrypt_crypt (ctrl_t ctrl, int filefd, const char *filename,
210                    strlist_t remusr, int use_symkey, pk_list_t provided_keys,
211                    int outputfd);
212 void encrypt_crypt_files (ctrl_t ctrl,
213                           int nfiles, char **files, strlist_t remusr);
214 int encrypt_filter (void *opaque, int control,
215                     iobuf_t a, byte *buf, size_t *ret_len);
216
217
218 /*-- sign.c --*/
219 int complete_sig (PKT_signature *sig, PKT_public_key *pksk, gcry_md_hd_t md,
220                   const char *cache_nonce);
221 int sign_file (ctrl_t ctrl, strlist_t filenames, int detached, strlist_t locusr,
222                int do_encrypt, strlist_t remusr, const char *outfile );
223 int clearsign_file( const char *fname, strlist_t locusr, const char *outfile );
224 int sign_symencrypt_file (const char *fname, strlist_t locusr);
225
226 /*-- sig-check.c --*/
227 int check_revocation_keys (PKT_public_key *pk, PKT_signature *sig);
228 int check_backsig(PKT_public_key *main_pk,PKT_public_key *sub_pk,
229                   PKT_signature *backsig);
230 int check_key_signature( KBNODE root, KBNODE node, int *is_selfsig );
231 int check_key_signature2( KBNODE root, KBNODE node, PKT_public_key *check_pk,
232                           PKT_public_key *ret_pk, int *is_selfsig,
233                           u32 *r_expiredate, int *r_expired );
234
235 /*-- delkey.c --*/
236 gpg_error_t delete_keys (strlist_t names, int secret, int allow_both);
237
238 /*-- keyedit.c --*/
239 void keyedit_menu (ctrl_t ctrl, const char *username, strlist_t locusr,
240                    strlist_t commands, int quiet, int seckey_check );
241 void keyedit_passwd (ctrl_t ctrl, const char *username);
242 void keyedit_quick_sign (ctrl_t ctrl, const char *fpr,
243                          strlist_t uids, strlist_t locusr, int local);
244 void show_basic_key_info (KBNODE keyblock);
245
246 /*-- keygen.c --*/
247 u32 parse_expire_string(const char *string);
248 u32 ask_expire_interval(int object,const char *def_expire);
249 u32 ask_expiredate(void);
250 void generate_keypair (ctrl_t ctrl, const char *fname,
251                        const char *card_serialno, int card_backup_key);
252 int keygen_set_std_prefs (const char *string,int personal);
253 PKT_user_id *keygen_get_std_prefs (void);
254 int keygen_add_key_expire( PKT_signature *sig, void *opaque );
255 int keygen_add_std_prefs( PKT_signature *sig, void *opaque );
256 int keygen_upd_std_prefs( PKT_signature *sig, void *opaque );
257 int keygen_add_keyserver_url(PKT_signature *sig, void *opaque);
258 int keygen_add_notations(PKT_signature *sig,void *opaque);
259 int keygen_add_revkey(PKT_signature *sig, void *opaque);
260 gpg_error_t make_backsig (PKT_signature *sig, PKT_public_key *pk,
261                           PKT_public_key *sub_pk, PKT_public_key *sub_psk,
262                           u32 timestamp, const char *cache_nonce);
263 gpg_error_t generate_subkeypair (ctrl_t ctrl, kbnode_t pub_keyblock);
264 #ifdef ENABLE_CARD_SUPPORT
265 gpg_error_t generate_card_subkeypair (kbnode_t pub_keyblock,
266                                       int keyno, const char *serialno);
267 int save_unprotected_key_to_card (PKT_public_key *sk, int keyno);
268 #endif
269
270
271 /*-- openfile.c --*/
272 int overwrite_filep( const char *fname );
273 char *make_outfile_name( const char *iname );
274 char *ask_outfile_name( const char *name, size_t namelen );
275 int open_outfile (int inp_fd, const char *iname, int mode,
276                   int restrictedperm, iobuf_t *a);
277 iobuf_t open_sigfile( const char *iname, progress_filter_context_t *pfx );
278 void try_make_homedir( const char *fname );
279 char *get_openpgp_revocdir (const char *home);
280
281 /*-- seskey.c --*/
282 void make_session_key( DEK *dek );
283 gcry_mpi_t encode_session_key( int openpgp_pk_algo, DEK *dek, unsigned nbits );
284 gcry_mpi_t encode_md_value (PKT_public_key *pk,
285                             gcry_md_hd_t md, int hash_algo );
286
287 /*-- import.c --*/
288 int parse_import_options(char *str,unsigned int *options,int noisy);
289 void import_keys (ctrl_t ctrl, char **fnames, int nnames,
290                   void *stats_hd, unsigned int options);
291 int import_keys_stream (ctrl_t ctrl, iobuf_t inp, void *stats_hd,
292                         unsigned char **fpr,
293                         size_t *fpr_len, unsigned int options);
294 int import_keys_es_stream (ctrl_t ctrl, estream_t fp, void *stats_handle,
295                            unsigned char **fpr, size_t *fpr_len,
296                            unsigned int options);
297 gpg_error_t import_old_secring (ctrl_t ctrl, const char *fname);
298 void *import_new_stats_handle (void);
299 void import_release_stats_handle (void *p);
300 void import_print_stats (void *hd);
301
302 int collapse_uids( KBNODE *keyblock );
303
304
305 /*-- export.c --*/
306 int parse_export_options(char *str,unsigned int *options,int noisy);
307 int export_pubkeys (ctrl_t ctrl, strlist_t users, unsigned int options );
308 int export_pubkeys_stream (ctrl_t ctrl, iobuf_t out, strlist_t users,
309                            kbnode_t *keyblock_out, unsigned int options );
310 gpg_error_t export_pubkey_buffer (ctrl_t ctrl, const char *keyspec,
311                                   unsigned int options,
312                                   kbnode_t *r_keyblock,
313                                   void **r_data, size_t *r_datalen);
314 int export_seckeys (ctrl_t ctrl, strlist_t users);
315 int export_secsubkeys (ctrl_t ctrl, strlist_t users);
316
317 /*-- dearmor.c --*/
318 int dearmor_file( const char *fname );
319 int enarmor_file( const char *fname );
320
321 /*-- revoke.c --*/
322 struct revocation_reason_info;
323 int gen_standard_revoke (PKT_public_key *psk);
324 int gen_revoke( const char *uname );
325 int gen_desig_revoke( const char *uname, strlist_t locusr);
326 int revocation_reason_build_cb( PKT_signature *sig, void *opaque );
327 struct revocation_reason_info *
328                 ask_revocation_reason( int key_rev, int cert_rev, int hint );
329 void release_revocation_reason_info( struct revocation_reason_info *reason );
330
331 /*-- keylist.c --*/
332 void public_key_list (ctrl_t ctrl, strlist_t list, int locate_mode );
333 void secret_key_list (ctrl_t ctrl, strlist_t list );
334 void print_subpackets_colon(PKT_signature *sig);
335 void reorder_keyblock (KBNODE keyblock);
336 void list_keyblock (kbnode_t keyblock, int secret, int has_secret,
337                     int fpr, void *opaque);
338 void print_fingerprint (estream_t fp, PKT_public_key *pk, int mode);
339 void print_revokers (estream_t fp, PKT_public_key *pk);
340 void show_policy_url(PKT_signature *sig,int indent,int mode);
341 void show_keyserver_url(PKT_signature *sig,int indent,int mode);
342 void show_notation(PKT_signature *sig,int indent,int mode,int which);
343 void dump_attribs (const PKT_user_id *uid, PKT_public_key *pk);
344 void set_attrib_fd(int fd);
345 void print_seckey_info (PKT_public_key *pk);
346 void print_pubkey_info (estream_t fp, PKT_public_key *pk);
347 void print_card_key_info (estream_t fp, KBNODE keyblock);
348
349 /*-- verify.c --*/
350 void print_file_status( int status, const char *name, int what );
351 int verify_signatures (ctrl_t ctrl, int nfiles, char **files );
352 int verify_files (ctrl_t ctrl, int nfiles, char **files );
353 int gpg_verify (ctrl_t ctrl, int sig_fd, int data_fd, estream_t out_fp);
354
355 /*-- decrypt.c --*/
356 int decrypt_message (ctrl_t ctrl, const char *filename );
357 gpg_error_t decrypt_message_fd (ctrl_t ctrl, int input_fd, int output_fd);
358 void decrypt_messages (ctrl_t ctrl, int nfiles, char *files[]);
359
360 /*-- plaintext.c --*/
361 int hash_datafiles( gcry_md_hd_t md, gcry_md_hd_t md2,
362                     strlist_t files, const char *sigfilename, int textmode );
363 int hash_datafile_by_fd ( gcry_md_hd_t md, gcry_md_hd_t md2, int data_fd,
364                           int textmode );
365 PKT_plaintext *setup_plaintext_name(const char *filename,IOBUF iobuf);
366
367 /*-- signal.c --*/
368 void init_signals(void);
369 void block_all_signals(void);
370 void unblock_all_signals(void);
371
372 /*-- server.c --*/
373 int gpg_server (ctrl_t);
374 gpg_error_t gpg_proxy_pinentry_notify (ctrl_t ctrl,
375                                        const unsigned char *line);
376
377 #ifdef ENABLE_CARD_SUPPORT
378 /*-- card-util.c --*/
379 void change_pin (int no, int allow_admin);
380 void card_status (estream_t fp, char *serialno, size_t serialnobuflen);
381 void card_edit (ctrl_t ctrl, strlist_t commands);
382 gpg_error_t  card_generate_subkey (KBNODE pub_keyblock);
383 int  card_store_subkey (KBNODE node, int use);
384 #endif
385
386 #define S2K_DECODE_COUNT(_val) ((16ul + ((_val) & 15)) << (((_val) >> 4) + 6))
387
388 /*-- migrate.c --*/
389 void migrate_secring (ctrl_t ctrl);
390
391
392 #endif /*G10_MAIN_H*/