69e0d95f50909ce5d4d8f9d0f50dbf59cb7f751d
[gnupg.git] / g10 / main.h
1 /* main.h
2  * Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
3  *               2006 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 2 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, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
20  * USA.
21  */
22 #ifndef G10_MAIN_H
23 #define G10_MAIN_H
24
25 #include "types.h"
26 #include "iobuf.h"
27 #include "cipher.h"
28 #include "keydb.h"
29 #include "util.h"
30
31
32 /* It could be argued that the default cipher should be 3DES rather
33    than CAST5, and the default compression should be 0
34    (i.e. uncompressed) rather than 1 (zip).  However, the real world
35    issues of speed and size come into play here. */
36
37 #define DEFAULT_CIPHER_ALGO     CIPHER_ALGO_CAST5
38 #define DEFAULT_DIGEST_ALGO     DIGEST_ALGO_SHA1
39 #define DEFAULT_COMPRESS_ALGO   COMPRESS_ALGO_ZIP
40 #define DEFAULT_S2K_DIGEST_ALGO DIGEST_ALGO_SHA1
41
42 #define S2K_DIGEST_ALGO (opt.s2k_digest_algo?opt.s2k_digest_algo:DEFAULT_S2K_DIGEST_ALGO)
43
44 typedef struct
45 {
46   int header_okay;
47   PK_LIST pk_list;
48   DEK *symkey_dek;
49   STRING2KEY *symkey_s2k;
50   cipher_filter_context_t cfx;
51 } encrypt_filter_context_t;
52
53 struct groupitem
54 {
55   char *name;
56   strlist_t values;
57   struct groupitem *next;
58 };
59
60 /*-- gpg.c --*/
61 extern int g10_errors_seen;
62
63 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 5 )
64   void g10_exit(int rc) __attribute__ ((noreturn));
65 #else
66   void g10_exit(int rc);
67 #endif
68 void print_pubkey_algo_note( int algo );
69 void print_cipher_algo_note( int algo );
70 void print_digest_algo_note( int algo );
71
72 /*-- armor.c --*/
73 char *make_radix64_string( const byte *data, size_t len );
74
75 /*-- misc.c --*/
76 void trap_unaligned(void);
77 int disable_core_dumps(void);
78 void register_secured_file (const char *fname);
79 void unregister_secured_file (const char *fname);
80 int  is_secured_file (int fd);
81 int  is_secured_filename (const char *fname);
82 u16 checksum_u16( unsigned n );
83 u16 checksum( byte *p, unsigned n );
84 u16 checksum_mpi( gcry_mpi_t a );
85 u32 buffer_to_u32( const byte *buffer );
86 const byte *get_session_marker( size_t *rlen );
87 int openpgp_cipher_test_algo( int algo );
88 int openpgp_pk_test_algo( int algo );
89 int openpgp_pk_test_algo2 ( int algo, unsigned int use );
90 int openpgp_pk_algo_usage ( int algo );
91 int openpgp_md_test_algo( int algo );
92
93 #ifdef USE_IDEA
94 void idea_cipher_warn( int show );
95 #else
96 #define idea_cipher_warn(a)
97 #endif
98
99 struct expando_args
100 {
101   PKT_public_key *pk;
102   PKT_secret_key *sk;
103   byte imagetype;
104 };
105
106 char *pct_expando(const char *string,struct expando_args *args);
107 void deprecated_warning(const char *configname,unsigned int configlineno,
108                         const char *option,const char *repl1,const char *repl2);
109 void deprecated_command (const char *name);
110 void obsolete_option (const char *configname, unsigned int configlineno, 
111                       const char *name);
112
113 int string_to_cipher_algo (const char *string);
114 int string_to_digest_algo (const char *string);
115
116 const char *compress_algo_to_string(int algo);
117 int string_to_compress_algo(const char *string);
118 int check_compress_algo(int algo);
119 int default_cipher_algo(void);
120 int default_compress_algo(void);
121 const char *compliance_option_string(void);
122 void compliance_failure(void);
123
124 struct parse_options
125 {
126   char *name;
127   unsigned int bit;
128   char **value;
129   char *help;
130 };
131
132 char *optsep(char **stringp);
133 char *argsplit(char *string);
134 int parse_options(char *str,unsigned int *options,
135                   struct parse_options *opts,int noisy);
136 char *unescape_percent_string (const unsigned char *s);
137 int has_invalid_email_chars (const char *s);
138 int is_valid_mailbox (const char *name);
139 const char *get_libexecdir (void);
140 int path_access(const char *file,int mode);
141
142 /* Temporary helpers. */
143 int pubkey_get_npkey( int algo );
144 int pubkey_get_nskey( int algo );
145 int pubkey_get_nsig( int algo );
146 int pubkey_get_nenc( int algo );
147 unsigned int pubkey_nbits( int algo, gcry_mpi_t *pkey );
148 int mpi_print( FILE *fp, gcry_mpi_t a, int mode );
149
150
151 /*-- helptext.c --*/
152 void display_online_help( const char *keyword );
153
154 /*-- encode.c --*/
155 int setup_symkey(STRING2KEY **symkey_s2k,DEK **symkey_dek);
156 int encode_symmetric( const char *filename );
157 int encode_store( const char *filename );
158 int encode_crypt( const char *filename, strlist_t remusr, int use_symkey );
159 void encode_crypt_files(int nfiles, char **files, strlist_t remusr);
160 int encrypt_filter( void *opaque, int control,
161                     iobuf_t a, byte *buf, size_t *ret_len);
162
163
164 /*-- sign.c --*/
165 int complete_sig( PKT_signature *sig, PKT_secret_key *sk, gcry_md_hd_t md );
166 int sign_file( strlist_t filenames, int detached, strlist_t locusr,
167                int do_encrypt, strlist_t remusr, const char *outfile );
168 int clearsign_file( const char *fname, strlist_t locusr, const char *outfile );
169 int sign_symencrypt_file (const char *fname, strlist_t locusr);
170
171 /*-- sig-check.c --*/
172 int check_revocation_keys (PKT_public_key *pk, PKT_signature *sig);
173 int check_backsig(PKT_public_key *main_pk,PKT_public_key *sub_pk,
174                   PKT_signature *backsig);
175 int check_key_signature( KBNODE root, KBNODE node, int *is_selfsig );
176 int check_key_signature2( KBNODE root, KBNODE node, PKT_public_key *check_pk,
177                           PKT_public_key *ret_pk, int *is_selfsig,
178                           u32 *r_expiredate, int *r_expired );
179
180 /*-- delkey.c --*/
181 int delete_keys( strlist_t names, int secret, int allow_both );
182
183 /*-- keyedit.c --*/
184 void keyedit_menu( const char *username, strlist_t locusr,
185                    strlist_t commands, int quiet, int seckey_check );
186 void show_basic_key_info (KBNODE keyblock);
187
188 /*-- keygen.c --*/
189 u32 parse_expire_string(const char *string);
190 u32 ask_expire_interval(int object,const char *def_expire);
191 u32 ask_expiredate(void);
192 void generate_keypair( const char *fname, const char *card_serialno,
193                        const char *backup_encryption_dir );
194 int keygen_set_std_prefs (const char *string,int personal);
195 PKT_user_id *keygen_get_std_prefs (void);
196 int keygen_add_key_expire( PKT_signature *sig, void *opaque );
197 int keygen_add_std_prefs( PKT_signature *sig, void *opaque );
198 int keygen_upd_std_prefs( PKT_signature *sig, void *opaque );
199 int keygen_add_keyserver_url(PKT_signature *sig, void *opaque);
200 int keygen_add_notations(PKT_signature *sig,void *opaque);
201 int keygen_add_revkey(PKT_signature *sig, void *opaque);
202 int make_backsig(PKT_signature *sig,PKT_public_key *pk,
203                  PKT_public_key *sub_pk,PKT_secret_key *sub_sk);
204 int generate_subkeypair( KBNODE pub_keyblock, KBNODE sec_keyblock );
205 #ifdef ENABLE_CARD_SUPPORT
206 int generate_card_subkeypair (KBNODE pub_keyblock, KBNODE sec_keyblock,
207                               int keyno, const char *serialno);
208 int save_unprotected_key_to_card (PKT_secret_key *sk, int keyno);
209 #endif
210
211 /*-- openfile.c --*/
212 int overwrite_filep( const char *fname );
213 char *make_outfile_name( const char *iname );
214 char *ask_outfile_name( const char *name, size_t namelen );
215 int   open_outfile( const char *iname, int mode, iobuf_t *a );
216 iobuf_t open_sigfile( const char *iname, progress_filter_context_t *pfx );
217 void try_make_homedir( const char *fname );
218
219 /*-- seskey.c --*/
220 void make_session_key( DEK *dek );
221 gcry_mpi_t encode_session_key( DEK *dek, unsigned nbits );
222 gcry_mpi_t encode_md_value( PKT_public_key *pk, PKT_secret_key *sk,
223                             gcry_md_hd_t md, int hash_algo );
224
225 /*-- import.c --*/
226 int parse_import_options(char *str,unsigned int *options,int noisy);
227 void import_keys( char **fnames, int nnames,
228                   void *stats_hd, unsigned int options );
229 int import_keys_stream( iobuf_t inp,void *stats_hd,unsigned char **fpr,
230                         size_t *fpr_len,unsigned int options );
231 void *import_new_stats_handle (void);
232 void import_release_stats_handle (void *p);
233 void import_print_stats (void *hd);
234
235 int collapse_uids( KBNODE *keyblock );
236
237 int auto_create_card_key_stub ( const char *serialnostr, 
238                                 const unsigned char *fpr1,
239                                 const unsigned char *fpr2,
240                                 const unsigned char *fpr3);
241
242 /*-- export.c --*/
243 int parse_export_options(char *str,unsigned int *options,int noisy);
244 int export_pubkeys( strlist_t users, unsigned int options );
245 int export_pubkeys_stream( iobuf_t out, strlist_t users,
246                            KBNODE *keyblock_out, unsigned int options );
247 int export_seckeys( strlist_t users );
248 int export_secsubkeys( strlist_t users );
249
250 /* dearmor.c --*/
251 int dearmor_file( const char *fname );
252 int enarmor_file( const char *fname );
253
254 /*-- revoke.c --*/
255 struct revocation_reason_info;
256 int gen_revoke( const char *uname );
257 int gen_desig_revoke( const char *uname, strlist_t locusr);
258 int revocation_reason_build_cb( PKT_signature *sig, void *opaque );
259 struct revocation_reason_info *
260                 ask_revocation_reason( int key_rev, int cert_rev, int hint );
261 void release_revocation_reason_info( struct revocation_reason_info *reason );
262
263 /*-- keylist.c --*/
264 void public_key_list( strlist_t list );
265 void secret_key_list( strlist_t list );
266 void print_subpackets_colon(PKT_signature *sig);
267 void reorder_keyblock (KBNODE keyblock);
268 void list_keyblock( KBNODE keyblock, int secret, int fpr, void *opaque );
269 void print_fingerprint (PKT_public_key *pk, PKT_secret_key *sk, int mode);
270 void print_revokers(PKT_public_key *pk);
271 void show_policy_url(PKT_signature *sig,int indent,int mode);
272 void show_keyserver_url(PKT_signature *sig,int indent,int mode);
273 void show_notation(PKT_signature *sig,int indent,int mode,int which);
274 void dump_attribs(const PKT_user_id *uid,
275                   PKT_public_key *pk,PKT_secret_key *sk);
276 void set_attrib_fd(int fd);
277 void print_seckey_info (PKT_secret_key *sk);
278 void print_pubkey_info (FILE *fp, PKT_public_key *pk);
279 void print_card_key_info (FILE *fp, KBNODE keyblock);
280
281 /*-- verify.c --*/
282 void print_file_status( int status, const char *name, int what );
283 int verify_signatures( int nfiles, char **files );
284 int verify_files( int nfiles, char **files );
285 int gpg_verify (ctrl_t ctrl, int sig_fd, int data_fd, FILE *out_fp);
286
287 /*-- decrypt.c --*/
288 int decrypt_message( const char *filename );
289 void decrypt_messages(int nfiles, char *files[]);
290
291 /*-- plaintext.c --*/
292 int hash_datafiles( gcry_md_hd_t md, gcry_md_hd_t md2,
293                     strlist_t files, const char *sigfilename, int textmode );
294 int hash_datafile_by_fd ( gcry_md_hd_t md, gcry_md_hd_t md2, int data_fd,
295                           int textmode );
296 PKT_plaintext *setup_plaintext_name(const char *filename,IOBUF iobuf);
297
298 /*-- signal.c --*/
299 void init_signals(void);
300 void pause_on_sigusr( int which );
301 void block_all_signals(void);
302 void unblock_all_signals(void);
303
304
305 /*-- server.c --*/
306 int gpg_server (ctrl_t);
307
308 #ifdef ENABLE_CARD_SUPPORT
309 /*-- card-util.c --*/
310 void change_pin (int no, int allow_admin);
311 void card_status (FILE *fp, char *serialno, size_t serialnobuflen);
312 void card_edit (strlist_t commands);
313 int  card_generate_subkey (KBNODE pub_keyblock, KBNODE sec_keyblock);
314 int  card_store_subkey (KBNODE node, int use);
315 #endif
316
317 #define S2K_DECODE_COUNT(_val) ((16ul + ((_val) & 15)) << (((_val) >> 4) + 6))
318
319 #endif /*G10_MAIN_H*/