15d3b7627cfed4755d1064a9646d89565f7d051b
[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 map_pk_gcry_to_openpgp (enum gcry_pk_algos algo);
101 int openpgp_pk_test_algo( int algo );
102 int openpgp_pk_test_algo2 ( int algo, unsigned int use );
103 int openpgp_pk_algo_usage ( int algo );
104 int openpgp_md_test_algo( int algo );
105 const char *openpgp_pk_algo_name (int algo);
106 const char *openpgp_md_algo_name (int algo);
107
108 struct expando_args
109 {
110   PKT_public_key *pk;
111   PKT_public_key *pksk;
112   byte imagetype;
113   int validity_info;
114   const char *validity_string;
115 };
116
117 char *pct_expando(const char *string,struct expando_args *args);
118 void deprecated_warning(const char *configname,unsigned int configlineno,
119                         const char *option,const char *repl1,const char *repl2);
120 void deprecated_command (const char *name);
121 void obsolete_option (const char *configname, unsigned int configlineno,
122                       const char *name);
123
124 int string_to_cipher_algo (const char *string);
125 int string_to_digest_algo (const char *string);
126
127 const char *compress_algo_to_string(int algo);
128 int string_to_compress_algo(const char *string);
129 int check_compress_algo(int algo);
130 int default_cipher_algo(void);
131 int default_compress_algo(void);
132 const char *compliance_option_string(void);
133 void compliance_failure(void);
134
135 struct parse_options
136 {
137   char *name;
138   unsigned int bit;
139   char **value;
140   char *help;
141 };
142
143 char *optsep(char **stringp);
144 char *argsplit(char *string);
145 int parse_options(char *str,unsigned int *options,
146                   struct parse_options *opts,int noisy);
147 int has_invalid_email_chars (const char *s);
148 int is_valid_mailbox (const char *name);
149 const char *get_libexecdir (void);
150 int path_access(const char *file,int mode);
151
152 int pubkey_get_npkey( int algo );
153 int pubkey_get_nskey( int algo );
154 int pubkey_get_nsig( int algo );
155 int pubkey_get_nenc( int algo );
156
157 /* Temporary helpers. */
158 unsigned int pubkey_nbits( int algo, gcry_mpi_t *pkey );
159 int mpi_print (estream_t stream, gcry_mpi_t a, int mode);
160 unsigned int ecdsa_qbits_from_Q (unsigned int qbits);
161
162
163 /*-- status.c --*/
164 void set_status_fd ( int fd );
165 int  is_status_enabled ( void );
166 void write_status ( int no );
167 void write_status_error (const char *where, gpg_error_t err);
168 void write_status_errcode (const char *where, int errcode);
169 void write_status_text ( int no, const char *text );
170 void write_status_buffer ( int no,
171                            const char *buffer, size_t len, int wrap );
172 void write_status_text_and_buffer ( int no, const char *text,
173                                     const char *buffer, size_t len, int wrap );
174
175 void write_status_begin_signing (gcry_md_hd_t md);
176
177
178 int cpr_enabled(void);
179 char *cpr_get( const char *keyword, const char *prompt );
180 char *cpr_get_no_help( const char *keyword, const char *prompt );
181 char *cpr_get_utf8( const char *keyword, const char *prompt );
182 char *cpr_get_hidden( const char *keyword, const char *prompt );
183 void cpr_kill_prompt(void);
184 int  cpr_get_answer_is_yes( const char *keyword, const char *prompt );
185 int  cpr_get_answer_yes_no_quit( const char *keyword, const char *prompt );
186 int  cpr_get_answer_okay_cancel (const char *keyword,
187                                  const char *prompt,
188                                  int def_answer);
189
190 /*-- helptext.c --*/
191 void display_online_help( const char *keyword );
192
193 /*-- encode.c --*/
194 int setup_symkey (STRING2KEY **symkey_s2k,DEK **symkey_dek);
195 int encrypt_symmetric (const char *filename );
196 int encrypt_store (const char *filename );
197 int encrypt_crypt (ctrl_t ctrl, int filefd, const char *filename,
198                    strlist_t remusr, int use_symkey, pk_list_t provided_keys,
199                    int outputfd);
200 void encrypt_crypt_files (ctrl_t ctrl,
201                           int nfiles, char **files, strlist_t remusr);
202 int encrypt_filter (void *opaque, int control,
203                     iobuf_t a, byte *buf, size_t *ret_len);
204
205
206 /*-- sign.c --*/
207 int complete_sig (PKT_signature *sig, PKT_public_key *pksk, gcry_md_hd_t md,
208                   const char *cache_nonce);
209 int sign_file (ctrl_t ctrl, strlist_t filenames, int detached, strlist_t locusr,
210                int do_encrypt, strlist_t remusr, const char *outfile );
211 int clearsign_file( const char *fname, strlist_t locusr, const char *outfile );
212 int sign_symencrypt_file (const char *fname, strlist_t locusr);
213
214 /*-- sig-check.c --*/
215 int check_revocation_keys (PKT_public_key *pk, PKT_signature *sig);
216 int check_backsig(PKT_public_key *main_pk,PKT_public_key *sub_pk,
217                   PKT_signature *backsig);
218 int check_key_signature( KBNODE root, KBNODE node, int *is_selfsig );
219 int check_key_signature2( KBNODE root, KBNODE node, PKT_public_key *check_pk,
220                           PKT_public_key *ret_pk, int *is_selfsig,
221                           u32 *r_expiredate, int *r_expired );
222
223 /*-- delkey.c --*/
224 int delete_keys( strlist_t names, int secret, int allow_both );
225
226 /*-- keyedit.c --*/
227 void keyedit_menu (ctrl_t ctrl, const char *username, strlist_t locusr,
228                    strlist_t commands, int quiet, int seckey_check );
229 void keyedit_passwd (ctrl_t ctrl, const char *username);
230 void show_basic_key_info (KBNODE keyblock);
231
232 /*-- keygen.c --*/
233 const char *gpg_curve_to_oid (const char *name, unsigned int *r_nbits);
234 u32 parse_expire_string(const char *string);
235 u32 ask_expire_interval(int object,const char *def_expire);
236 u32 ask_expiredate(void);
237 void generate_keypair (ctrl_t ctrl, const char *fname,
238                        const char *card_serialno, int card_backup_key);
239 int keygen_set_std_prefs (const char *string,int personal);
240 PKT_user_id *keygen_get_std_prefs (void);
241 int keygen_add_key_expire( PKT_signature *sig, void *opaque );
242 int keygen_add_std_prefs( PKT_signature *sig, void *opaque );
243 int keygen_upd_std_prefs( PKT_signature *sig, void *opaque );
244 int keygen_add_keyserver_url(PKT_signature *sig, void *opaque);
245 int keygen_add_notations(PKT_signature *sig,void *opaque);
246 int keygen_add_revkey(PKT_signature *sig, void *opaque);
247 gpg_error_t make_backsig (PKT_signature *sig, PKT_public_key *pk,
248                           PKT_public_key *sub_pk, PKT_public_key *sub_psk,
249                           u32 timestamp, const char *cache_nonce);
250 gpg_error_t generate_subkeypair (ctrl_t ctrl, kbnode_t pub_keyblock);
251 #ifdef ENABLE_CARD_SUPPORT
252 gpg_error_t generate_card_subkeypair (kbnode_t pub_keyblock,
253                                       int keyno, const char *serialno);
254 int save_unprotected_key_to_card (PKT_public_key *sk, int keyno);
255 #endif
256
257
258 /*-- openfile.c --*/
259 int overwrite_filep( const char *fname );
260 char *make_outfile_name( const char *iname );
261 char *ask_outfile_name( const char *name, size_t namelen );
262 int open_outfile (int inp_fd, const char *iname, int mode, iobuf_t *a);
263 iobuf_t open_sigfile( const char *iname, progress_filter_context_t *pfx );
264 void try_make_homedir( const char *fname );
265
266 /*-- seskey.c --*/
267 void make_session_key( DEK *dek );
268 gcry_mpi_t encode_session_key( int openpgp_pk_algo, DEK *dek, unsigned nbits );
269 gcry_mpi_t encode_md_value (PKT_public_key *pk,
270                             gcry_md_hd_t md, int hash_algo );
271
272 /*-- import.c --*/
273 int parse_import_options(char *str,unsigned int *options,int noisy);
274 void import_keys (ctrl_t ctrl, char **fnames, int nnames,
275                   void *stats_hd, unsigned int options);
276 int import_keys_stream (ctrl_t ctrl, iobuf_t inp, void *stats_hd,
277                         unsigned char **fpr,
278                         size_t *fpr_len, unsigned int options);
279 int import_keys_es_stream (ctrl_t ctrl, estream_t fp, void *stats_handle,
280                            unsigned char **fpr, size_t *fpr_len,
281                            unsigned int options);
282 void *import_new_stats_handle (void);
283 void import_release_stats_handle (void *p);
284 void import_print_stats (void *hd);
285
286 int collapse_uids( KBNODE *keyblock );
287
288
289 /*-- export.c --*/
290 int parse_export_options(char *str,unsigned int *options,int noisy);
291 int export_pubkeys (ctrl_t ctrl, strlist_t users, unsigned int options );
292 int export_pubkeys_stream (ctrl_t ctrl, iobuf_t out, strlist_t users,
293                            kbnode_t *keyblock_out, unsigned int options );
294 gpg_error_t export_pubkey_buffer (ctrl_t ctrl, const char *keyspec,
295                                   unsigned int options,
296                                   kbnode_t *r_keyblock,
297                                   void **r_data, size_t *r_datalen);
298 int export_seckeys (ctrl_t ctrl, strlist_t users);
299 int export_secsubkeys (ctrl_t ctrl, strlist_t users);
300
301 /*-- dearmor.c --*/
302 int dearmor_file( const char *fname );
303 int enarmor_file( const char *fname );
304
305 /*-- revoke.c --*/
306 struct revocation_reason_info;
307 int gen_revoke( const char *uname );
308 int gen_desig_revoke( const char *uname, strlist_t locusr);
309 int revocation_reason_build_cb( PKT_signature *sig, void *opaque );
310 struct revocation_reason_info *
311                 ask_revocation_reason( int key_rev, int cert_rev, int hint );
312 void release_revocation_reason_info( struct revocation_reason_info *reason );
313
314 /*-- keylist.c --*/
315 void public_key_list (ctrl_t ctrl, strlist_t list, int locate_mode );
316 void secret_key_list (ctrl_t ctrl, strlist_t list );
317 void print_subpackets_colon(PKT_signature *sig);
318 void reorder_keyblock (KBNODE keyblock);
319 void list_keyblock( KBNODE keyblock, int secret, int fpr, void *opaque );
320 void print_fingerprint (PKT_public_key *pk, int mode);
321 void print_revokers(PKT_public_key *pk);
322 void show_policy_url(PKT_signature *sig,int indent,int mode);
323 void show_keyserver_url(PKT_signature *sig,int indent,int mode);
324 void show_notation(PKT_signature *sig,int indent,int mode,int which);
325 void dump_attribs (const PKT_user_id *uid, PKT_public_key *pk);
326 void set_attrib_fd(int fd);
327 void print_seckey_info (PKT_public_key *pk);
328 void print_pubkey_info (estream_t fp, PKT_public_key *pk);
329 void print_card_key_info (estream_t fp, KBNODE keyblock);
330
331 /*-- verify.c --*/
332 void print_file_status( int status, const char *name, int what );
333 int verify_signatures (ctrl_t ctrl, int nfiles, char **files );
334 int verify_files (ctrl_t ctrl, int nfiles, char **files );
335 int gpg_verify (ctrl_t ctrl, int sig_fd, int data_fd, estream_t out_fp);
336
337 /*-- decrypt.c --*/
338 int decrypt_message (ctrl_t ctrl, const char *filename );
339 gpg_error_t decrypt_message_fd (ctrl_t ctrl, int input_fd, int output_fd);
340 void decrypt_messages (ctrl_t ctrl, int nfiles, char *files[]);
341
342 /*-- plaintext.c --*/
343 int hash_datafiles( gcry_md_hd_t md, gcry_md_hd_t md2,
344                     strlist_t files, const char *sigfilename, int textmode );
345 int hash_datafile_by_fd ( gcry_md_hd_t md, gcry_md_hd_t md2, int data_fd,
346                           int textmode );
347 PKT_plaintext *setup_plaintext_name(const char *filename,IOBUF iobuf);
348
349 /*-- signal.c --*/
350 void init_signals(void);
351 void block_all_signals(void);
352 void unblock_all_signals(void);
353
354 /*-- server.c --*/
355 int gpg_server (ctrl_t);
356 gpg_error_t gpg_proxy_pinentry_notify (ctrl_t ctrl,
357                                        const unsigned char *line);
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*/