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