a1aff3afb5a78615629851b804db1f0c8a3e3dd4
[gnupg.git] / g10 / main.h
1 /* main.h
2  * Copyright (C) 1998, 1999, 2000, 2001, 2002 Free Software Foundation, Inc.
3  *
4  * This file is part of GnuPG.
5  *
6  * GnuPG is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * GnuPG is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
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). */
31 #define DEFAULT_CIPHER_ALGO   CIPHER_ALGO_CAST5
32 #define DEFAULT_DIGEST_ALGO   DIGEST_ALGO_SHA1
33 #define DEFAULT_COMPRESS_ALGO 1
34
35 typedef struct {
36     int header_okay;
37     PK_LIST pk_list;
38     cipher_filter_context_t cfx;
39 } encrypt_filter_context_t;
40
41 struct groupitem
42 {
43   char *name;
44   STRLIST values;
45   struct groupitem *next;
46 };
47
48 /*-- g10.c --*/
49 extern int g10_errors_seen;
50
51 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 5 )
52   void g10_exit(int rc) __attribute__ ((noreturn));
53 #else
54   void g10_exit(int rc);
55 #endif
56 void print_pubkey_algo_note( int algo );
57 void print_cipher_algo_note( int algo );
58 void print_digest_algo_note( int algo );
59
60 /*-- armor.c --*/
61 char *make_radix64_string( const byte *data, size_t len );
62
63 /*-- misc.c --*/
64 void trap_unaligned(void);
65 int disable_core_dumps(void);
66 u16 checksum_u16( unsigned n );
67 u16 checksum( byte *p, unsigned n );
68 u16 checksum_mpi( MPI a );
69 u32 buffer_to_u32( const byte *buffer );
70 const byte *get_session_marker( size_t *rlen );
71 int openpgp_cipher_test_algo( int algo );
72 int openpgp_pk_test_algo( int algo, unsigned int usage_flags );
73 int openpgp_pk_algo_usage ( int algo );
74 int openpgp_md_test_algo( int algo );
75 void idea_cipher_warn( int show );
76
77 struct expando_args
78 {
79   PKT_public_key *pk;
80   PKT_secret_key *sk;
81   byte imagetype;
82 };
83
84 char *pct_expando(const char *string,struct expando_args *args);
85 int hextobyte( const char *s );
86 void deprecated_warning(const char *configname,unsigned int configlineno,
87                         const char *option,const char *repl1,const char *repl2);
88 const char *compress_algo_to_string(int algo);
89 int string_to_compress_algo(const char *string);
90 int check_compress_algo(int algo);
91
92 /*-- helptext.c --*/
93 void display_online_help( const char *keyword );
94
95 /*-- encode.c --*/
96 int encode_symmetric( const char *filename );
97 int encode_store( const char *filename );
98 int encode_crypt( const char *filename, STRLIST remusr );
99 void encode_crypt_files(int nfiles, char **files, STRLIST remusr);
100 int encrypt_filter( void *opaque, int control,
101                     IOBUF a, byte *buf, size_t *ret_len);
102
103
104 /*-- sign.c --*/
105 int complete_sig( PKT_signature *sig, PKT_secret_key *sk, MD_HANDLE md );
106 int sign_file( STRLIST filenames, int detached, STRLIST locusr,
107                int do_encrypt, STRLIST remusr, const char *outfile );
108 int clearsign_file( const char *fname, STRLIST locusr, const char *outfile );
109 int sign_symencrypt_file (const char *fname, STRLIST locusr);
110
111 /*-- sig-check.c --*/
112 int check_revocation_keys (PKT_public_key *pk, PKT_signature *sig);
113 int check_key_signature( KBNODE root, KBNODE node, int *is_selfsig );
114 int check_key_signature2( KBNODE root, KBNODE node,
115                           int *is_selfsig, u32 *r_expiredate, int *r_expired );
116
117 /*-- delkey.c --*/
118 int delete_keys( STRLIST names, int secret, int allow_both );
119
120 /*-- keyedit.c --*/
121 void keyedit_menu( const char *username, STRLIST locusr, STRLIST cmds,
122                                                             int sign_mode );
123 void show_basic_key_info (KBNODE keyblock);
124
125 /*-- keygen.c --*/
126 u32 ask_expire_interval(int object);
127 u32 ask_expiredate(void);
128 void generate_keypair( const char *fname );
129 int keygen_set_std_prefs (const char *string,int personal);
130 PKT_user_id *keygen_get_std_prefs (void);
131 int keygen_add_key_expire( PKT_signature *sig, void *opaque );
132 int keygen_add_std_prefs( PKT_signature *sig, void *opaque );
133 int keygen_upd_std_prefs( PKT_signature *sig, void *opaque );
134 int keygen_add_revkey(PKT_signature *sig, void *opaque);
135 int generate_subkeypair( KBNODE pub_keyblock, KBNODE sec_keyblock );
136
137 /*-- openfile.c --*/
138 int overwrite_filep( const char *fname );
139 char *make_outfile_name( const char *iname );
140 char *ask_outfile_name( const char *name, size_t namelen );
141 int   open_outfile( const char *iname, int mode, IOBUF *a );
142 IOBUF open_sigfile( const char *iname );
143 void try_make_homedir( const char *fname );
144
145 /*-- seskey.c --*/
146 void make_session_key( DEK *dek );
147 MPI encode_session_key( DEK *dek, unsigned nbits );
148 MPI encode_md_value( int pubkey_algo,  MD_HANDLE md,
149                      int hash_algo, unsigned nbits, int v3compathack );
150
151 /*-- comment.c --*/
152 KBNODE make_comment_node( const char *s );
153 KBNODE make_mpi_comment_node( const char *s, MPI a );
154
155 /*-- import.c --*/
156 #define IMPORT_ALLOW_LOCAL_SIGS      1
157 #define IMPORT_REPAIR_HKP_SUBKEY_BUG 2
158 #define IMPORT_FAST_IMPORT           4
159 #define IMPORT_SK2PK                 8
160
161 int parse_import_options(char *str,unsigned int *options);
162 void import_keys( char **fnames, int nnames,
163                   void *stats_hd, unsigned int options );
164 int import_keys_stream( IOBUF inp,
165                         void *stats_hd, unsigned int options );
166 void *import_new_stats_handle (void);
167 void import_release_stats_handle (void *p);
168 void import_print_stats (void *hd);
169
170 int collapse_uids( KBNODE *keyblock );
171
172 /*-- export.c --*/
173 #define EXPORT_INCLUDE_NON_RFC           1
174 #define EXPORT_INCLUDE_LOCAL_SIGS        2
175 #define EXPORT_INCLUDE_ATTRIBUTES        4
176 #define EXPORT_INCLUDE_SENSITIVE_REVKEYS 8
177
178 int parse_export_options(char *str,unsigned int *options);
179 int export_pubkeys( STRLIST users, unsigned int options );
180 int export_pubkeys_stream( IOBUF out, STRLIST users, unsigned int options );
181 int export_seckeys( STRLIST users );
182 int export_secsubkeys( STRLIST users );
183
184 /* dearmor.c --*/
185 int dearmor_file( const char *fname );
186 int enarmor_file( const char *fname );
187
188 /*-- revoke.c --*/
189 struct revocation_reason_info;
190 int gen_revoke( const char *uname );
191 int gen_desig_revoke( const char *uname );
192 int revocation_reason_build_cb( PKT_signature *sig, void *opaque );
193 struct revocation_reason_info *
194                 ask_revocation_reason( int key_rev, int cert_rev, int hint );
195 void release_revocation_reason_info( struct revocation_reason_info *reason );
196
197 /*-- keylist.c --*/
198 void public_key_list( STRLIST list );
199 void secret_key_list( STRLIST list );
200 void list_keyblock( KBNODE keyblock, int secret, int fpr, void *opaque );
201 void print_fingerprint (PKT_public_key *pk, PKT_secret_key *sk, int mode);
202 void show_policy_url(PKT_signature *sig,int indent);
203 void show_notation(PKT_signature *sig,int indent);
204 void set_attrib_fd(int fd);
205 void print_seckey_info (PKT_secret_key *sk);
206 void print_pubkey_info (PKT_public_key *pk);
207
208 /*-- verify.c --*/
209 void print_file_status( int status, const char *name, int what );
210 int verify_signatures( int nfiles, char **files );
211 int verify_files( int nfiles, char **files );
212
213 /*-- decrypt.c --*/
214 int decrypt_message( const char *filename );
215 void decrypt_messages(int nfiles, char **files);
216
217 /*-- plaintext.c --*/
218 int hash_datafiles( MD_HANDLE md, MD_HANDLE md2,
219                     STRLIST files, const char *sigfilename, int textmode );
220
221 /*-- pipemode.c --*/
222 void run_in_pipemode (void);
223
224 /*-- signal.c --*/
225 void init_signals(void);
226 void pause_on_sigusr( int which );
227 void block_all_signals(void);
228 void unblock_all_signals(void);
229
230 #endif /*G10_MAIN_H*/