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