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