g10/main.h

   1 /* main.h
   2  * Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
   3  *               2008, 2009, 2010 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 "keydb.h"
  26 #include "util.h"
  27
  28 /* It could be argued that the default cipher should be 3DES rather
  29    than AES128, and the default compression should be 0
  30    (i.e. uncompressed) rather than 1 (zip).  However, the real world
  31    issues of speed and size come into play here. */
  32
  33 #if GPG_USE_AES128
  34 # define DEFAULT_CIPHER_ALGO     CIPHER_ALGO_AES
  35 #elif GPG_USE_CAST5
  36 # define DEFAULT_CIPHER_ALGO     CIPHER_ALGO_CAST5
  37 #else
  38 # define DEFAULT_CIPHER_ALGO     CIPHER_ALGO_3DES
  39 #endif
  40
  41 #define DEFAULT_DIGEST_ALGO     ((GNUPG)? DIGEST_ALGO_SHA256:DIGEST_ALGO_SHA1)
  42 #define DEFAULT_S2K_DIGEST_ALGO DIGEST_ALGO_SHA1
  43 #ifdef HAVE_ZIP
  44 # define DEFAULT_COMPRESS_ALGO   COMPRESS_ALGO_ZIP
  45 #else
  46 # define DEFAULT_COMPRESS_ALGO   COMPRESS_ALGO_NONE
  47 #endif
  48
  49
  50 #define S2K_DIGEST_ALGO (opt.s2k_digest_algo?opt.s2k_digest_algo:DEFAULT_S2K_DIGEST_ALGO)
  51
  52
  53 /* Various data objects.  */
  54
  55 typedef struct
  56 {
  57   int header_okay;
  58   PK_LIST pk_list;
  59   DEK *symkey_dek;
  60   STRING2KEY *symkey_s2k;
  61   cipher_filter_context_t cfx;
  62 } encrypt_filter_context_t;
  63
  64
  65 struct groupitem
  66 {
  67   char *name;
  68   strlist_t values;
  69   struct groupitem *next;
  70 };
  71
  72 struct weakhash
  73 {
  74   enum gcry_md_algos algo;
  75   int rejection_shown;
  76   struct weakhash *next;
  77 };
  78
  79
  80 /*-- gpg.c --*/
  81 extern int g10_errors_seen;
  82
  83 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 5 )
  84   void g10_exit(int rc) __attribute__ ((noreturn));
  85 #else
  86   void g10_exit(int rc);
  87 #endif
  88 void print_pubkey_algo_note (pubkey_algo_t algo);
  89 void print_cipher_algo_note (cipher_algo_t algo);
  90 void print_digest_algo_note (digest_algo_t algo);
  91 void print_digest_rejected_note (enum gcry_md_algos algo);
  92 void print_reported_error (gpg_error_t err, gpg_err_code_t skip_if_ec);
  93 void print_further_info (const char *format, ...) GPGRT_ATTR_PRINTF(1,2);
  94 void additional_weak_digest (const char* digestname);
  95
  96 /*-- armor.c --*/
  97 char *make_radix64_string( const byte *data, size_t len );
  98
  99 /*-- misc.c --*/
 100 void trap_unaligned(void);
 101 int disable_core_dumps(void);
 102 void register_secured_file (const char *fname);
 103 void unregister_secured_file (const char *fname);
 104 int  is_secured_file (int fd);
 105 int  is_secured_filename (const char *fname);
 106 u16 checksum_u16( unsigned n );
 107 u16 checksum( byte *p, unsigned n );
 108 u16 checksum_mpi( gcry_mpi_t a );
 109 u32 buffer_to_u32( const byte *buffer );
 110 const byte *get_session_marker( size_t *rlen );
 111
 112 enum gcry_cipher_algos map_cipher_openpgp_to_gcry (cipher_algo_t algo);
 113 #define openpgp_cipher_open(_a,_b,_c,_d) \
 114   gcry_cipher_open((_a),map_cipher_openpgp_to_gcry((_b)),(_c),(_d))
 115 #define openpgp_cipher_get_algo_keylen(_a) \
 116   gcry_cipher_get_algo_keylen(map_cipher_openpgp_to_gcry((_a)))
 117 #define openpgp_cipher_get_algo_blklen(_a) \
 118   gcry_cipher_get_algo_blklen(map_cipher_openpgp_to_gcry((_a)))
 119 int openpgp_cipher_blocklen (cipher_algo_t algo);
 120 int openpgp_cipher_test_algo(cipher_algo_t algo);
 121 const char *openpgp_cipher_algo_name (cipher_algo_t algo);
 122
 123 pubkey_algo_t map_pk_gcry_to_openpgp (enum gcry_pk_algos algo);
 124 int openpgp_pk_test_algo (pubkey_algo_t algo);
 125 int openpgp_pk_test_algo2 (pubkey_algo_t algo, unsigned int use);
 126 int openpgp_pk_algo_usage ( int algo );
 127 const char *openpgp_pk_algo_name (pubkey_algo_t algo);
 128
 129 enum gcry_md_algos map_md_openpgp_to_gcry (digest_algo_t algo);
 130 int openpgp_md_test_algo (digest_algo_t algo);
 131 const char *openpgp_md_algo_name (int algo);
 132
 133 struct expando_args
 134 {
 135   PKT_public_key *pk;
 136   PKT_public_key *pksk;
 137   byte imagetype;
 138   int validity_info;
 139   const char *validity_string;
 140   const byte *namehash;
 141 };
 142
 143 char *pct_expando(const char *string,struct expando_args *args);
 144 void deprecated_warning(const char *configname,unsigned int configlineno,
 145                         const char *option,const char *repl1,const char *repl2);
 146 void deprecated_command (const char *name);
 147 void obsolete_scdaemon_option (const char *configname,
 148                                unsigned int configlineno, const char *name);
 149
 150 int string_to_cipher_algo (const char *string);
 151 int string_to_digest_algo (const char *string);
 152
 153 const char *compress_algo_to_string(int algo);
 154 int string_to_compress_algo(const char *string);
 155 int check_compress_algo(int algo);
 156 int default_cipher_algo(void);
 157 int default_compress_algo(void);
 158 const char *compliance_option_string(void);
 159 void compliance_failure(void);
 160
 161 struct parse_options
 162 {
 163   char *name;
 164   unsigned int bit;
 165   char **value;
 166   char *help;
 167 };
 168
 169 char *optsep(char **stringp);
 170 char *argsplit(char *string);
 171 int parse_options(char *str,unsigned int *options,
 172                   struct parse_options *opts,int noisy);
 173 const char *get_libexecdir (void);
 174 int path_access(const char *file,int mode);
 175
 176 int pubkey_get_npkey (pubkey_algo_t algo);
 177 int pubkey_get_nskey (pubkey_algo_t algo);
 178 int pubkey_get_nsig (pubkey_algo_t algo);
 179 int pubkey_get_nenc (pubkey_algo_t algo);
 180
 181 /* Temporary helpers. */
 182 unsigned int pubkey_nbits( int algo, gcry_mpi_t *pkey );
 183 int mpi_print (estream_t stream, gcry_mpi_t a, int mode);
 184 unsigned int ecdsa_qbits_from_Q (unsigned int qbits);
 185
 186
 187 /*-- cpr.c --*/
 188 void set_status_fd ( int fd );
 189 int  is_status_enabled ( void );
 190 void write_status ( int no );
 191 void write_status_error (const char *where, gpg_error_t err);
 192 void write_status_errcode (const char *where, int errcode);
 193 void write_status_failure (const char *where, gpg_error_t err);
 194 void write_status_text ( int no, const char *text );
 195 void write_status_strings (int no, const char *text,
 196                            ...) GPGRT_ATTR_SENTINEL(0);
 197 void write_status_buffer ( int no,
 198                            const char *buffer, size_t len, int wrap );
 199 void write_status_text_and_buffer ( int no, const char *text,
 200                                     const char *buffer, size_t len, int wrap );
 201
 202 void write_status_begin_signing (gcry_md_hd_t md);
 203
 204
 205 int cpr_enabled(void);
 206 char *cpr_get( const char *keyword, const char *prompt );
 207 char *cpr_get_no_help( const char *keyword, const char *prompt );
 208 char *cpr_get_utf8( const char *keyword, const char *prompt );
 209 char *cpr_get_hidden( const char *keyword, const char *prompt );
 210 void cpr_kill_prompt(void);
 211 int  cpr_get_answer_is_yes_def (const char *keyword, const char *prompt,
 212                                 int def_yes);
 213 int  cpr_get_answer_is_yes( const char *keyword, const char *prompt );
 214 int  cpr_get_answer_yes_no_quit( const char *keyword, const char *prompt );
 215 int  cpr_get_answer_okay_cancel (const char *keyword,
 216                                  const char *prompt,
 217                                  int def_answer);
 218
 219 /*-- helptext.c --*/
 220 void display_online_help( const char *keyword );
 221
 222 /*-- encode.c --*/
 223 int setup_symkey (STRING2KEY **symkey_s2k,DEK **symkey_dek);
 224 int use_mdc (pk_list_t pk_list,int algo);
 225 int encrypt_symmetric (const char *filename );
 226 int encrypt_store (const char *filename );
 227 int encrypt_crypt (ctrl_t ctrl, int filefd, const char *filename,
 228                    strlist_t remusr, int use_symkey, pk_list_t provided_keys,
 229                    int outputfd);
 230 void encrypt_crypt_files (ctrl_t ctrl,
 231                           int nfiles, char **files, strlist_t remusr);
 232 int encrypt_filter (void *opaque, int control,
 233                     iobuf_t a, byte *buf, size_t *ret_len);
 234
 235
 236 /*-- sign.c --*/
 237 int complete_sig (PKT_signature *sig, PKT_public_key *pksk, gcry_md_hd_t md,
 238                   const char *cache_nonce);
 239 int sign_file (ctrl_t ctrl, strlist_t filenames, int detached, strlist_t locusr,
 240                int do_encrypt, strlist_t remusr, const char *outfile );
 241 int clearsign_file (ctrl_t ctrl,
 242                     const char *fname, strlist_t locusr, const char *outfile);
 243 int sign_symencrypt_file (ctrl_t ctrl, const char *fname, strlist_t locusr);
 244
 245 /*-- sig-check.c --*/
 246
 247 /* SIG is a revocation signature.  Check if any of PK's designated
 248    revokers generated it.  If so, return 0.  Note: this function
 249    (correctly) doesn't care if the designated revoker is revoked.  */
 250 int check_revocation_keys (PKT_public_key *pk, PKT_signature *sig);
 251 /* Check that the backsig BACKSIG from the subkey SUB_PK to its
 252    primary key MAIN_PK is valid.  */
 253 int check_backsig(PKT_public_key *main_pk,PKT_public_key *sub_pk,
 254                   PKT_signature *backsig);
 255 /* Check that the signature SIG over a key (e.g., a key binding or a
 256    key revocation) is valid.  (To check signatures over data, use
 257    check_signature.)  */
 258 int check_key_signature( KBNODE root, KBNODE sig, int *is_selfsig );
 259 /* Like check_key_signature, but with the ability to specify some
 260    additional parameters and get back additional information.  See the
 261    documentation for the implementation for details.  */
 262 int check_key_signature2( KBNODE root, KBNODE node, PKT_public_key *check_pk,
 263                           PKT_public_key *ret_pk, int *is_selfsig,
 264                           u32 *r_expiredate, int *r_expired );
 265
 266 /*-- delkey.c --*/
 267 gpg_error_t delete_keys (strlist_t names, int secret, int allow_both);
 268
 269 /*-- keyedit.c --*/
 270 void keyedit_menu (ctrl_t ctrl, const char *username, strlist_t locusr,
 271                    strlist_t commands, int quiet, int seckey_check );
 272 void keyedit_passwd (ctrl_t ctrl, const char *username);
 273 void keyedit_quick_adduid (ctrl_t ctrl, const char *username,
 274                            const char *newuid);
 275 void keyedit_quick_sign (ctrl_t ctrl, const char *fpr,
 276                          strlist_t uids, strlist_t locusr, int local);
 277 void show_basic_key_info (KBNODE keyblock);
 278
 279 /*-- keygen.c --*/
 280 u32 parse_expire_string(const char *string);
 281 u32 ask_expire_interval(int object,const char *def_expire);
 282 u32 ask_expiredate(void);
 283 void quick_generate_keypair (ctrl_t ctrl, const char *uid);
 284 void generate_keypair (ctrl_t ctrl, int full, const char *fname,
 285                        const char *card_serialno, int card_backup_key);
 286 int keygen_set_std_prefs (const char *string,int personal);
 287 PKT_user_id *keygen_get_std_prefs (void);
 288 int keygen_add_key_expire( PKT_signature *sig, void *opaque );
 289 int keygen_add_std_prefs( PKT_signature *sig, void *opaque );
 290 int keygen_upd_std_prefs( PKT_signature *sig, void *opaque );
 291 int keygen_add_keyserver_url(PKT_signature *sig, void *opaque);
 292 int keygen_add_notations(PKT_signature *sig,void *opaque);
 293 int keygen_add_revkey(PKT_signature *sig, void *opaque);
 294 gpg_error_t make_backsig (PKT_signature *sig, PKT_public_key *pk,
 295                           PKT_public_key *sub_pk, PKT_public_key *sub_psk,
 296                           u32 timestamp, const char *cache_nonce);
 297 gpg_error_t generate_subkeypair (ctrl_t ctrl, kbnode_t pub_keyblock);
 298 #ifdef ENABLE_CARD_SUPPORT
 299 gpg_error_t generate_card_subkeypair (kbnode_t pub_keyblock,
 300                                       int keyno, const char *serialno);
 301 #endif
 302
 303
 304 /*-- openfile.c --*/
 305 int overwrite_filep( const char *fname );
 306 char *make_outfile_name( const char *iname );
 307 char *ask_outfile_name( const char *name, size_t namelen );
 308 int open_outfile (int inp_fd, const char *iname, int mode,
 309                   int restrictedperm, iobuf_t *a);
 310 char *get_matching_datafile (const char *sigfilename);
 311 iobuf_t open_sigfile (const char *sigfilename, progress_filter_context_t *pfx);
 312 void try_make_homedir( const char *fname );
 313 char *get_openpgp_revocdir (const char *home);
 314
 315 /*-- seskey.c --*/
 316 void make_session_key( DEK *dek );
 317 gcry_mpi_t encode_session_key( int openpgp_pk_algo, DEK *dek, unsigned nbits );
 318 gcry_mpi_t encode_md_value (PKT_public_key *pk,
 319                             gcry_md_hd_t md, int hash_algo );
 320
 321 /*-- import.c --*/
 322 struct import_stats_s;
 323 typedef struct import_stats_s *import_stats_t;
 324 typedef gpg_error_t (*import_screener_t)(kbnode_t keyblock, void *arg);
 325
 326 int parse_import_options(char *str,unsigned int *options,int noisy);
 327 void import_keys (ctrl_t ctrl, char **fnames, int nnames,
 328                   import_stats_t stats_hd, unsigned int options);
 329 int import_keys_stream (ctrl_t ctrl, iobuf_t inp, import_stats_t stats_hd,
 330                         unsigned char **fpr,
 331                         size_t *fpr_len, unsigned int options);
 332 int import_keys_es_stream (ctrl_t ctrl, estream_t fp,
 333                            import_stats_t stats_handle,
 334                            unsigned char **fpr, size_t *fpr_len,
 335                            unsigned int options,
 336                            import_screener_t screener, void *screener_arg);
 337 gpg_error_t import_old_secring (ctrl_t ctrl, const char *fname);
 338 import_stats_t import_new_stats_handle (void);
 339 void import_release_stats_handle (import_stats_t hd);
 340 void import_print_stats (import_stats_t hd);
 341 gpg_error_t transfer_secret_keys (ctrl_t ctrl, struct import_stats_s *stats,
 342                                   kbnode_t sec_keyblock, int batch, int force);
 343
 344 int collapse_uids( KBNODE *keyblock );
 345
 346
 347 /*-- export.c --*/
 348 struct export_stats_s;
 349 typedef struct export_stats_s *export_stats_t;
 350
 351 export_stats_t export_new_stats (void);
 352 void export_release_stats (export_stats_t stats);
 353 void export_print_stats (export_stats_t stats);
 354
 355 int parse_export_options(char *str,unsigned int *options,int noisy);
 356
 357 int export_pubkeys (ctrl_t ctrl, strlist_t users, unsigned int options,
 358                     export_stats_t stats);
 359 int export_seckeys (ctrl_t ctrl, strlist_t users, export_stats_t stats);
 360 int export_secsubkeys (ctrl_t ctrl, strlist_t users, export_stats_t stats);
 361
 362 gpg_error_t export_pubkey_buffer (ctrl_t ctrl, const char *keyspec,
 363                                   unsigned int options,
 364                                   export_stats_t stats,
 365                                   kbnode_t *r_keyblock,
 366                                   void **r_data, size_t *r_datalen);
 367
 368 gpg_error_t receive_seckey_from_agent (ctrl_t ctrl, gcry_cipher_hd_t cipherhd,
 369                                        char **cache_nonce_addr, const char *hexgrip,
 370                                        PKT_public_key *pk);
 371
 372 gpg_error_t export_ssh_key (ctrl_t ctrl, const char *userid);
 373
 374 /*-- dearmor.c --*/
 375 int dearmor_file( const char *fname );
 376 int enarmor_file( const char *fname );
 377
 378 /*-- revoke.c --*/
 379 struct revocation_reason_info;
 380 int gen_standard_revoke (PKT_public_key *psk, const char *cache_nonce);
 381 int gen_revoke( const char *uname );
 382 int gen_desig_revoke (ctrl_t ctrl, const char *uname, strlist_t locusr);
 383 int revocation_reason_build_cb( PKT_signature *sig, void *opaque );
 384 struct revocation_reason_info *
 385                 ask_revocation_reason( int key_rev, int cert_rev, int hint );
 386 void release_revocation_reason_info( struct revocation_reason_info *reason );
 387
 388 /*-- keylist.c --*/
 389 void public_key_list (ctrl_t ctrl, strlist_t list, int locate_mode );
 390 void secret_key_list (ctrl_t ctrl, strlist_t list );
 391 void print_subpackets_colon(PKT_signature *sig);
 392 void reorder_keyblock (KBNODE keyblock);
 393 void list_keyblock_direct (ctrl_t ctrl, kbnode_t keyblock, int secret,
 394                            int has_secret, int fpr);
 395 void print_fingerprint (estream_t fp, PKT_public_key *pk, int mode);
 396 void print_revokers (estream_t fp, PKT_public_key *pk);
 397 void show_policy_url(PKT_signature *sig,int indent,int mode);
 398 void show_keyserver_url(PKT_signature *sig,int indent,int mode);
 399 void show_notation(PKT_signature *sig,int indent,int mode,int which);
 400 void dump_attribs (const PKT_user_id *uid, PKT_public_key *pk);
 401 void set_attrib_fd(int fd);
 402 char *format_seckey_info (PKT_public_key *pk);
 403 void print_seckey_info (PKT_public_key *pk);
 404 void print_pubkey_info (estream_t fp, PKT_public_key *pk);
 405 void print_card_key_info (estream_t fp, KBNODE keyblock);
 406
 407 /*-- verify.c --*/
 408 void print_file_status( int status, const char *name, int what );
 409 int verify_signatures (ctrl_t ctrl, int nfiles, char **files );
 410 int verify_files (ctrl_t ctrl, int nfiles, char **files );
 411 int gpg_verify (ctrl_t ctrl, int sig_fd, int data_fd, estream_t out_fp);
 412
 413 /*-- decrypt.c --*/
 414 int decrypt_message (ctrl_t ctrl, const char *filename );
 415 gpg_error_t decrypt_message_fd (ctrl_t ctrl, int input_fd, int output_fd);
 416 void decrypt_messages (ctrl_t ctrl, int nfiles, char *files[]);
 417
 418 /*-- plaintext.c --*/
 419 int hash_datafiles( gcry_md_hd_t md, gcry_md_hd_t md2,
 420                     strlist_t files, const char *sigfilename, int textmode);
 421 int hash_datafile_by_fd ( gcry_md_hd_t md, gcry_md_hd_t md2, int data_fd,
 422                           int textmode );
 423 PKT_plaintext *setup_plaintext_name(const char *filename,IOBUF iobuf);
 424
 425 /*-- server.c --*/
 426 int gpg_server (ctrl_t);
 427 gpg_error_t gpg_proxy_pinentry_notify (ctrl_t ctrl,
 428                                        const unsigned char *line);
 429
 430 #ifdef ENABLE_CARD_SUPPORT
 431 /*-- card-util.c --*/
 432 void change_pin (int no, int allow_admin);
 433 void card_status (estream_t fp, char *serialno, size_t serialnobuflen);
 434 void card_edit (ctrl_t ctrl, strlist_t commands);
 435 gpg_error_t  card_generate_subkey (KBNODE pub_keyblock);
 436 int  card_store_subkey (KBNODE node, int use);
 437 #endif
 438
 439 #define S2K_DECODE_COUNT(_val) ((16ul + ((_val) & 15)) << (((_val) >> 4) + 6))
 440
 441 /*-- migrate.c --*/
 442 void migrate_secring (ctrl_t ctrl);
 443
 444
 445 #endif /*G10_MAIN_H*/