Update head to match stable 1.0
[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 #define DEFAULT_CIPHER_ALGO   CIPHER_ALGO_CAST5
29 #define DEFAULT_PUBKEY_ALGO   PUBKEY_ALGO_ELGAMAL
30 #define DEFAULT_DIGEST_ALGO   DIGEST_ALGO_SHA1
31 #define DEFAULT_COMPRESS_ALGO 1
32
33 typedef struct {
34     int header_okay;
35     PK_LIST pk_list;
36     cipher_filter_context_t cfx;
37 } encrypt_filter_context_t;
38
39 struct groupitem
40 {
41   char *name;
42   STRLIST values;
43   struct groupitem *next;
44 };
45
46 /*-- g10.c --*/
47 extern int g10_errors_seen;
48
49 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 5 )
50   void g10_exit(int rc) __attribute__ ((noreturn));
51 #else
52   void g10_exit(int rc);
53 #endif
54 void print_pubkey_algo_note( int algo );
55 void print_cipher_algo_note( int algo );
56 void print_digest_algo_note( int algo );
57
58 /*-- armor.c --*/
59 char *make_radix64_string( const byte *data, size_t len );
60
61 /*-- misc.c --*/
62 void trap_unaligned(void);
63 int disable_core_dumps(void);
64 u16 checksum_u16( unsigned n );
65 u16 checksum( byte *p, unsigned n );
66 u16 checksum_mpi( MPI a );
67 u16 checksum_mpi_counted_nbits( MPI a );
68 u32 buffer_to_u32( const byte *buffer );
69 const byte *get_session_marker( size_t *rlen );
70 int openpgp_cipher_test_algo( int algo );
71 int openpgp_pk_test_algo( int algo, unsigned int usage_flags );
72 int openpgp_pk_algo_usage ( int algo );
73 int openpgp_md_test_algo( int algo );
74 int check_permissions(const char *path,int extension,int checkonly);
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 check_compress_algo(int algo);
90
91 /*-- helptext.c --*/
92 void display_online_help( const char *keyword );
93
94 /*-- encode.c --*/
95 int encode_symmetric( const char *filename );
96 int encode_store( const char *filename );
97 int encode_crypt( const char *filename, STRLIST remusr );
98 void encode_crypt_files(int nfiles, char **files, STRLIST remusr);
99 int encrypt_filter( void *opaque, int control,
100                     IOBUF a, byte *buf, size_t *ret_len);
101
102
103 /*-- sign.c --*/
104 int complete_sig( PKT_signature *sig, PKT_secret_key *sk, MD_HANDLE md );
105 int sign_file( STRLIST filenames, int detached, STRLIST locusr,
106                int do_encrypt, STRLIST remusr, const char *outfile );
107 int clearsign_file( const char *fname, STRLIST locusr, const char *outfile );
108 int sign_symencrypt_file (const char *fname, STRLIST locusr);
109
110 /*-- sig-check.c --*/
111 int check_key_signature( KBNODE root, KBNODE node, int *is_selfsig );
112 int check_key_signature2( KBNODE root, KBNODE node,
113                           int *is_selfsig, u32 *r_expiredate, int *r_expired );
114
115 /*-- delkey.c --*/
116 int delete_keys( STRLIST names, int secret, int allow_both );
117
118 /*-- keyedit.c --*/
119 void keyedit_menu( const char *username, STRLIST locusr, STRLIST cmds,
120                                                             int sign_mode );
121
122 /*-- keygen.c --*/
123 u32 ask_expire_interval(int object);
124 u32 ask_expiredate(void);
125 void generate_keypair( const char *fname );
126 int keygen_set_std_prefs (const char *string,int personal);
127 char *keygen_get_std_prefs (void);
128 int keygen_add_key_expire( PKT_signature *sig, void *opaque );
129 int keygen_add_std_prefs( PKT_signature *sig, void *opaque );
130 int keygen_upd_std_prefs( PKT_signature *sig, void *opaque );
131 int keygen_add_revkey(PKT_signature *sig, void *opaque);
132 int generate_subkeypair( KBNODE pub_keyblock, KBNODE sec_keyblock );
133
134 /*-- openfile.c --*/
135 int overwrite_filep( const char *fname );
136 char *make_outfile_name( const char *iname );
137 char *ask_outfile_name( const char *name, size_t namelen );
138 int   open_outfile( const char *iname, int mode, IOBUF *a );
139 IOBUF open_sigfile( const char *iname );
140 void try_make_homedir( const char *fname );
141
142 /*-- seskey.c --*/
143 void make_session_key( DEK *dek );
144 MPI encode_session_key( DEK *dek, unsigned nbits );
145 MPI encode_md_value( int pubkey_algo,  MD_HANDLE md,
146                      int hash_algo, unsigned nbits, int v3compathack );
147
148 /*-- comment.c --*/
149 KBNODE make_comment_node( const char *s );
150 KBNODE make_mpi_comment_node( const char *s, MPI a );
151
152 /*-- import.c --*/
153 void import_keys( char **fnames, int nnames, int fast, void *stats_hd );
154 int import_keys_stream( IOBUF inp, int fast, void *stats_hd );
155 void *import_new_stats_handle (void);
156 void import_release_stats_handle (void *p);
157 void import_print_stats (void *hd);
158
159 int collapse_uids( KBNODE *keyblock );
160
161 /*-- export.c --*/
162 int export_pubkeys( STRLIST users, int onlyrfc );
163 int export_pubkeys_stream( IOBUF out, STRLIST users, int onlyrfc );
164 int export_seckeys( STRLIST users );
165 int export_secsubkeys( STRLIST users );
166
167 /* dearmor.c --*/
168 int dearmor_file( const char *fname );
169 int enarmor_file( const char *fname );
170
171 /*-- revoke.c --*/
172 struct revocation_reason_info;
173 int gen_revoke( const char *uname );
174 int gen_desig_revoke( const char *uname );
175 int revocation_reason_build_cb( PKT_signature *sig, void *opaque );
176 struct revocation_reason_info *
177                 ask_revocation_reason( int key_rev, int cert_rev, int hint );
178 void release_revocation_reason_info( struct revocation_reason_info *reason );
179
180 /*-- keylist.c --*/
181 void public_key_list( STRLIST list );
182 void secret_key_list( STRLIST list );
183 void list_keyblock( KBNODE keyblock, int secret, int fpr, void *opaque );
184 void print_fingerprint (PKT_public_key *pk, PKT_secret_key *sk, int mode);
185 void show_policy_url(PKT_signature *sig,int indent);
186 void show_notation(PKT_signature *sig,int indent);
187 void set_attrib_fd(int fd);
188
189 /*-- verify.c --*/
190 void print_file_status( int status, const char *name, int what );
191 int verify_signatures( int nfiles, char **files );
192 int verify_files( int nfiles, char **files );
193
194 /*-- decrypt.c --*/
195 int decrypt_message( const char *filename );
196 void decrypt_messages(int nfiles, char **files);
197
198 /*-- plaintext.c --*/
199 int hash_datafiles( MD_HANDLE md, MD_HANDLE md2,
200                     STRLIST files, const char *sigfilename, int textmode );
201
202 /*-- pipemode.c --*/
203 void run_in_pipemode (void);
204
205 /*-- signal.c --*/
206 void init_signals(void);
207 void pause_on_sigusr( int which );
208 void block_all_signals(void);
209 void unblock_all_signals(void);
210
211 #endif /*G10_MAIN_H*/