* Makefile.am, packet.h, main.h, comment.c: Remove comment.c. We don't
[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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
20  */
21 #ifndef G10_MAIN_H
22 #define G10_MAIN_H
23 #include "types.h"
24 #include "iobuf.h"
25 #include "mpi.h"
26 #include "cipher.h"
27 #include "keydb.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_COMPRESS_ALGO   COMPRESS_ALGO_ZIP
37 #define DEFAULT_S2K_DIGEST_ALGO DIGEST_ALGO_SHA1
38
39 #define S2K_DIGEST_ALGO (opt.s2k_digest_algo?opt.s2k_digest_algo:DEFAULT_S2K_DIGEST_ALGO)
40
41 typedef struct
42 {
43   int header_okay;
44   PK_LIST pk_list;
45   DEK *symkey_dek;
46   STRING2KEY *symkey_s2k;
47   cipher_filter_context_t cfx;
48 } encrypt_filter_context_t;
49
50 struct groupitem
51 {
52   char *name;
53   STRLIST values;
54   struct groupitem *next;
55 };
56
57 /*-- g10.c --*/
58 extern int g10_errors_seen;
59
60 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 5 )
61   void g10_exit(int rc) __attribute__ ((noreturn));
62 #else
63   void g10_exit(int rc);
64 #endif
65 void print_pubkey_algo_note( int algo );
66 void print_cipher_algo_note( int algo );
67 void print_digest_algo_note( int algo );
68
69 /*-- armor.c --*/
70 char *make_radix64_string( const byte *data, size_t len );
71
72 /*-- misc.c --*/
73 void trap_unaligned(void);
74 int disable_core_dumps(void);
75 void register_secured_file (const char *fname);
76 void unregister_secured_file (const char *fname);
77 int  is_secured_file (int fd);
78 int  is_secured_filename (const char *fname);
79 u16 checksum_u16( unsigned n );
80 u16 checksum( byte *p, unsigned n );
81 u16 checksum_mpi( MPI a );
82 u32 buffer_to_u32( const byte *buffer );
83 const byte *get_session_marker( size_t *rlen );
84 int openpgp_cipher_test_algo( int algo );
85 int openpgp_pk_test_algo( int algo, unsigned int usage_flags );
86 int openpgp_pk_algo_usage ( int algo );
87 int openpgp_md_test_algo( int algo );
88
89 #ifdef USE_IDEA
90 void idea_cipher_warn( int show );
91 #else
92 #define idea_cipher_warn(a)
93 #endif
94
95 struct expando_args
96 {
97   PKT_public_key *pk;
98   PKT_secret_key *sk;
99   byte imagetype;
100 };
101
102 char *pct_expando(const char *string,struct expando_args *args);
103 void deprecated_warning(const char *configname,unsigned int configlineno,
104                         const char *option,const char *repl1,const char *repl2);
105 void deprecated_command (const char *name);
106
107 const char *compress_algo_to_string(int algo);
108 int string_to_compress_algo(const char *string);
109 int check_compress_algo(int algo);
110 int default_cipher_algo(void);
111 int default_compress_algo(void);
112 const char *compliance_option_string(void);
113 void compliance_failure(void);
114
115 struct parse_options
116 {
117   char *name;
118   unsigned int bit;
119   char **value;
120 };
121
122 char *optsep(char **stringp);
123 char *argsplit(char *string);
124 int parse_options(char *str,unsigned int *options,
125                   struct parse_options *opts,int noisy);
126
127 char *default_homedir (void);
128
129
130 /*-- helptext.c --*/
131 void display_online_help( const char *keyword );
132
133 /*-- encode.c --*/
134 int setup_symkey(STRING2KEY **symkey_s2k,DEK **symkey_dek);
135 int encode_symmetric( const char *filename );
136 int encode_store( const char *filename );
137 int encode_crypt( const char *filename, STRLIST remusr, int use_symkey );
138 void encode_crypt_files(int nfiles, char **files, STRLIST remusr);
139 int encrypt_filter( void *opaque, int control,
140                     IOBUF a, byte *buf, size_t *ret_len);
141
142
143 /*-- sign.c --*/
144 int complete_sig( PKT_signature *sig, PKT_secret_key *sk, MD_HANDLE md );
145 int sign_file( STRLIST filenames, int detached, STRLIST locusr,
146                int do_encrypt, STRLIST remusr, const char *outfile );
147 int clearsign_file( const char *fname, STRLIST locusr, const char *outfile );
148 int sign_symencrypt_file (const char *fname, STRLIST locusr);
149
150 /*-- sig-check.c --*/
151 int check_revocation_keys (PKT_public_key *pk, PKT_signature *sig);
152 int check_backsig(PKT_public_key *main_pk,PKT_public_key *sub_pk,
153                   PKT_signature *backsig);
154 int check_key_signature( KBNODE root, KBNODE node, int *is_selfsig );
155 int check_key_signature2( KBNODE root, KBNODE node, PKT_public_key *check_pk,
156                           PKT_public_key *ret_pk, int *is_selfsig,
157                           u32 *r_expiredate, int *r_expired );
158
159 /*-- delkey.c --*/
160 int delete_keys( STRLIST names, int secret, int allow_both );
161
162 /*-- keyedit.c --*/
163 void keyedit_menu( const char *username, STRLIST locusr,
164                    STRLIST commands, int quiet, int seckey_check );
165 void show_basic_key_info (KBNODE keyblock);
166
167 /*-- keygen.c --*/
168 int parse_expire_string(const char *string);
169 u32 ask_expire_interval(int object,const char *def_expire);
170 u32 ask_expiredate(void);
171 void generate_keypair( const char *fname, const char *card_serialno,
172                        const char *backup_encryption_dir );
173 int keygen_set_std_prefs (const char *string,int personal);
174 PKT_user_id *keygen_get_std_prefs (void);
175 int keygen_add_key_expire( PKT_signature *sig, void *opaque );
176 int keygen_add_std_prefs( PKT_signature *sig, void *opaque );
177 int keygen_upd_std_prefs( PKT_signature *sig, void *opaque );
178 int keygen_add_keyserver_url(PKT_signature *sig, void *opaque);
179 int keygen_add_revkey(PKT_signature *sig, void *opaque);
180 int generate_subkeypair( KBNODE pub_keyblock, KBNODE sec_keyblock );
181 #ifdef ENABLE_CARD_SUPPORT
182 int generate_card_subkeypair (KBNODE pub_keyblock, KBNODE sec_keyblock,
183                               int keyno, const char *serialno);
184 int save_unprotected_key_to_card (PKT_secret_key *sk, int keyno);
185 #endif
186
187 /*-- openfile.c --*/
188 int overwrite_filep( const char *fname );
189 char *make_outfile_name( const char *iname );
190 char *ask_outfile_name( const char *name, size_t namelen );
191 int   open_outfile( const char *iname, int mode, IOBUF *a );
192 IOBUF open_sigfile( const char *iname, progress_filter_context_t *pfx );
193 void try_make_homedir( const char *fname );
194
195 /*-- seskey.c --*/
196 void make_session_key( DEK *dek );
197 MPI encode_session_key( DEK *dek, unsigned nbits );
198 MPI encode_md_value( int pubkey_algo, MD_HANDLE md,
199                      int hash_algo, unsigned nbits );
200
201 /*-- import.c --*/
202 int parse_import_options(char *str,unsigned int *options,int noisy);
203 void import_keys( char **fnames, int nnames,
204                   void *stats_hd, unsigned int options );
205 int import_keys_stream( IOBUF inp,
206                         void *stats_hd, unsigned int options );
207 void *import_new_stats_handle (void);
208 void import_release_stats_handle (void *p);
209 void import_print_stats (void *hd);
210
211 int collapse_uids( KBNODE *keyblock );
212
213 int auto_create_card_key_stub ( const char *serialnostr, 
214                                 const unsigned char *fpr1,
215                                 const unsigned char *fpr2,
216                                 const unsigned char *fpr3);
217
218 /*-- export.c --*/
219 int parse_export_options(char *str,unsigned int *options,int noisy);
220 int export_pubkeys( STRLIST users, unsigned int options );
221 int export_pubkeys_stream( IOBUF out, STRLIST users,
222                            KBNODE *keyblock_out, unsigned int options );
223 int export_seckeys( STRLIST users );
224 int export_secsubkeys( STRLIST users );
225
226 /* dearmor.c --*/
227 int dearmor_file( const char *fname );
228 int enarmor_file( const char *fname );
229
230 /*-- revoke.c --*/
231 struct revocation_reason_info;
232 int gen_revoke( const char *uname );
233 int gen_desig_revoke( const char *uname );
234 int revocation_reason_build_cb( PKT_signature *sig, void *opaque );
235 struct revocation_reason_info *
236                 ask_revocation_reason( int key_rev, int cert_rev, int hint );
237 void release_revocation_reason_info( struct revocation_reason_info *reason );
238
239 /*-- keylist.c --*/
240 void public_key_list( STRLIST list );
241 void secret_key_list( STRLIST list );
242 void print_subpackets_colon(PKT_signature *sig);
243 void reorder_keyblock (KBNODE keyblock);
244 void list_keyblock( KBNODE keyblock, int secret, int fpr, void *opaque );
245 void print_fingerprint (PKT_public_key *pk, PKT_secret_key *sk, int mode);
246 void show_policy_url(PKT_signature *sig,int indent,int mode);
247 void show_keyserver_url(PKT_signature *sig,int indent,int mode);
248 void show_notation(PKT_signature *sig,int indent,int mode,int which);
249 void dump_attribs(const PKT_user_id *uid,
250                   PKT_public_key *pk,PKT_secret_key *sk);
251 void set_attrib_fd(int fd);
252 void print_seckey_info (PKT_secret_key *sk);
253 void print_pubkey_info (FILE *fp, PKT_public_key *pk);
254 void print_card_key_info (FILE *fp, KBNODE keyblock);
255
256 /*-- verify.c --*/
257 void print_file_status( int status, const char *name, int what );
258 int verify_signatures( int nfiles, char **files );
259 int verify_files( int nfiles, char **files );
260
261 /*-- decrypt.c --*/
262 int decrypt_message( const char *filename );
263 void decrypt_messages(int nfiles, char *files[]);
264
265 /*-- plaintext.c --*/
266 int hash_datafiles( MD_HANDLE md, MD_HANDLE md2,
267                     STRLIST files, const char *sigfilename, int textmode );
268
269 /*-- pipemode.c --*/
270 void run_in_pipemode (void);
271
272 /*-- signal.c --*/
273 void init_signals(void);
274 void pause_on_sigusr( int which );
275 void block_all_signals(void);
276 void unblock_all_signals(void);
277
278 #ifdef ENABLE_CARD_SUPPORT
279 /*-- card-util.c --*/
280 void change_pin (int no, int allow_admin);
281 void card_status (FILE *fp, char *serialno, size_t serialnobuflen);
282 void card_edit (STRLIST commands);
283 int  card_generate_subkey (KBNODE pub_keyblock, KBNODE sec_keyblock);
284 int  card_store_subkey (KBNODE node, int use);
285 #endif
286
287 #endif /*G10_MAIN_H*/