a67c2ff3f47f119625861ee6f5aa0c1a243064ed
[gnupg.git] / g10 / main.h
1 /* main.h
2  * Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004,
3  *               2005 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 #include "types.h"
25 #include "iobuf.h"
26 #include "mpi.h"
27 #include "cipher.h"
28 #include "keydb.h"
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 values;
55   struct groupitem *next;
56 };
57
58 /*-- g10.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( MPI a );
83 u32 buffer_to_u32( const byte *buffer );
84 const byte *get_session_marker( size_t *rlen );
85 int openpgp_cipher_test_algo( int algo );
86 int openpgp_pk_test_algo( int algo, unsigned int usage_flags );
87 int openpgp_pk_algo_usage ( int algo );
88 int openpgp_md_test_algo( int algo );
89
90 #ifdef USE_IDEA
91 void idea_cipher_warn( int show );
92 #else
93 #define idea_cipher_warn(a)
94 #endif
95
96 struct expando_args
97 {
98   PKT_public_key *pk;
99   PKT_secret_key *sk;
100   byte imagetype;
101 };
102
103 char *pct_expando(const char *string,struct expando_args *args);
104 void deprecated_warning(const char *configname,unsigned int configlineno,
105                         const char *option,const char *repl1,const char *repl2);
106 void deprecated_command (const char *name);
107
108 const char *compress_algo_to_string(int algo);
109 int string_to_compress_algo(const char *string);
110 int check_compress_algo(int algo);
111 int default_cipher_algo(void);
112 int default_compress_algo(void);
113 const char *compliance_option_string(void);
114 void compliance_failure(void);
115
116 struct parse_options
117 {
118   char *name;
119   unsigned int bit;
120   char **value;
121   char *help;
122 };
123
124 char *optsep(char **stringp);
125 char *argsplit(char *string);
126 int parse_options(char *str,unsigned int *options,
127                   struct parse_options *opts,int noisy);
128 char *unescape_percent_string (const unsigned char *s);
129 int has_invalid_email_chars (const char *s);
130 int is_valid_mailbox (const char *name);
131 char *default_homedir (void);
132 const char *get_libexecdir (void);
133 int path_access(const char *file,int mode);
134
135 /*-- helptext.c --*/
136 void display_online_help( const char *keyword );
137
138 /*-- encode.c --*/
139 int setup_symkey(STRING2KEY **symkey_s2k,DEK **symkey_dek);
140 int encode_symmetric( const char *filename );
141 int encode_store( const char *filename );
142 int encode_crypt( const char *filename, STRLIST remusr, int use_symkey );
143 void encode_crypt_files(int nfiles, char **files, STRLIST remusr);
144 int encrypt_filter( void *opaque, int control,
145                     IOBUF a, byte *buf, size_t *ret_len);
146
147
148 /*-- sign.c --*/
149 int complete_sig( PKT_signature *sig, PKT_secret_key *sk, MD_HANDLE md );
150 int sign_file( STRLIST filenames, int detached, STRLIST locusr,
151                int do_encrypt, STRLIST remusr, const char *outfile );
152 int clearsign_file( const char *fname, STRLIST locusr, const char *outfile );
153 int sign_symencrypt_file (const char *fname, STRLIST locusr);
154
155 /*-- sig-check.c --*/
156 int check_revocation_keys (PKT_public_key *pk, PKT_signature *sig);
157 int check_backsig(PKT_public_key *main_pk,PKT_public_key *sub_pk,
158                   PKT_signature *backsig);
159 int check_key_signature( KBNODE root, KBNODE node, int *is_selfsig );
160 int check_key_signature2( KBNODE root, KBNODE node, PKT_public_key *check_pk,
161                           PKT_public_key *ret_pk, int *is_selfsig,
162                           u32 *r_expiredate, int *r_expired );
163
164 /*-- delkey.c --*/
165 int delete_keys( STRLIST names, int secret, int allow_both );
166
167 /*-- keyedit.c --*/
168 void keyedit_menu( const char *username, STRLIST locusr,
169                    STRLIST commands, int quiet, int seckey_check );
170 void show_basic_key_info (KBNODE keyblock);
171
172 /*-- keygen.c --*/
173 u32 parse_expire_string(const char *string);
174 u32 ask_expire_interval(int object,const char *def_expire);
175 u32 ask_expiredate(void);
176 void generate_keypair( const char *fname, const char *card_serialno,
177                        const char *backup_encryption_dir );
178 int keygen_set_std_prefs (const char *string,int personal);
179 PKT_user_id *keygen_get_std_prefs (void);
180 int keygen_add_key_expire( PKT_signature *sig, void *opaque );
181 int keygen_add_std_prefs( PKT_signature *sig, void *opaque );
182 int keygen_upd_std_prefs( PKT_signature *sig, void *opaque );
183 int keygen_add_keyserver_url(PKT_signature *sig, void *opaque);
184 int keygen_add_revkey(PKT_signature *sig, void *opaque);
185 int make_backsig(PKT_signature *sig,PKT_public_key *pk,
186                  PKT_public_key *sub_pk,PKT_secret_key *sub_sk);
187 int generate_subkeypair( KBNODE pub_keyblock, KBNODE sec_keyblock );
188 #ifdef ENABLE_CARD_SUPPORT
189 int generate_card_subkeypair (KBNODE pub_keyblock, KBNODE sec_keyblock,
190                               int keyno, const char *serialno);
191 int save_unprotected_key_to_card (PKT_secret_key *sk, int keyno);
192 #endif
193
194 /*-- openfile.c --*/
195 int overwrite_filep( const char *fname );
196 char *make_outfile_name( const char *iname );
197 char *ask_outfile_name( const char *name, size_t namelen );
198 int   open_outfile( const char *iname, int mode, IOBUF *a );
199 IOBUF open_sigfile( const char *iname, progress_filter_context_t *pfx );
200 void try_make_homedir( const char *fname );
201
202 /*-- seskey.c --*/
203 void make_session_key( DEK *dek );
204 MPI encode_session_key( DEK *dek, unsigned nbits );
205 MPI encode_md_value( int pubkey_algo, MD_HANDLE md,
206                      int hash_algo, unsigned nbits );
207
208 /*-- import.c --*/
209 int parse_import_options(char *str,unsigned int *options,int noisy);
210 void import_keys( char **fnames, int nnames,
211                   void *stats_hd, unsigned int options );
212 int import_keys_stream( IOBUF inp,
213                         void *stats_hd, unsigned int options );
214 void *import_new_stats_handle (void);
215 void import_release_stats_handle (void *p);
216 void import_print_stats (void *hd);
217
218 int collapse_uids( KBNODE *keyblock );
219
220 int auto_create_card_key_stub ( const char *serialnostr, 
221                                 const unsigned char *fpr1,
222                                 const unsigned char *fpr2,
223                                 const unsigned char *fpr3);
224
225 /*-- export.c --*/
226 int parse_export_options(char *str,unsigned int *options,int noisy);
227 int export_pubkeys( STRLIST users, unsigned int options );
228 int export_pubkeys_stream( IOBUF out, STRLIST users,
229                            KBNODE *keyblock_out, unsigned int options );
230 int export_seckeys( STRLIST users );
231 int export_secsubkeys( STRLIST users );
232
233 /* dearmor.c --*/
234 int dearmor_file( const char *fname );
235 int enarmor_file( const char *fname );
236
237 /*-- revoke.c --*/
238 struct revocation_reason_info;
239 int gen_revoke( const char *uname );
240 int gen_desig_revoke( const char *uname, STRLIST locusr);
241 int revocation_reason_build_cb( PKT_signature *sig, void *opaque );
242 struct revocation_reason_info *
243                 ask_revocation_reason( int key_rev, int cert_rev, int hint );
244 void release_revocation_reason_info( struct revocation_reason_info *reason );
245
246 /*-- keylist.c --*/
247 void public_key_list( STRLIST list );
248 void secret_key_list( STRLIST list );
249 void print_subpackets_colon(PKT_signature *sig);
250 void reorder_keyblock (KBNODE keyblock);
251 void list_keyblock( KBNODE keyblock, int secret, int fpr, void *opaque );
252 void print_fingerprint (PKT_public_key *pk, PKT_secret_key *sk, int mode);
253 void print_revokers(PKT_public_key *pk);
254 void show_policy_url(PKT_signature *sig,int indent,int mode);
255 void show_keyserver_url(PKT_signature *sig,int indent,int mode);
256 void show_notation(PKT_signature *sig,int indent,int mode,int which);
257 void dump_attribs(const PKT_user_id *uid,
258                   PKT_public_key *pk,PKT_secret_key *sk);
259 void set_attrib_fd(int fd);
260 void print_seckey_info (PKT_secret_key *sk);
261 void print_pubkey_info (FILE *fp, PKT_public_key *pk);
262 void print_card_key_info (FILE *fp, KBNODE keyblock);
263
264 /*-- verify.c --*/
265 void print_file_status( int status, const char *name, int what );
266 int verify_signatures( int nfiles, char **files );
267 int verify_files( int nfiles, char **files );
268
269 /*-- decrypt.c --*/
270 int decrypt_message( const char *filename );
271 void decrypt_messages(int nfiles, char *files[]);
272
273 /*-- plaintext.c --*/
274 int hash_datafiles( MD_HANDLE md, MD_HANDLE md2,
275                     STRLIST files, const char *sigfilename, int textmode );
276
277 /*-- pipemode.c --*/
278 void run_in_pipemode (void);
279
280 /*-- signal.c --*/
281 void init_signals(void);
282 void pause_on_sigusr( int which );
283 void block_all_signals(void);
284 void unblock_all_signals(void);
285
286
287 #ifdef ENABLE_CARD_SUPPORT
288 /*-- card-util.c --*/
289 void change_pin (int no, int allow_admin);
290 void card_status (FILE *fp, char *serialno, size_t serialnobuflen);
291 void card_edit (STRLIST commands);
292 int  card_generate_subkey (KBNODE pub_keyblock, KBNODE sec_keyblock);
293 int  card_store_subkey (KBNODE node, int use);
294 #endif
295
296 #endif /*G10_MAIN_H*/