See ChangeLog: Wed Oct 4 13:16:18 CEST 2000 Werner Koch
[gnupg.git] / g10 / main.h
1 /* main.h
2  *      Copyright (C) 1998, 1999, 2000 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 GPG_MAIN_H
21 #define GPG_MAIN_H
22
23 #include <gcrypt.h>
24 #include "basicdefs.h"
25 #include "iobuf.h"
26 #include "keydb.h"
27
28 #define DEFAULT_CIPHER_ALGO  GCRY_CIPHER_BLOWFISH
29 #define DEFAULT_PUBKEY_ALGO  GCRY_PUBKEY_ELGAMAL
30 #define DEFAULT_DIGEST_ALGO  GCRY_MD_RMD160
31
32 #define is_RSA(a)     ((a)==GCRY_PK_RSA || (a)==GCRY_PK_RSA_E \
33                                         || (a)==GCRY_PK_RSA_S )
34 #define is_ELGAMAL(a) ((a)==GCRY_PK_ELG || (a)==GCRY_PK_ELG_E)
35
36
37 /*-- gpg.c --*/
38 extern int gpg_errors_seen;
39
40 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 5 )
41   void gpg_exit(int rc) __attribute__ ((noreturn));
42 #else
43   void gpg_exit(int rc);
44 #endif
45 void print_pubkey_algo_note( int algo );
46 void print_cipher_algo_note( int algo );
47 void print_digest_algo_note( int algo );
48
49 /*-- armor.c --*/
50 char *make_radix64_string( const byte *data, size_t len );
51
52 /*-- misc.c --*/
53 void trap_unaligned(void);
54 int disable_core_dumps(void);
55 u16 checksum_u16( unsigned n );
56 u16 checksum( byte *p, unsigned n );
57 u16 checksum_mpi( MPI a );
58 u32 buffer_to_u32( const byte *buffer );
59
60 int mpi_write( IOBUF out, GCRY_MPI a );
61 int mpi_write_opaque( IOBUF out, MPI a );
62 GCRY_MPI mpi_read(IOBUF inp, unsigned int *ret_nread, int secure );
63 GCRY_MPI mpi_read_opaque(IOBUF inp, unsigned int *ret_nread );
64 int mpi_print( FILE *fp, MPI a, int mode );
65
66 int openpgp_cipher_test_algo( int algo );
67 int openpgp_pk_test_algo( int algo, unsigned int usage_flags );
68 int openpgp_pk_algo_usage ( int algo );
69 int openpgp_md_test_algo( int algo );
70
71 int pubkey_get_npkey( int algo );
72 int pubkey_get_nskey( int algo );
73 int pubkey_get_nsig( int algo );
74 int pubkey_get_nenc( int algo );
75 unsigned int pubkey_nbits( int algo, MPI *pkey );
76
77 /*-- helptext.c --*/
78 void display_online_help( const char *keyword );
79
80 /*-- encode.c --*/
81 int encode_symmetric( const char *filename );
82 int encode_store( const char *filename );
83 int encode_crypt( const char *filename, STRLIST remusr );
84 int encrypt_filter( void *opaque, int control,
85                     IOBUF a, byte *buf, size_t *ret_len);
86
87
88 /*-- sign.c --*/
89 int complete_sig( PKT_signature *sig, PKT_secret_key *sk, GCRY_MD_HD md );
90 int sign_file( STRLIST filenames, int detached, STRLIST locusr,
91                int do_encrypt, STRLIST remusr, const char *outfile );
92 int clearsign_file( const char *fname, STRLIST locusr, const char *outfile );
93
94 /*-- sig-check.c --*/
95 int check_key_signature( KBNODE root, KBNODE node, int *is_selfsig );
96 int check_key_signature2( KBNODE root, KBNODE node,
97                           int *is_selfsig, u32 *r_expiredate, int *r_expired );
98
99 /*-- delkey.c --*/
100 int delete_key( const char *username, int secure );
101
102 /*-- keyedit.c --*/
103 void keyedit_menu( const char *username, STRLIST locusr, STRLIST cmds,
104                                                             int sign_mode );
105
106 /*-- keygen.c --*/
107 u32 ask_expiredate(void);
108 void generate_keypair( const char *fname );
109 int keygen_add_key_expire( PKT_signature *sig, void *opaque );
110 int keygen_add_std_prefs( PKT_signature *sig, void *opaque );
111 int generate_subkeypair( KBNODE pub_keyblock, KBNODE sec_keyblock );
112
113 /*-- openfile.c --*/
114 int overwrite_filep( const char *fname );
115 char *make_outfile_name( const char *iname );
116 char *ask_outfile_name( const char *name, size_t namelen );
117 int   open_outfile( const char *iname, int mode, IOBUF *a );
118 IOBUF open_sigfile( const char *iname );
119 void try_make_homedir( const char *fname );
120
121 /*-- seskey.c --*/
122 void make_session_key( DEK *dek );
123 MPI encode_session_key( DEK *dek, unsigned nbits );
124 MPI encode_md_value( int pubkey_algo,  GCRY_MD_HD md,
125                      int hash_algo, unsigned nbits, int v3compathack );
126
127 /*-- comment.c --*/
128 KBNODE make_comment_node_from_buffer( const char *s, size_t n );
129 KBNODE make_comment_node( const char *s );
130
131 /*-- import.c --*/
132 void import_keys( char **fnames, int nnames, int fast );
133 int import_keys_stream( IOBUF inp, int fast );
134 int collapse_uids( KBNODE *keyblock );
135
136 /*-- export.c --*/
137 int export_pubkeys( STRLIST users, int onlyrfc );
138 int export_pubkeys_stream( IOBUF out, STRLIST users, int onlyrfc );
139 int export_seckeys( STRLIST users );
140 int export_secsubkeys( STRLIST users );
141
142 /* dearmor.c --*/
143 int dearmor_file( const char *fname );
144 int enarmor_file( const char *fname );
145
146 /*-- revoke.c --*/
147 struct revocation_reason_info;
148 int gen_revoke( const char *uname );
149 int revocation_reason_build_cb( PKT_signature *sig, void *opaque );
150 struct revocation_reason_info *
151                 ask_revocation_reason( int key_rev, int cert_rev, int hint );
152 void release_revocation_reason_info( struct revocation_reason_info *reason );
153
154 /*-- keylist.c --*/
155 void public_key_list( STRLIST list );
156 void secret_key_list( STRLIST list );
157
158 /*-- verify.c --*/
159 int verify_signatures( int nfiles, char **files );
160 int verify_files( int nfiles, char **files );
161
162 /*-- decrypt.c --*/
163 int decrypt_message( const char *filename );
164
165 /*-- plaintext.c --*/
166 int hash_datafiles( GCRY_MD_HD md, GCRY_MD_HD md2,
167                     STRLIST files, const char *sigfilename, int textmode );
168
169 /*-- signal.c --*/
170 void init_signals(void);
171 void pause_on_sigusr( int which );
172 void block_all_signals(void);
173 void unblock_all_signals(void);
174
175 #endif /*GPG_MAIN_H*/