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