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