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