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