w32: Fix build problem with dirmngr.
[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 JNLIB, which is a subsystem of GnuPG.
5  *
6  * JNLIB is free software; you can redistribute it and/or modify it
7  * under the terms of either
8  *
9  *   - the GNU Lesser General Public License as published by the Free
10  *     Software Foundation; either version 3 of the License, or (at
11  *     your option) any later version.
12  *
13  * or
14  *
15  *   - the GNU General Public License as published by the Free
16  *     Software Foundation; either version 2 of the License, or (at
17  *     your option) any later version.
18  *
19  * or both in parallel, as here.
20  *
21  * JNLIB is distributed in the hope that it will be useful, but
22  * WITHOUT ANY WARRANTY; without even the implied warranty of
23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
24  * General Public License for more details.
25  *
26  * You should have received a copies of the GNU General Public License
27  * and the GNU Lesser General Public License along with this program;
28  * if not, see <http://www.gnu.org/licenses/>.
29  */
30
31 #ifndef GNUPG_COMMON_UTIL_H
32 #define GNUPG_COMMON_UTIL_H
33
34 #include <gcrypt.h> /* We need this for the memory function protos. */
35 #include <errno.h>  /* We need errno.  */
36 #include <gpg-error.h> /* We need gpg_error_t. */
37
38
39 /* Hash function used with libksba. */
40 #define HASH_FNC ((void (*)(void *, const void*,size_t))gcry_md_write)
41
42 /* Estream replaces most uses of stdio.  */
43 #include "../common/estream.h"
44 #include "../common/estream-printf.h"
45
46 /* Get all the stuff from jnlib. */
47 #include "../common/logging.h"
48 #include "../common/argparse.h"
49 #include "../common/stringhelp.h"
50 #include "../common/mischelp.h"
51 #include "../common/strlist.h"
52 #include "../common/dotlock.h"
53 #include "../common/utf8conv.h"
54 #include "../common/dynload.h"
55
56 #include "gettime.h"
57
58 /* Redefine asprintf by our estream version which uses our own memory
59    allocator..  */
60 #define asprintf estream_asprintf
61 #define vasprintf estream_vasprintf
62
63 /* Due to a bug in mingw32's snprintf related to the 'l' modifier and
64    for increased portability we use our snprintf on all systems. */
65 #undef snprintf
66 #define snprintf estream_snprintf
67
68
69 /* GCC attributes.  */
70 #if __GNUC__ >= 4
71 # define GNUPG_GCC_A_SENTINEL(a) __attribute__ ((sentinel(a)))
72 #else
73 # define GNUPG_GCC_A_SENTINEL(a)
74 #endif
75
76
77 /* We need this type even if we are not using libreadline and or we
78    did not include libreadline in the current file. */
79 #ifndef GNUPG_LIBREADLINE_H_INCLUDED
80 typedef char **rl_completion_func_t (const char *, int, int);
81 #endif /*!GNUPG_LIBREADLINE_H_INCLUDED*/
82
83
84 /* Handy malloc macros - please use only them. */
85 #define xtrymalloc(a)    gcry_malloc ((a))
86 #define xtrymalloc_secure(a)  gcry_malloc_secure ((a))
87 #define xtrycalloc(a,b)  gcry_calloc ((a),(b))
88 #define xtrycalloc_secure(a,b)  gcry_calloc_secure ((a),(b))
89 #define xtryrealloc(a,b) gcry_realloc ((a),(b))
90 #define xtrystrdup(a)    gcry_strdup ((a))
91 #define xfree(a)         gcry_free ((a))
92 #define xfree_fnc        gcry_free
93
94 #define xmalloc(a)       gcry_xmalloc ((a))
95 #define xmalloc_secure(a)  gcry_xmalloc_secure ((a))
96 #define xcalloc(a,b)     gcry_xcalloc ((a),(b))
97 #define xcalloc_secure(a,b) gcry_xcalloc_secure ((a),(b))
98 #define xrealloc(a,b)    gcry_xrealloc ((a),(b))
99 #define xstrdup(a)       gcry_xstrdup ((a))
100
101 /* For compatibility with gpg 1.4 we also define these: */
102 #define xmalloc_clear(a) gcry_xcalloc (1, (a))
103 #define xmalloc_secure_clear(a) gcry_xcalloc_secure (1, (a))
104
105 /* The default error source of the application.  This is different
106    from GPG_ERR_SOURCE_DEFAULT in that it does not depend on the
107    source file and thus is usable in code shared by applications.
108    Defined by init.c.  */
109 extern gpg_err_source_t default_errsource;
110
111 /* Convenience function to return a gpg-error code for memory
112    allocation failures.  This function makes sure that an error will
113    be returned even if accidently ERRNO is not set.  */
114 static inline gpg_error_t
115 out_of_core (void)
116 {
117   return gpg_error_from_syserror ();
118 }
119
120
121 /*-- signal.c --*/
122 void gnupg_init_signals (int mode, void (*fast_cleanup)(void));
123 void gnupg_block_all_signals (void);
124 void gnupg_unblock_all_signals (void);
125
126 /*-- yesno.c --*/
127 int answer_is_yes (const char *s);
128 int answer_is_yes_no_default (const char *s, int def_answer);
129 int answer_is_yes_no_quit (const char *s);
130 int answer_is_okay_cancel (const char *s, int def_answer);
131
132 /*-- xreadline.c --*/
133 ssize_t read_line (FILE *fp,
134                    char **addr_of_buffer, size_t *length_of_buffer,
135                    size_t *max_length);
136
137
138 /*-- b64enc.c and b64dec.c --*/
139 struct b64state
140 {
141   unsigned int flags;
142   int idx;
143   int quad_count;
144   FILE *fp;
145   estream_t stream;
146   char *title;
147   unsigned char radbuf[4];
148   u32 crc;
149   int stop_seen:1;
150   int invalid_encoding:1;
151   gpg_error_t lasterr;
152 };
153
154 gpg_error_t b64enc_start (struct b64state *state, FILE *fp, const char *title);
155 gpg_error_t b64enc_start_es (struct b64state *state, estream_t fp,
156                              const char *title);
157 gpg_error_t b64enc_write (struct b64state *state,
158                           const void *buffer, size_t nbytes);
159 gpg_error_t b64enc_finish (struct b64state *state);
160
161 gpg_error_t b64dec_start (struct b64state *state, const char *title);
162 gpg_error_t b64dec_proc (struct b64state *state, void *buffer, size_t length,
163                          size_t *r_nbytes);
164 gpg_error_t b64dec_finish (struct b64state *state);
165
166
167 /*-- zb32.c --*/
168 char *zb32_encode (const void *data, unsigned int databits);
169
170
171 /*-- sexputil.c */
172 char *canon_sexp_to_string (const unsigned char *canon, size_t canonlen);
173 void log_printcanon (const char *text,
174                      const unsigned char *sexp, size_t sexplen);
175 void log_printsexp (const char *text, gcry_sexp_t sexp);
176
177 gpg_error_t make_canon_sexp (gcry_sexp_t sexp,
178                              unsigned char **r_buffer, size_t *r_buflen);
179 gpg_error_t make_canon_sexp_pad (gcry_sexp_t sexp, int secure,
180                                  unsigned char **r_buffer, size_t *r_buflen);
181 gpg_error_t keygrip_from_canon_sexp (const unsigned char *key, size_t keylen,
182                                      unsigned char *grip);
183 int cmp_simple_canon_sexp (const unsigned char *a, const unsigned char *b);
184 unsigned char *make_simple_sexp_from_hexstr (const char *line,
185                                              size_t *nscanned);
186 int hash_algo_from_sigval (const unsigned char *sigval);
187 unsigned char *make_canon_sexp_from_rsa_pk (const void *m, size_t mlen,
188                                             const void *e, size_t elen,
189                                             size_t *r_len);
190 gpg_error_t get_rsa_pk_from_canon_sexp (const unsigned char *keydata,
191                                         size_t keydatalen,
192                                         unsigned char const **r_n,
193                                         size_t *r_nlen,
194                                         unsigned char const **r_e,
195                                         size_t *r_elen);
196 gpg_error_t get_pk_algo_from_canon_sexp (const unsigned char *keydata,
197                                          size_t keydatalen,
198                                          const char **r_algo);
199
200 /*-- convert.c --*/
201 int hex2bin (const char *string, void *buffer, size_t length);
202 int hexcolon2bin (const char *string, void *buffer, size_t length);
203 char *bin2hex (const void *buffer, size_t length, char *stringbuf);
204 char *bin2hexcolon (const void *buffer, size_t length, char *stringbuf);
205 const char *hex2str (const char *hexstring,
206                      char *buffer, size_t bufsize, size_t *buflen);
207 char *hex2str_alloc (const char *hexstring, size_t *r_count);
208
209 /*-- percent.c --*/
210 char *percent_plus_escape (const char *string);
211 char *percent_plus_unescape (const char *string, int nulrepl);
212 char *percent_unescape (const char *string, int nulrepl);
213
214 size_t percent_plus_unescape_inplace (char *string, int nulrepl);
215 size_t percent_unescape_inplace (char *string, int nulrepl);
216
217 /*-- openpgp-oid.c --*/
218 gpg_error_t openpgp_oid_from_str (const char *string, gcry_mpi_t *r_mpi);
219 char *openpgp_oid_to_str (gcry_mpi_t a);
220 int openpgp_oid_is_ed25519 (gcry_mpi_t a);
221 const char *openpgp_curve_to_oid (const char *name, unsigned int *r_nbits);
222 const char *openpgp_oid_to_curve (const char *oid);
223
224
225
226 /*-- homedir.c --*/
227 const char *standard_homedir (void);
228 const char *default_homedir (void);
229 const char *gnupg_sysconfdir (void);
230 const char *gnupg_bindir (void);
231 const char *gnupg_libexecdir (void);
232 const char *gnupg_libdir (void);
233 const char *gnupg_datadir (void);
234 const char *gnupg_localedir (void);
235 const char *gnupg_cachedir (void);
236 const char *dirmngr_sys_socket_name (void);
237 const char *dirmngr_user_socket_name (void);
238
239 /* All module names.  We also include gpg and gpgsm for the sake for
240    gpgconf. */
241 #define GNUPG_MODULE_NAME_AGENT        1
242 #define GNUPG_MODULE_NAME_PINENTRY     2
243 #define GNUPG_MODULE_NAME_SCDAEMON     3
244 #define GNUPG_MODULE_NAME_DIRMNGR      4
245 #define GNUPG_MODULE_NAME_PROTECT_TOOL 5
246 #define GNUPG_MODULE_NAME_CHECK_PATTERN 6
247 #define GNUPG_MODULE_NAME_GPGSM         7
248 #define GNUPG_MODULE_NAME_GPG           8
249 #define GNUPG_MODULE_NAME_CONNECT_AGENT 9
250 #define GNUPG_MODULE_NAME_GPGCONF       10
251 #define GNUPG_MODULE_NAME_DIRMNGR_LDAP  11
252 const char *gnupg_module_name (int which);
253
254
255
256 /*-- gpgrlhelp.c --*/
257 void gnupg_rl_initialize (void);
258
259 /*-- helpfile.c --*/
260 char *gnupg_get_help_string (const char *key, int only_current_locale);
261
262 /*-- localename.c --*/
263 const char *gnupg_messages_locale_name (void);
264
265 /*-- miscellaneous.c --*/
266
267 /* This function is called at startup to tell libgcrypt to use our own
268    logging subsystem. */
269 void setup_libgcrypt_logging (void);
270
271 /* Same as estream_asprintf but die on memory failure.  */
272 char *xasprintf (const char *fmt, ...) JNLIB_GCC_A_PRINTF(1,2);
273 /* This is now an alias to estream_asprintf.  */
274 char *xtryasprintf (const char *fmt, ...) JNLIB_GCC_A_PRINTF(1,2);
275
276 /* Replacement for gcry_cipher_algo_name.  */
277 const char *gnupg_cipher_algo_name (int algo);
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 int gnupg_compare_version (const char *a, const char *b);
292
293
294 /*-- Simple replacement functions. */
295
296 /* We use the gnupg_ttyname macro to be safe not to run into conflicts
297    which an extisting but broken ttyname.  */
298 #if !defined(HAVE_TTYNAME) || defined(HAVE_BROKEN_TTYNAME)
299 # define gnupg_ttyname(n) _gnupg_ttyname ((n))
300 /* Systems without ttyname (W32) will merely return NULL. */
301 static inline char *
302 _gnupg_ttyname (int fd)
303 {
304   (void)fd;
305   return NULL;
306 }
307 #else /*HAVE_TTYNAME*/
308 # define gnupg_ttyname(n) ttyname ((n))
309 #endif /*HAVE_TTYNAME */
310
311 #ifdef HAVE_W32CE_SYSTEM
312 #define getpid() GetCurrentProcessId ()
313 char *_gnupg_getenv (const char *name); /* See sysutils.c */
314 #define getenv(a)  _gnupg_getenv ((a))
315 char *_gnupg_setenv (const char *name); /* See sysutils.c */
316 #define setenv(a,b,c)  _gnupg_setenv ((a),(b),(c))
317 int _gnupg_isatty (int fd);
318 #define gnupg_isatty(a)  _gnupg_isatty ((a))
319 #else
320 #define gnupg_isatty(a)  isatty ((a))
321 #endif
322
323
324
325 /*-- Macros to replace ctype ones to avoid locale problems. --*/
326 #define spacep(p)   (*(p) == ' ' || *(p) == '\t')
327 #define digitp(p)   (*(p) >= '0' && *(p) <= '9')
328 #define hexdigitp(a) (digitp (a)                     \
329                       || (*(a) >= 'A' && *(a) <= 'F')  \
330                       || (*(a) >= 'a' && *(a) <= 'f'))
331   /* Note this isn't identical to a C locale isspace() without \f and
332      \v, but works for the purposes used here. */
333 #define ascii_isspace(a) ((a)==' ' || (a)=='\n' || (a)=='\r' || (a)=='\t')
334
335 /* The atoi macros assume that the buffer has only valid digits. */
336 #define atoi_1(p)   (*(p) - '0' )
337 #define atoi_2(p)   ((atoi_1(p) * 10) + atoi_1((p)+1))
338 #define atoi_4(p)   ((atoi_2(p) * 100) + atoi_2((p)+2))
339 #define xtoi_1(p)   (*(p) <= '9'? (*(p)- '0'): \
340                      *(p) <= 'F'? (*(p)-'A'+10):(*(p)-'a'+10))
341 #define xtoi_2(p)   ((xtoi_1(p) * 16) + xtoi_1((p)+1))
342 #define xtoi_4(p)   ((xtoi_2(p) * 256) + xtoi_2((p)+2))
343
344
345 /*-- Forward declaration of the commonly used server control structure.  */
346 /*   (We need it here as it is used by some callback prototypes.) */
347 struct server_control_s;
348 typedef struct server_control_s *ctrl_t;
349
350
351 #endif /*GNUPG_COMMON_UTIL_H*/