Fix a bug in estream_snprintf. Found by a failed t-gettime under Windows.
[gnupg.git] / common / util.h
1 /* util.h - Utility functions for GnuPG
2  * Copyright (C) 2001, 2002, 2003, 2004 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
123 /* Copy one ISO date to another, this is inline so that we can do a
124    minimal sanity check.  A null date (empty string) is allowed.  */
125 static inline void
126 gnupg_copy_time (gnupg_isotime_t d, const gnupg_isotime_t s)
127 {
128   if (*s)
129     {
130       if ((strlen (s) != 15 || s[8] != 'T'))
131         BUG();
132       memcpy (d, s, 15);
133       d[15] = 0;
134     }
135   else
136     *d = 0;
137 }
138
139
140 /*-- signal.c --*/
141 void gnupg_init_signals (int mode, void (*fast_cleanup)(void));
142 void gnupg_pause_on_sigusr (int which);
143 void gnupg_block_all_signals (void);
144 void gnupg_unblock_all_signals (void);
145
146 /*-- yesno.c --*/
147 int answer_is_yes (const char *s);
148 int answer_is_yes_no_default (const char *s, int def_answer);
149 int answer_is_yes_no_quit (const char *s);
150 int answer_is_okay_cancel (const char *s, int def_answer);
151
152 /*-- xreadline.c --*/
153 ssize_t read_line (FILE *fp, 
154                    char **addr_of_buffer, size_t *length_of_buffer,
155                    size_t *max_length);
156
157
158 /*-- b64enc.c and b64dec.c --*/
159 struct b64state 
160
161   unsigned int flags;
162   int idx;
163   int quad_count;
164   FILE *fp;
165   char *title;
166   unsigned char radbuf[4];
167   u32 crc;
168   int stop_seen:1;
169   int invalid_encoding:1;
170 };
171
172 gpg_error_t b64enc_start (struct b64state *state, FILE *fp, const char *title);
173 gpg_error_t b64enc_write (struct b64state *state,
174                           const void *buffer, size_t nbytes);
175 gpg_error_t b64enc_finish (struct b64state *state);
176
177 gpg_error_t b64dec_start (struct b64state *state, const char *title);
178 gpg_error_t b64dec_proc (struct b64state *state, void *buffer, size_t length,
179                          size_t *r_nbytes);
180 gpg_error_t b64dec_finish (struct b64state *state);
181
182
183
184
185 /*-- sexputil.c */
186 gpg_error_t keygrip_from_canon_sexp (const unsigned char *key, size_t keylen,
187                                      unsigned char *grip);
188 int cmp_simple_canon_sexp (const unsigned char *a, const unsigned char *b);
189 unsigned char *make_simple_sexp_from_hexstr (const char *line,
190                                              size_t *nscanned);
191 int hash_algo_from_sigval (const unsigned char *sigval);
192
193 /*-- convert.c --*/
194 int hex2bin (const char *string, void *buffer, size_t length);
195 int hexcolon2bin (const char *string, void *buffer, size_t length);
196 char *bin2hex (const void *buffer, size_t length, char *stringbuf);
197 char *bin2hexcolon (const void *buffer, size_t length, char *stringbuf);
198 const char *hex2str (const char *hexstring,
199                      char *buffer, size_t bufsize, size_t *buflen);
200 char *hex2str_alloc (const char *hexstring, size_t *r_count);
201
202
203 /*-- homedir.c --*/
204 const char *standard_homedir (void);
205 const char *default_homedir (void);
206 const char *gnupg_sysconfdir (void);
207 const char *gnupg_bindir (void);
208 const char *gnupg_libexecdir (void);
209 const char *gnupg_libdir (void);
210 const char *gnupg_datadir (void);
211 const char *dirmngr_socket_name (void);
212
213 /* All module names.  We also include gpg and gpgsm for the sake for
214    gpgconf. */
215 #define GNUPG_MODULE_NAME_AGENT        1
216 #define GNUPG_MODULE_NAME_PINENTRY     2
217 #define GNUPG_MODULE_NAME_SCDAEMON     3 
218 #define GNUPG_MODULE_NAME_DIRMNGR      4
219 #define GNUPG_MODULE_NAME_PROTECT_TOOL 5
220 #define GNUPG_MODULE_NAME_CHECK_PATTERN 6
221 #define GNUPG_MODULE_NAME_GPGSM         7
222 #define GNUPG_MODULE_NAME_GPG           8
223 #define GNUPG_MODULE_NAME_CONNECT_AGENT 9
224 #define GNUPG_MODULE_NAME_GPGCONF       10
225 const char *gnupg_module_name (int which);
226
227
228
229 /*-- gpgrlhelp.c --*/
230 void gnupg_rl_initialize (void);
231
232 /*-- helpfile.c --*/
233 char *gnupg_get_help_string (const char *key, int only_current_locale);
234
235 /*-- localename.c --*/
236 const char *gnupg_messages_locale_name (void);
237
238 /*-- miscellaneous.c --*/
239
240 /* This function is called at startup to tell libgcrypt to use our own
241    logging subsystem. */
242 void setup_libgcrypt_logging (void);
243
244 /* Same as estream_asprintf but die on memory failure.  */
245 char *xasprintf (const char *fmt, ...) JNLIB_GCC_A_PRINTF(1,2);
246 /* This is now an alias to estream_asprintf.  */
247 char *xtryasprintf (const char *fmt, ...) JNLIB_GCC_A_PRINTF(1,2);
248
249 const char *print_fname_stdout (const char *s);
250 const char *print_fname_stdin (const char *s);
251 void print_string (FILE *fp, const byte *p, size_t n, int delim);
252 void print_utf8_string2 ( FILE *fp, const byte *p, size_t n, int delim);
253 void print_utf8_string (FILE *fp, const byte *p, size_t n);
254 void print_hexstring (FILE *fp, const void *buffer, size_t length,
255                       int reserved);
256 char *make_printable_string (const void *p, size_t n, int delim);
257
258 int is_file_compressed (const char *s, int *ret_rc);
259
260 int match_multistr (const char *multistr,const char *match);
261
262
263 /*-- Simple replacement functions. */
264 #ifndef HAVE_TTYNAME
265 /* Systems without ttyname (W32) will merely return NULL. */
266 static inline char *
267 ttyname (int fd) 
268 {
269   (void)fd;
270   return NULL;
271 }
272 #endif /* !HAVE_TTYNAME */
273
274
275 /*-- Macros to replace ctype ones to avoid locale problems. --*/
276 #define spacep(p)   (*(p) == ' ' || *(p) == '\t')
277 #define digitp(p)   (*(p) >= '0' && *(p) <= '9')
278 #define hexdigitp(a) (digitp (a)                     \
279                       || (*(a) >= 'A' && *(a) <= 'F')  \
280                       || (*(a) >= 'a' && *(a) <= 'f'))
281   /* Note this isn't identical to a C locale isspace() without \f and
282      \v, but works for the purposes used here. */
283 #define ascii_isspace(a) ((a)==' ' || (a)=='\n' || (a)=='\r' || (a)=='\t')
284
285 /* The atoi macros assume that the buffer has only valid digits. */
286 #define atoi_1(p)   (*(p) - '0' )
287 #define atoi_2(p)   ((atoi_1(p) * 10) + atoi_1((p)+1))
288 #define atoi_4(p)   ((atoi_2(p) * 100) + atoi_2((p)+2))
289 #define xtoi_1(p)   (*(p) <= '9'? (*(p)- '0'): \
290                      *(p) <= 'F'? (*(p)-'A'+10):(*(p)-'a'+10))
291 #define xtoi_2(p)   ((xtoi_1(p) * 16) + xtoi_1((p)+1))
292 #define xtoi_4(p)   ((xtoi_2(p) * 256) + xtoi_2((p)+2))
293
294
295 /*-- Forward declaration of the commonly used server control structure.  */
296 /*   (We need it here as it is used by some callback prototypes.) */
297 struct server_control_s;
298 typedef struct server_control_s *ctrl_t;
299
300
301 #endif /*GNUPG_COMMON_UTIL_H*/