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