added RISC OS module loading support
[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 u32 buffer_to_u32( const byte *buffer );
68 const byte *get_session_marker( size_t *rlen );
69 int openpgp_cipher_test_algo( int algo );
70 int openpgp_pk_test_algo( int algo, unsigned int usage_flags );
71 int openpgp_pk_algo_usage ( int algo );
72 int openpgp_md_test_algo( int algo );
73 void idea_cipher_warn( int show );
74
75 struct expando_args
76 {
77   PKT_public_key *pk;
78   PKT_secret_key *sk;
79   byte imagetype;
80 };
81
82 char *pct_expando(const char *string,struct expando_args *args);
83 int hextobyte( const char *s );
84 void deprecated_warning(const char *configname,unsigned int configlineno,
85                         const char *option,const char *repl1,const char *repl2);
86 const char *compress_algo_to_string(int algo);
87 int check_compress_algo(int algo);
88
89 /*-- helptext.c --*/
90 void display_online_help( const char *keyword );
91
92 /*-- encode.c --*/
93 int encode_symmetric( const char *filename );
94 int encode_store( const char *filename );
95 int encode_crypt( const char *filename, STRLIST remusr );
96 void encode_crypt_files(int nfiles, char **files, STRLIST remusr);
97 int encrypt_filter( void *opaque, int control,
98                     IOBUF a, byte *buf, size_t *ret_len);
99
100
101 /*-- sign.c --*/
102 int complete_sig( PKT_signature *sig, PKT_secret_key *sk, MD_HANDLE md );
103 int sign_file( STRLIST filenames, int detached, STRLIST locusr,
104                int do_encrypt, STRLIST remusr, const char *outfile );
105 int clearsign_file( const char *fname, STRLIST locusr, const char *outfile );
106 int sign_symencrypt_file (const char *fname, STRLIST locusr);
107
108 /*-- sig-check.c --*/
109 int check_revocation_keys (PKT_public_key *pk, PKT_signature *sig);
110 int check_key_signature( KBNODE root, KBNODE node, int *is_selfsig );
111 int check_key_signature2( KBNODE root, KBNODE node,
112                           int *is_selfsig, u32 *r_expiredate, int *r_expired );
113
114 /*-- delkey.c --*/
115 int delete_keys( STRLIST names, int secret, int allow_both );
116
117 /*-- keyedit.c --*/
118 void keyedit_menu( const char *username, STRLIST locusr, STRLIST cmds,
119                                                             int sign_mode );
120 void show_basic_key_info (KBNODE keyblock);
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 #define IMPORT_ALLOW_LOCAL_SIGS      1
154 #define IMPORT_REPAIR_HKP_SUBKEY_BUG 2
155 #define IMPORT_FAST_IMPORT           4
156 #define IMPORT_SK2PK                 8
157
158 int parse_import_options(char *str,unsigned int *options);
159 void import_keys( char **fnames, int nnames,
160                   void *stats_hd, unsigned int options );
161 int import_keys_stream( IOBUF inp,
162                         void *stats_hd, unsigned int options );
163 void *import_new_stats_handle (void);
164 void import_release_stats_handle (void *p);
165 void import_print_stats (void *hd);
166
167 int collapse_uids( KBNODE *keyblock );
168
169 /*-- export.c --*/
170 #define EXPORT_INCLUDE_NON_RFC           1
171 #define EXPORT_INCLUDE_LOCAL_SIGS        2
172 #define EXPORT_INCLUDE_ATTRIBUTES        4
173 #define EXPORT_INCLUDE_SENSITIVE_REVKEYS 8
174
175 int parse_export_options(char *str,unsigned int *options);
176 int export_pubkeys( STRLIST users, unsigned int options );
177 int export_pubkeys_stream( IOBUF out, STRLIST users, unsigned int options );
178 int export_seckeys( STRLIST users );
179 int export_secsubkeys( STRLIST users );
180
181 /* dearmor.c --*/
182 int dearmor_file( const char *fname );
183 int enarmor_file( const char *fname );
184
185 /*-- revoke.c --*/
186 struct revocation_reason_info;
187 int gen_revoke( const char *uname );
188 int gen_desig_revoke( const char *uname );
189 int revocation_reason_build_cb( PKT_signature *sig, void *opaque );
190 struct revocation_reason_info *
191                 ask_revocation_reason( int key_rev, int cert_rev, int hint );
192 void release_revocation_reason_info( struct revocation_reason_info *reason );
193
194 /*-- keylist.c --*/
195 void public_key_list( STRLIST list );
196 void secret_key_list( STRLIST list );
197 void list_keyblock( KBNODE keyblock, int secret, int fpr, void *opaque );
198 void print_fingerprint (PKT_public_key *pk, PKT_secret_key *sk, int mode);
199 void show_policy_url(PKT_signature *sig,int indent);
200 void show_notation(PKT_signature *sig,int indent);
201 void set_attrib_fd(int fd);
202 void print_seckey_info (PKT_secret_key *sk);
203 void print_pubkey_info (PKT_public_key *pk);
204
205 /*-- verify.c --*/
206 void print_file_status( int status, const char *name, int what );
207 int verify_signatures( int nfiles, char **files );
208 int verify_files( int nfiles, char **files );
209
210 /*-- decrypt.c --*/
211 int decrypt_message( const char *filename );
212 void decrypt_messages(int nfiles, char **files);
213
214 /*-- plaintext.c --*/
215 int hash_datafiles( MD_HANDLE md, MD_HANDLE md2,
216                     STRLIST files, const char *sigfilename, int textmode );
217
218 /*-- pipemode.c --*/
219 void run_in_pipemode (void);
220
221 /*-- signal.c --*/
222 void init_signals(void);
223 void pause_on_sigusr( int which );
224 void block_all_signals(void);
225 void unblock_all_signals(void);
226
227 #endif /*G10_MAIN_H*/