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