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