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