35c937375d73db38b9362baa44bce7997347ed81
[gnupg.git] / g10 / main.h
1 /* main.h
2  * Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
3  *               2008, 2009 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
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. */
34
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
39
40 #define S2K_DIGEST_ALGO (opt.s2k_digest_algo?opt.s2k_digest_algo:DEFAULT_S2K_DIGEST_ALGO)
41
42 typedef struct
43 {
44   int header_okay;
45   PK_LIST pk_list;
46   DEK *symkey_dek;
47   STRING2KEY *symkey_s2k;
48   cipher_filter_context_t cfx;
49 } encrypt_filter_context_t;
50
51 struct groupitem
52 {
53   char *name;
54   strlist_t values;
55   struct groupitem *next;
56 };
57
58 /*-- gpg.c --*/
59 extern int g10_errors_seen;
60
61 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 5 )
62   void g10_exit(int rc) __attribute__ ((noreturn));
63 #else
64   void g10_exit(int rc);
65 #endif
66 void print_pubkey_algo_note( int algo );
67 void print_cipher_algo_note( int algo );
68 void print_digest_algo_note( int algo );
69
70 /*-- armor.c --*/
71 char *make_radix64_string( const byte *data, size_t len );
72
73 /*-- misc.c --*/
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 int openpgp_md_test_algo( int algo );
97
98 #ifdef USE_IDEA
99 void idea_cipher_warn( int show );
100 #else
101 #define idea_cipher_warn(a)  do { } while (0)
102 #endif
103
104 struct expando_args
105 {
106   PKT_public_key *pk;
107   PKT_secret_key *sk;
108   byte imagetype;
109   int validity_info;
110   const char *validity_string;
111 };
112
113 char *pct_expando(const char *string,struct expando_args *args);
114 void deprecated_warning(const char *configname,unsigned int configlineno,
115                         const char *option,const char *repl1,const char *repl2);
116 void deprecated_command (const char *name);
117 void obsolete_option (const char *configname, unsigned int configlineno,
118                       const char *name);
119
120 int string_to_cipher_algo (const char *string);
121 int string_to_digest_algo (const char *string);
122
123 const char *compress_algo_to_string(int algo);
124 int string_to_compress_algo(const char *string);
125 int check_compress_algo(int algo);
126 int default_cipher_algo(void);
127 int default_compress_algo(void);
128 const char *compliance_option_string(void);
129 void compliance_failure(void);
130
131 struct parse_options
132 {
133   char *name;
134   unsigned int bit;
135   char **value;
136   char *help;
137 };
138
139 char *optsep(char **stringp);
140 char *argsplit(char *string);
141 int parse_options(char *str,unsigned int *options,
142                   struct parse_options *opts,int noisy);
143 int has_invalid_email_chars (const char *s);
144 int is_valid_mailbox (const char *name);
145 const char *get_libexecdir (void);
146 int path_access(const char *file,int mode);
147
148 /* Temporary helpers. */
149 int pubkey_get_npkey( int algo );
150 int pubkey_get_nskey( int algo );
151 int pubkey_get_nsig( int algo );
152 int pubkey_get_nenc( int algo );
153 unsigned int pubkey_nbits( int algo, gcry_mpi_t *pkey );
154 int mpi_print( FILE *fp, gcry_mpi_t a, int mode );
155
156 /*-- status.c --*/
157 void set_status_fd ( int fd );
158 int  is_status_enabled ( void );
159 void write_status ( int no );
160 void write_status_error (const char *where, int errcode);
161 void write_status_text ( int no, const char *text );
162 void write_status_buffer ( int no,
163                            const char *buffer, size_t len, int wrap );
164 void write_status_text_and_buffer ( int no, const char *text,
165                                     const char *buffer, size_t len, int wrap );
166
167 void write_status_begin_signing (gcry_md_hd_t md);
168
169
170 int cpr_enabled(void);
171 char *cpr_get( const char *keyword, const char *prompt );
172 char *cpr_get_no_help( const char *keyword, const char *prompt );
173 char *cpr_get_utf8( const char *keyword, const char *prompt );
174 char *cpr_get_hidden( const char *keyword, const char *prompt );
175 void cpr_kill_prompt(void);
176 int  cpr_get_answer_is_yes( const char *keyword, const char *prompt );
177 int  cpr_get_answer_yes_no_quit( const char *keyword, const char *prompt );
178 int  cpr_get_answer_okay_cancel (const char *keyword,
179                                  const char *prompt,
180                                  int def_answer);
181
182 /*-- helptext.c --*/
183 void display_online_help( const char *keyword );
184
185 /*-- encode.c --*/
186 int setup_symkey(STRING2KEY **symkey_s2k,DEK **symkey_dek);
187 int encode_symmetric( const char *filename );
188 int encode_store( const char *filename );
189 int encode_crypt( const char *filename, strlist_t remusr, int use_symkey );
190 void encode_crypt_files(int nfiles, char **files, strlist_t remusr);
191 int encrypt_filter( void *opaque, int control,
192                     iobuf_t a, byte *buf, size_t *ret_len);
193
194
195 /*-- sign.c --*/
196 int complete_sig( PKT_signature *sig, PKT_secret_key *sk, gcry_md_hd_t md );
197 int sign_file( strlist_t filenames, int detached, strlist_t locusr,
198                int do_encrypt, strlist_t remusr, const char *outfile );
199 int clearsign_file( const char *fname, strlist_t locusr, const char *outfile );
200 int sign_symencrypt_file (const char *fname, strlist_t locusr);
201
202 /*-- sig-check.c --*/
203 int check_revocation_keys (PKT_public_key *pk, PKT_signature *sig);
204 int check_backsig(PKT_public_key *main_pk,PKT_public_key *sub_pk,
205                   PKT_signature *backsig);
206 int check_key_signature( KBNODE root, KBNODE node, int *is_selfsig );
207 int check_key_signature2( KBNODE root, KBNODE node, PKT_public_key *check_pk,
208                           PKT_public_key *ret_pk, int *is_selfsig,
209                           u32 *r_expiredate, int *r_expired );
210
211 /*-- delkey.c --*/
212 int delete_keys( strlist_t names, int secret, int allow_both );
213
214 /*-- keyedit.c --*/
215 void keyedit_menu( const char *username, strlist_t locusr,
216                    strlist_t commands, int quiet, int seckey_check );
217 void keyedit_passwd (const char *username);
218 void show_basic_key_info (KBNODE keyblock);
219
220 /*-- keygen.c --*/
221 u32 parse_expire_string(const char *string);
222 u32 ask_expire_interval(int object,const char *def_expire);
223 u32 ask_expiredate(void);
224 void generate_keypair( const char *fname, const char *card_serialno,
225                        const char *backup_encryption_dir );
226 int keygen_set_std_prefs (const char *string,int personal);
227 PKT_user_id *keygen_get_std_prefs (void);
228 int keygen_add_key_expire( PKT_signature *sig, void *opaque );
229 int keygen_add_std_prefs( PKT_signature *sig, void *opaque );
230 int keygen_upd_std_prefs( PKT_signature *sig, void *opaque );
231 int keygen_add_keyserver_url(PKT_signature *sig, void *opaque);
232 int keygen_add_notations(PKT_signature *sig,void *opaque);
233 int keygen_add_revkey(PKT_signature *sig, void *opaque);
234 int make_backsig(PKT_signature *sig,PKT_public_key *pk,
235                  PKT_public_key *sub_pk,PKT_secret_key *sub_sk,
236                  u32 timestamp);
237 int generate_subkeypair( KBNODE pub_keyblock, KBNODE sec_keyblock );
238 #ifdef ENABLE_CARD_SUPPORT
239 int generate_card_subkeypair (KBNODE pub_keyblock, KBNODE sec_keyblock,
240                               int keyno, const char *serialno);
241 int save_unprotected_key_to_card (PKT_secret_key *sk, int keyno);
242 #endif
243
244 /*-- openfile.c --*/
245 int overwrite_filep( const char *fname );
246 char *make_outfile_name( const char *iname );
247 char *ask_outfile_name( const char *name, size_t namelen );
248 int   open_outfile( const char *iname, int mode, iobuf_t *a );
249 iobuf_t open_sigfile( const char *iname, progress_filter_context_t *pfx );
250 void try_make_homedir( const char *fname );
251
252 /*-- seskey.c --*/
253 void make_session_key( DEK *dek );
254 gcry_mpi_t encode_session_key( DEK *dek, unsigned nbits );
255 gcry_mpi_t encode_md_value( PKT_public_key *pk, PKT_secret_key *sk,
256                             gcry_md_hd_t md, int hash_algo );
257
258 /*-- import.c --*/
259 int parse_import_options(char *str,unsigned int *options,int noisy);
260 void import_keys( char **fnames, int nnames,
261                   void *stats_hd, unsigned int options );
262 int import_keys_stream( iobuf_t inp,void *stats_hd,unsigned char **fpr,
263                         size_t *fpr_len,unsigned int options );
264 void *import_new_stats_handle (void);
265 void import_release_stats_handle (void *p);
266 void import_print_stats (void *hd);
267
268 int collapse_uids( KBNODE *keyblock );
269
270 int auto_create_card_key_stub ( const char *serialnostr,
271                                 const unsigned char *fpr1,
272                                 const unsigned char *fpr2,
273                                 const unsigned char *fpr3);
274
275 /*-- export.c --*/
276 int parse_export_options(char *str,unsigned int *options,int noisy);
277 int export_pubkeys( strlist_t users, unsigned int options );
278 int export_pubkeys_stream( iobuf_t out, strlist_t users,
279                            KBNODE *keyblock_out, unsigned int options );
280 int export_seckeys( strlist_t users );
281 int export_secsubkeys( strlist_t users );
282
283 /* dearmor.c --*/
284 int dearmor_file( const char *fname );
285 int enarmor_file( const char *fname );
286
287 /*-- revoke.c --*/
288 struct revocation_reason_info;
289 int gen_revoke( const char *uname );
290 int gen_desig_revoke( const char *uname, strlist_t locusr);
291 int revocation_reason_build_cb( PKT_signature *sig, void *opaque );
292 struct revocation_reason_info *
293                 ask_revocation_reason( int key_rev, int cert_rev, int hint );
294 void release_revocation_reason_info( struct revocation_reason_info *reason );
295
296 /*-- keylist.c --*/
297 void public_key_list( strlist_t list, int locate_mode );
298 void secret_key_list( strlist_t list );
299 void print_subpackets_colon(PKT_signature *sig);
300 void reorder_keyblock (KBNODE keyblock);
301 void list_keyblock( KBNODE keyblock, int secret, int fpr, void *opaque );
302 void print_fingerprint (PKT_public_key *pk, PKT_secret_key *sk, int mode);
303 void print_revokers(PKT_public_key *pk);
304 void show_policy_url(PKT_signature *sig,int indent,int mode);
305 void show_keyserver_url(PKT_signature *sig,int indent,int mode);
306 void show_notation(PKT_signature *sig,int indent,int mode,int which);
307 void dump_attribs(const PKT_user_id *uid,
308                   PKT_public_key *pk,PKT_secret_key *sk);
309 void set_attrib_fd(int fd);
310 void print_seckey_info (PKT_secret_key *sk);
311 void print_pubkey_info (FILE *fp, PKT_public_key *pk);
312 void print_card_key_info (FILE *fp, KBNODE keyblock);
313
314 /*-- verify.c --*/
315 void print_file_status( int status, const char *name, int what );
316 int verify_signatures( int nfiles, char **files );
317 int verify_files( int nfiles, char **files );
318 int gpg_verify (ctrl_t ctrl, int sig_fd, int data_fd, FILE *out_fp);
319
320 /*-- decrypt.c --*/
321 int decrypt_message( const char *filename );
322 void decrypt_messages(int nfiles, char *files[]);
323
324 /*-- plaintext.c --*/
325 int hash_datafiles( gcry_md_hd_t md, gcry_md_hd_t md2,
326                     strlist_t files, const char *sigfilename, int textmode );
327 int hash_datafile_by_fd ( gcry_md_hd_t md, gcry_md_hd_t md2, int data_fd,
328                           int textmode );
329 PKT_plaintext *setup_plaintext_name(const char *filename,IOBUF iobuf);
330
331 /*-- signal.c --*/
332 void init_signals(void);
333 void pause_on_sigusr( int which );
334 void block_all_signals(void);
335 void unblock_all_signals(void);
336
337 /*-- server.c --*/
338 int gpg_server (ctrl_t);
339
340 #ifdef ENABLE_CARD_SUPPORT
341 /*-- card-util.c --*/
342 void change_pin (int no, int allow_admin);
343 void card_status (FILE *fp, char *serialno, size_t serialnobuflen);
344 void card_edit (strlist_t commands);
345 int  card_generate_subkey (KBNODE pub_keyblock, KBNODE sec_keyblock);
346 int  card_store_subkey (KBNODE node, int use);
347 #endif
348
349 #define S2K_DECODE_COUNT(_val) ((16ul + ((_val) & 15)) << (((_val) >> 4) + 6))
350
351 #endif /*G10_MAIN_H*/