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