g10/main.h

   1 /* main.h
   2  * Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
   3  *               2008 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 3 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, see <http://www.gnu.org/licenses/>.
  19  */
  20 #ifndef G10_MAIN_H
  21 #define G10_MAIN_H
  22
  23 #include "types.h"
  24 #include "iobuf.h"
  25 #include "cipher.h"
  26 #include "keydb.h"
  27 #include "util.h"
  28
  29
  30 /* It could be argued that the default cipher should be 3DES rather
  31    than CAST5, and the default compression should be 0
  32    (i.e. uncompressed) rather than 1 (zip).  However, the real world
  33    issues of speed and size come into play here. */
  34
  35 #define DEFAULT_CIPHER_ALGO     CIPHER_ALGO_CAST5
  36 #define DEFAULT_DIGEST_ALGO     DIGEST_ALGO_SHA1
  37 #define DEFAULT_COMPRESS_ALGO   COMPRESS_ALGO_ZIP
  38 #define DEFAULT_S2K_DIGEST_ALGO DIGEST_ALGO_SHA1
  39
  40 #define S2K_DIGEST_ALGO (opt.s2k_digest_algo?opt.s2k_digest_algo:DEFAULT_S2K_DIGEST_ALGO)
  41
  42 typedef struct
  43 {
  44   int header_okay;
  45   PK_LIST pk_list;
  46   DEK *symkey_dek;
  47   STRING2KEY *symkey_s2k;
  48   cipher_filter_context_t cfx;
  49 } encrypt_filter_context_t;
  50
  51 struct groupitem
  52 {
  53   char *name;
  54   strlist_t values;
  55   struct groupitem *next;
  56 };
  57
  58 /*-- gpg.c --*/
  59 extern int g10_errors_seen;
  60
  61 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 5 )
  62   void g10_exit(int rc) __attribute__ ((noreturn));
  63 #else
  64   void g10_exit(int rc);
  65 #endif
  66 void print_pubkey_algo_note( int algo );
  67 void print_cipher_algo_note( int algo );
  68 void print_digest_algo_note( int algo );
  69
  70 /*-- armor.c --*/
  71 char *make_radix64_string( const byte *data, size_t len );
  72
  73 /*-- misc.c --*/
  74 void trap_unaligned(void);
  75 int disable_core_dumps(void);
  76 void register_secured_file (const char *fname);
  77 void unregister_secured_file (const char *fname);
  78 int  is_secured_file (int fd);
  79 int  is_secured_filename (const char *fname);
  80 u16 checksum_u16( unsigned n );
  81 u16 checksum( byte *p, unsigned n );
  82 u16 checksum_mpi( gcry_mpi_t a );
  83 u32 buffer_to_u32( const byte *buffer );
  84 const byte *get_session_marker( size_t *rlen );
  85 int openpgp_cipher_blocklen (int algo);
  86 int openpgp_cipher_test_algo( int algo );
  87 const char *openpgp_cipher_algo_name (int algo);
  88 int openpgp_pk_test_algo( int algo );
  89 int openpgp_pk_test_algo2 ( int algo, unsigned int use );
  90 int openpgp_pk_algo_usage ( int algo );
  91 int openpgp_md_test_algo( int algo );
  92
  93 #ifdef USE_IDEA
  94 void idea_cipher_warn( int show );
  95 #else
  96 #define idea_cipher_warn(a)  do { } while (0)
  97 #endif
  98
  99 struct expando_args
 100 {
 101   PKT_public_key *pk;
 102   PKT_secret_key *sk;
 103   byte imagetype;
 104   int validity_info;
 105   const char *validity_string;
 106 };
 107
 108 char *pct_expando(const char *string,struct expando_args *args);
 109 void deprecated_warning(const char *configname,unsigned int configlineno,
 110                         const char *option,const char *repl1,const char *repl2);
 111 void deprecated_command (const char *name);
 112 void obsolete_option (const char *configname, unsigned int configlineno,
 113                       const char *name);
 114
 115 int string_to_cipher_algo (const char *string);
 116 int string_to_digest_algo (const char *string);
 117
 118 const char *compress_algo_to_string(int algo);
 119 int string_to_compress_algo(const char *string);
 120 int check_compress_algo(int algo);
 121 int default_cipher_algo(void);
 122 int default_compress_algo(void);
 123 const char *compliance_option_string(void);
 124 void compliance_failure(void);
 125
 126 struct parse_options
 127 {
 128   char *name;
 129   unsigned int bit;
 130   char **value;
 131   char *help;
 132 };
 133
 134 char *optsep(char **stringp);
 135 char *argsplit(char *string);
 136 int parse_options(char *str,unsigned int *options,
 137                   struct parse_options *opts,int noisy);
 138 char *unescape_percent_string (const unsigned char *s);
 139 int has_invalid_email_chars (const char *s);
 140 int is_valid_mailbox (const char *name);
 141 const char *get_libexecdir (void);
 142 int path_access(const char *file,int mode);
 143
 144 /* Temporary helpers. */
 145 int pubkey_get_npkey( int algo );
 146 int pubkey_get_nskey( int algo );
 147 int pubkey_get_nsig( int algo );
 148 int pubkey_get_nenc( int algo );
 149 unsigned int pubkey_nbits( int algo, gcry_mpi_t *pkey );
 150 int mpi_print( FILE *fp, gcry_mpi_t a, int mode );
 151
 152 /*-- status.c --*/
 153 void set_status_fd ( int fd );
 154 int  is_status_enabled ( void );
 155 void write_status ( int no );
 156 void write_status_error (const char *where, int errcode);
 157 void write_status_text ( int no, const char *text );
 158 void write_status_buffer ( int no,
 159                            const char *buffer, size_t len, int wrap );
 160 void write_status_text_and_buffer ( int no, const char *text,
 161                                     const char *buffer, size_t len, int wrap );
 162
 163 void write_status_begin_signing (gcry_md_hd_t md);
 164
 165
 166 int cpr_enabled(void);
 167 char *cpr_get( const char *keyword, const char *prompt );
 168 char *cpr_get_no_help( const char *keyword, const char *prompt );
 169 char *cpr_get_utf8( const char *keyword, const char *prompt );
 170 char *cpr_get_hidden( const char *keyword, const char *prompt );
 171 void cpr_kill_prompt(void);
 172 int  cpr_get_answer_is_yes( const char *keyword, const char *prompt );
 173 int  cpr_get_answer_yes_no_quit( const char *keyword, const char *prompt );
 174 int  cpr_get_answer_okay_cancel (const char *keyword,
 175                                  const char *prompt,
 176                                  int def_answer);
 177
 178 /*-- helptext.c --*/
 179 void display_online_help( const char *keyword );
 180
 181 /*-- encode.c --*/
 182 int setup_symkey(STRING2KEY **symkey_s2k,DEK **symkey_dek);
 183 int encode_symmetric( const char *filename );
 184 int encode_store( const char *filename );
 185 int encode_crypt( const char *filename, strlist_t remusr, int use_symkey );
 186 void encode_crypt_files(int nfiles, char **files, strlist_t remusr);
 187 int encrypt_filter( void *opaque, int control,
 188                     iobuf_t a, byte *buf, size_t *ret_len);
 189
 190
 191 /*-- sign.c --*/
 192 int complete_sig( PKT_signature *sig, PKT_secret_key *sk, gcry_md_hd_t md );
 193 int sign_file( strlist_t filenames, int detached, strlist_t locusr,
 194                int do_encrypt, strlist_t remusr, const char *outfile );
 195 int clearsign_file( const char *fname, strlist_t locusr, const char *outfile );
 196 int sign_symencrypt_file (const char *fname, strlist_t locusr);
 197
 198 /*-- sig-check.c --*/
 199 int check_revocation_keys (PKT_public_key *pk, PKT_signature *sig);
 200 int check_backsig(PKT_public_key *main_pk,PKT_public_key *sub_pk,
 201                   PKT_signature *backsig);
 202 int check_key_signature( KBNODE root, KBNODE node, int *is_selfsig );
 203 int check_key_signature2( KBNODE root, KBNODE node, PKT_public_key *check_pk,
 204                           PKT_public_key *ret_pk, int *is_selfsig,
 205                           u32 *r_expiredate, int *r_expired );
 206
 207 /*-- delkey.c --*/
 208 int delete_keys( strlist_t names, int secret, int allow_both );
 209
 210 /*-- keyedit.c --*/
 211 void keyedit_menu( const char *username, strlist_t locusr,
 212                    strlist_t commands, int quiet, int seckey_check );
 213 void show_basic_key_info (KBNODE keyblock);
 214
 215 /*-- keygen.c --*/
 216 u32 parse_expire_string(const char *string);
 217 u32 ask_expire_interval(int object,const char *def_expire);
 218 u32 ask_expiredate(void);
 219 void generate_keypair( const char *fname, const char *card_serialno,
 220                        const char *backup_encryption_dir );
 221 int keygen_set_std_prefs (const char *string,int personal);
 222 PKT_user_id *keygen_get_std_prefs (void);
 223 int keygen_add_key_expire( PKT_signature *sig, void *opaque );
 224 int keygen_add_std_prefs( PKT_signature *sig, void *opaque );
 225 int keygen_upd_std_prefs( PKT_signature *sig, void *opaque );
 226 int keygen_add_keyserver_url(PKT_signature *sig, void *opaque);
 227 int keygen_add_notations(PKT_signature *sig,void *opaque);
 228 int keygen_add_revkey(PKT_signature *sig, void *opaque);
 229 int make_backsig(PKT_signature *sig,PKT_public_key *pk,
 230                  PKT_public_key *sub_pk,PKT_secret_key *sub_sk,
 231                  u32 timestamp);
 232 int generate_subkeypair( KBNODE pub_keyblock, KBNODE sec_keyblock );
 233 #ifdef ENABLE_CARD_SUPPORT
 234 int generate_card_subkeypair (KBNODE pub_keyblock, KBNODE sec_keyblock,
 235                               int keyno, const char *serialno);
 236 int save_unprotected_key_to_card (PKT_secret_key *sk, int keyno);
 237 #endif
 238
 239 /*-- openfile.c --*/
 240 int overwrite_filep( const char *fname );
 241 char *make_outfile_name( const char *iname );
 242 char *ask_outfile_name( const char *name, size_t namelen );
 243 int   open_outfile( const char *iname, int mode, iobuf_t *a );
 244 iobuf_t open_sigfile( const char *iname, progress_filter_context_t *pfx );
 245 void try_make_homedir( const char *fname );
 246
 247 /*-- seskey.c --*/
 248 void make_session_key( DEK *dek );
 249 gcry_mpi_t encode_session_key( DEK *dek, unsigned nbits );
 250 gcry_mpi_t encode_md_value( PKT_public_key *pk, PKT_secret_key *sk,
 251                             gcry_md_hd_t md, int hash_algo );
 252
 253 /*-- import.c --*/
 254 int parse_import_options(char *str,unsigned int *options,int noisy);
 255 void import_keys( char **fnames, int nnames,
 256                   void *stats_hd, unsigned int options );
 257 int import_keys_stream( iobuf_t inp,void *stats_hd,unsigned char **fpr,
 258                         size_t *fpr_len,unsigned int options );
 259 void *import_new_stats_handle (void);
 260 void import_release_stats_handle (void *p);
 261 void import_print_stats (void *hd);
 262
 263 int collapse_uids( KBNODE *keyblock );
 264
 265 int auto_create_card_key_stub ( const char *serialnostr,
 266                                 const unsigned char *fpr1,
 267                                 const unsigned char *fpr2,
 268                                 const unsigned char *fpr3);
 269
 270 /*-- export.c --*/
 271 int parse_export_options(char *str,unsigned int *options,int noisy);
 272 int export_pubkeys( strlist_t users, unsigned int options );
 273 int export_pubkeys_stream( iobuf_t out, strlist_t users,
 274                            KBNODE *keyblock_out, unsigned int options );
 275 int export_seckeys( strlist_t users );
 276 int export_secsubkeys( strlist_t users );
 277
 278 /* dearmor.c --*/
 279 int dearmor_file( const char *fname );
 280 int enarmor_file( const char *fname );
 281
 282 /*-- revoke.c --*/
 283 struct revocation_reason_info;
 284 int gen_revoke( const char *uname );
 285 int gen_desig_revoke( const char *uname, strlist_t locusr);
 286 int revocation_reason_build_cb( PKT_signature *sig, void *opaque );
 287 struct revocation_reason_info *
 288                 ask_revocation_reason( int key_rev, int cert_rev, int hint );
 289 void release_revocation_reason_info( struct revocation_reason_info *reason );
 290
 291 /*-- keylist.c --*/
 292 void public_key_list( strlist_t list, int locate_mode );
 293 void secret_key_list( strlist_t list );
 294 void print_subpackets_colon(PKT_signature *sig);
 295 void reorder_keyblock (KBNODE keyblock);
 296 void list_keyblock( KBNODE keyblock, int secret, int fpr, void *opaque );
 297 void print_fingerprint (PKT_public_key *pk, PKT_secret_key *sk, int mode);
 298 void print_revokers(PKT_public_key *pk);
 299 void show_policy_url(PKT_signature *sig,int indent,int mode);
 300 void show_keyserver_url(PKT_signature *sig,int indent,int mode);
 301 void show_notation(PKT_signature *sig,int indent,int mode,int which);
 302 void dump_attribs(const PKT_user_id *uid,
 303                   PKT_public_key *pk,PKT_secret_key *sk);
 304 void set_attrib_fd(int fd);
 305 void print_seckey_info (PKT_secret_key *sk);
 306 void print_pubkey_info (FILE *fp, PKT_public_key *pk);
 307 void print_card_key_info (FILE *fp, KBNODE keyblock);
 308
 309 /*-- verify.c --*/
 310 void print_file_status( int status, const char *name, int what );
 311 int verify_signatures( int nfiles, char **files );
 312 int verify_files( int nfiles, char **files );
 313 int gpg_verify (ctrl_t ctrl, int sig_fd, int data_fd, FILE *out_fp);
 314
 315 /*-- decrypt.c --*/
 316 int decrypt_message( const char *filename );
 317 void decrypt_messages(int nfiles, char *files[]);
 318
 319 /*-- plaintext.c --*/
 320 int hash_datafiles( gcry_md_hd_t md, gcry_md_hd_t md2,
 321                     strlist_t files, const char *sigfilename, int textmode );
 322 int hash_datafile_by_fd ( gcry_md_hd_t md, gcry_md_hd_t md2, int data_fd,
 323                           int textmode );
 324 PKT_plaintext *setup_plaintext_name(const char *filename,IOBUF iobuf);
 325
 326 /*-- signal.c --*/
 327 void init_signals(void);
 328 void pause_on_sigusr( int which );
 329 void block_all_signals(void);
 330 void unblock_all_signals(void);
 331
 332 /*-- server.c --*/
 333 int gpg_server (ctrl_t);
 334
 335 #ifdef ENABLE_CARD_SUPPORT
 336 /*-- card-util.c --*/
 337 void change_pin (int no, int allow_admin);
 338 void card_status (FILE *fp, char *serialno, size_t serialnobuflen);
 339 void card_edit (strlist_t commands);
 340 int  card_generate_subkey (KBNODE pub_keyblock, KBNODE sec_keyblock);
 341 int  card_store_subkey (KBNODE node, int use);
 342 #endif
 343
 344 #define S2K_DECODE_COUNT(_val) ((16ul + ((_val) & 15)) << (((_val) >> 4) + 6))
 345
 346 #endif /*G10_MAIN_H*/