common/util.h

   1 /* util.h - Utility functions for GnuPG
   2  * Copyright (C) 2001, 2002, 2003, 2004, 2009 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 3 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, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #ifndef GNUPG_COMMON_UTIL_H
  21 #define GNUPG_COMMON_UTIL_H
  22
  23 #include <gcrypt.h> /* We need this for the memory function protos. */
  24 #include <time.h>   /* We need time_t. */
  25 #include <errno.h>  /* We need errno.  */
  26 #include <gpg-error.h> /* We need gpg_error_t. */
  27
  28 /* Add error codes available only in newer versions of libgpg-error.  */
  29 #ifndef GPG_ERR_NOT_ENABLED
  30 #define GPG_ERR_NOT_ENABLED 179
  31 #endif
  32
  33 /* Hash function used with libksba. */
  34 #define HASH_FNC ((void (*)(void *, const void*,size_t))gcry_md_write)
  35
  36 /* Get all the stuff from jnlib. */
  37 #include "../jnlib/logging.h"
  38 #include "../jnlib/argparse.h"
  39 #include "../jnlib/stringhelp.h"
  40 #include "../jnlib/mischelp.h"
  41 #include "../jnlib/strlist.h"
  42 #include "../jnlib/dotlock.h"
  43 #include "../jnlib/utf8conv.h"
  44 #include "../jnlib/dynload.h"
  45
  46 #include "init.h"
  47
  48 /* Redefine asprintf by our estream version which uses our own memory
  49    allocator..  */
  50 #include "estream-printf.h"
  51 #define asprintf estream_asprintf
  52 #define vasprintf estream_vasprintf
  53
  54 /* Due to a bug in mingw32's snprintf related to the 'l' modifier we
  55    better use our snprintf.  */
  56 #ifdef HAVE_W32_SYSTEM
  57 #define snprintf estream_snprintf
  58 #endif
  59
  60
  61 /* GCC attributes.  */
  62 #if __GNUC__ >= 4
  63 # define GNUPG_GCC_A_SENTINEL(a) __attribute__ ((sentinel(a)))
  64 #else
  65 # define GNUPG_GCC_A_SENTINEL(a)
  66 #endif
  67
  68
  69 /* We need this type even if we are not using libreadline and or we
  70    did not include libreadline in the current file. */
  71 #ifndef GNUPG_LIBREADLINE_H_INCLUDED
  72 typedef char **rl_completion_func_t (const char *, int, int);
  73 #endif /*!GNUPG_LIBREADLINE_H_INCLUDED*/
  74
  75
  76 /* Handy malloc macros - please use only them. */
  77 #define xtrymalloc(a)    gcry_malloc ((a))
  78 #define xtrymalloc_secure(a)  gcry_malloc_secure ((a))
  79 #define xtrycalloc(a,b)  gcry_calloc ((a),(b))
  80 #define xtrycalloc_secure(a,b)  gcry_calloc_secure ((a),(b))
  81 #define xtryrealloc(a,b) gcry_realloc ((a),(b))
  82 #define xtrystrdup(a)    gcry_strdup ((a))
  83 #define xfree(a)         gcry_free ((a))
  84
  85 #define xmalloc(a)       gcry_xmalloc ((a))
  86 #define xmalloc_secure(a)  gcry_xmalloc_secure ((a))
  87 #define xcalloc(a,b)     gcry_xcalloc ((a),(b))
  88 #define xcalloc_secure(a,b) gcry_xcalloc_secure ((a),(b))
  89 #define xrealloc(a,b)    gcry_xrealloc ((a),(b))
  90 #define xstrdup(a)       gcry_xstrdup ((a))
  91
  92 /* For compatibility with gpg 1.4 we also define these: */
  93 #define xmalloc_clear(a) gcry_xcalloc (1, (a))
  94 #define xmalloc_secure_clear(a) gcry_xcalloc_secure (1, (a))
  95
  96 /* Convenience function to return a gpg-error code for memory
  97    allocation failures.  This function makes sure that an error will
  98    be returned even if accidently ERRNO is not set.  */
  99 static inline gpg_error_t
 100 out_of_core (void)
 101 {
 102   return gpg_error_from_syserror ();
 103 }
 104
 105 /* A type to hold the ISO time.  Note that this this is the same as
 106    the the KSBA type ksba_isotime_t. */
 107 typedef char gnupg_isotime_t[16];
 108
 109
 110 /*-- gettime.c --*/
 111 time_t gnupg_get_time (void);
 112 void   gnupg_get_isotime (gnupg_isotime_t timebuf);
 113 void   gnupg_set_time (time_t newtime, int freeze);
 114 int    gnupg_faked_time_p (void);
 115 u32    make_timestamp (void);
 116 u32    scan_isodatestr (const char *string);
 117 time_t isotime2epoch (const char *string);
 118 void   epoch2isotime (gnupg_isotime_t timebuf, time_t atime);
 119 u32    add_days_to_timestamp (u32 stamp, u16 days);
 120 const char *strtimevalue (u32 stamp);
 121 const char *strtimestamp (u32 stamp); /* GMT */
 122 const char *isotimestamp (u32 stamp); /* GMT */
 123 const char *asctimestamp (u32 stamp); /* localized */
 124 gpg_error_t add_seconds_to_isotime (gnupg_isotime_t atime, int nseconds);
 125 gpg_error_t add_days_to_isotime (gnupg_isotime_t atime, int ndays);
 126 gpg_error_t check_isotime (const gnupg_isotime_t atime);
 127 void dump_isotime (const gnupg_isotime_t atime);
 128
 129 /* Copy one ISO date to another, this is inline so that we can do a
 130    minimal sanity check.  A null date (empty string) is allowed.  */
 131 static inline void
 132 gnupg_copy_time (gnupg_isotime_t d, const gnupg_isotime_t s)
 133 {
 134   if (*s)
 135     {
 136       if ((strlen (s) != 15 || s[8] != 'T'))
 137         BUG();
 138       memcpy (d, s, 15);
 139       d[15] = 0;
 140     }
 141   else
 142     *d = 0;
 143 }
 144
 145
 146 /*-- signal.c --*/
 147 void gnupg_init_signals (int mode, void (*fast_cleanup)(void));
 148 void gnupg_pause_on_sigusr (int which);
 149 void gnupg_block_all_signals (void);
 150 void gnupg_unblock_all_signals (void);
 151
 152 /*-- yesno.c --*/
 153 int answer_is_yes (const char *s);
 154 int answer_is_yes_no_default (const char *s, int def_answer);
 155 int answer_is_yes_no_quit (const char *s);
 156 int answer_is_okay_cancel (const char *s, int def_answer);
 157
 158 /*-- xreadline.c --*/
 159 ssize_t read_line (FILE *fp,
 160                    char **addr_of_buffer, size_t *length_of_buffer,
 161                    size_t *max_length);
 162
 163
 164 /*-- b64enc.c and b64dec.c --*/
 165 struct b64state
 166 {
 167   unsigned int flags;
 168   int idx;
 169   int quad_count;
 170   FILE *fp;
 171   char *title;
 172   unsigned char radbuf[4];
 173   u32 crc;
 174   int stop_seen:1;
 175   int invalid_encoding:1;
 176 };
 177
 178 gpg_error_t b64enc_start (struct b64state *state, FILE *fp, const char *title);
 179 gpg_error_t b64enc_write (struct b64state *state,
 180                           const void *buffer, size_t nbytes);
 181 gpg_error_t b64enc_finish (struct b64state *state);
 182
 183 gpg_error_t b64dec_start (struct b64state *state, const char *title);
 184 gpg_error_t b64dec_proc (struct b64state *state, void *buffer, size_t length,
 185                          size_t *r_nbytes);
 186 gpg_error_t b64dec_finish (struct b64state *state);
 187
 188
 189
 190
 191 /*-- sexputil.c */
 192 gpg_error_t make_canon_sexp (gcry_sexp_t sexp,
 193                              unsigned char **r_buffer, size_t *r_buflen);
 194 gpg_error_t keygrip_from_canon_sexp (const unsigned char *key, size_t keylen,
 195                                      unsigned char *grip);
 196 int cmp_simple_canon_sexp (const unsigned char *a, const unsigned char *b);
 197 unsigned char *make_simple_sexp_from_hexstr (const char *line,
 198                                              size_t *nscanned);
 199 int hash_algo_from_sigval (const unsigned char *sigval);
 200 unsigned char *make_canon_sexp_from_rsa_pk (const void *m, size_t mlen,
 201                                             const void *e, size_t elen,
 202                                             size_t *r_len);
 203 gpg_error_t get_rsa_pk_from_canon_sexp (const unsigned char *keydata,
 204                                         size_t keydatalen,
 205                                         unsigned char const **r_n,
 206                                         size_t *r_nlen,
 207                                         unsigned char const **r_e,
 208                                         size_t *r_elen);
 209 gpg_error_t get_pk_algo_from_canon_sexp (const unsigned char *keydata,
 210                                          size_t keydatalen,
 211                                          int *r_algo);
 212
 213 /*-- convert.c --*/
 214 int hex2bin (const char *string, void *buffer, size_t length);
 215 int hexcolon2bin (const char *string, void *buffer, size_t length);
 216 char *bin2hex (const void *buffer, size_t length, char *stringbuf);
 217 char *bin2hexcolon (const void *buffer, size_t length, char *stringbuf);
 218 const char *hex2str (const char *hexstring,
 219                      char *buffer, size_t bufsize, size_t *buflen);
 220 char *hex2str_alloc (const char *hexstring, size_t *r_count);
 221
 222 /*-- percent.c --*/
 223 char *percent_plus_escape (const char *string);
 224 char *percent_plus_unescape (const char *string, int nulrepl);
 225 char *percent_unescape (const char *string, int nulrepl);
 226
 227 size_t percent_plus_unescape_inplace (char *string, int nulrepl);
 228 size_t percent_unescape_inplace (char *string, int nulrepl);
 229
 230
 231 /*-- homedir.c --*/
 232 const char *standard_homedir (void);
 233 const char *default_homedir (void);
 234 const char *gnupg_sysconfdir (void);
 235 const char *gnupg_bindir (void);
 236 const char *gnupg_libexecdir (void);
 237 const char *gnupg_libdir (void);
 238 const char *gnupg_datadir (void);
 239 const char *gnupg_localedir (void);
 240 const char *dirmngr_socket_name (void);
 241
 242 /* All module names.  We also include gpg and gpgsm for the sake for
 243    gpgconf. */
 244 #define GNUPG_MODULE_NAME_AGENT        1
 245 #define GNUPG_MODULE_NAME_PINENTRY     2
 246 #define GNUPG_MODULE_NAME_SCDAEMON     3
 247 #define GNUPG_MODULE_NAME_DIRMNGR      4
 248 #define GNUPG_MODULE_NAME_PROTECT_TOOL 5
 249 #define GNUPG_MODULE_NAME_CHECK_PATTERN 6
 250 #define GNUPG_MODULE_NAME_GPGSM         7
 251 #define GNUPG_MODULE_NAME_GPG           8
 252 #define GNUPG_MODULE_NAME_CONNECT_AGENT 9
 253 #define GNUPG_MODULE_NAME_GPGCONF       10
 254 const char *gnupg_module_name (int which);
 255
 256
 257
 258 /*-- gpgrlhelp.c --*/
 259 void gnupg_rl_initialize (void);
 260
 261 /*-- helpfile.c --*/
 262 char *gnupg_get_help_string (const char *key, int only_current_locale);
 263
 264 /*-- localename.c --*/
 265 const char *gnupg_messages_locale_name (void);
 266
 267 /*-- miscellaneous.c --*/
 268
 269 /* This function is called at startup to tell libgcrypt to use our own
 270    logging subsystem. */
 271 void setup_libgcrypt_logging (void);
 272
 273 /* Same as estream_asprintf but die on memory failure.  */
 274 char *xasprintf (const char *fmt, ...) JNLIB_GCC_A_PRINTF(1,2);
 275 /* This is now an alias to estream_asprintf.  */
 276 char *xtryasprintf (const char *fmt, ...) JNLIB_GCC_A_PRINTF(1,2);
 277
 278 const char *print_fname_stdout (const char *s);
 279 const char *print_fname_stdin (const char *s);
 280 void print_string (FILE *fp, const byte *p, size_t n, int delim);
 281 void print_utf8_string2 ( FILE *fp, const byte *p, size_t n, int delim);
 282 void print_utf8_string (FILE *fp, const byte *p, size_t n);
 283 void print_hexstring (FILE *fp, const void *buffer, size_t length,
 284                       int reserved);
 285 char *make_printable_string (const void *p, size_t n, int delim);
 286
 287 int is_file_compressed (const char *s, int *ret_rc);
 288
 289 int match_multistr (const char *multistr,const char *match);
 290
 291
 292 /*-- Simple replacement functions. */
 293 #ifndef HAVE_TTYNAME
 294 /* Systems without ttyname (W32) will merely return NULL. */
 295 static inline char *
 296 ttyname (int fd)
 297 {
 298   (void)fd;
 299   return NULL;
 300 }
 301 #endif /* !HAVE_TTYNAME */
 302
 303
 304 /*-- Macros to replace ctype ones to avoid locale problems. --*/
 305 #define spacep(p)   (*(p) == ' ' || *(p) == '\t')
 306 #define digitp(p)   (*(p) >= '0' && *(p) <= '9')
 307 #define hexdigitp(a) (digitp (a)                     \
 308                       || (*(a) >= 'A' && *(a) <= 'F')  \
 309                       || (*(a) >= 'a' && *(a) <= 'f'))
 310   /* Note this isn't identical to a C locale isspace() without \f and
 311      \v, but works for the purposes used here. */
 312 #define ascii_isspace(a) ((a)==' ' || (a)=='\n' || (a)=='\r' || (a)=='\t')
 313
 314 /* The atoi macros assume that the buffer has only valid digits. */
 315 #define atoi_1(p)   (*(p) - '0' )
 316 #define atoi_2(p)   ((atoi_1(p) * 10) + atoi_1((p)+1))
 317 #define atoi_4(p)   ((atoi_2(p) * 100) + atoi_2((p)+2))
 318 #define xtoi_1(p)   (*(p) <= '9'? (*(p)- '0'): \
 319                      *(p) <= 'F'? (*(p)-'A'+10):(*(p)-'a'+10))
 320 #define xtoi_2(p)   ((xtoi_1(p) * 16) + xtoi_1((p)+1))
 321 #define xtoi_4(p)   ((xtoi_2(p) * 256) + xtoi_2((p)+2))
 322
 323
 324 /*-- Forward declaration of the commonly used server control structure.  */
 325 /*   (We need it here as it is used by some callback prototypes.) */
 326 struct server_control_s;
 327 typedef struct server_control_s *ctrl_t;
 328
 329
 330 #endif /*GNUPG_COMMON_UTIL_H*/