common: Remove JNLIB from boiler plate (jnlib merge).
[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 #if GPG_ERROR_VERSION_NUMBER < 0x011200  /* 1.18 */
41 # define GPG_ERR_LEGACY_KEY     222
42 # define GPG_ERR_OBJ_TERM_STATE 225
43 # define GPG_ERR_FORBIDDEN      251
44 #endif
45 #if GPG_ERROR_VERSION_NUMBER < 0x011300  /* 1.19 */
46 # define GPG_ERR_LDAP_GENERAL               721
47 # define GPG_ERR_LDAP_ATTR_GENERAL          722
48 # define GPG_ERR_LDAP_NAME_GENERAL          723
49 # define GPG_ERR_LDAP_SECURITY_GENERAL      724
50 # define GPG_ERR_LDAP_SERVICE_GENERAL       725
51 # define GPG_ERR_LDAP_UPDATE_GENERAL        726
52 # define GPG_ERR_LDAP_E_GENERAL             727
53 # define GPG_ERR_LDAP_X_GENERAL             728
54 # define GPG_ERR_LDAP_OTHER_GENERAL         729
55 # define GPG_ERR_LDAP_X_CONNECTING          750
56 # define GPG_ERR_LDAP_REFERRAL_LIMIT        751
57 # define GPG_ERR_LDAP_CLIENT_LOOP           752
58 # define GPG_ERR_LDAP_NO_RESULTS            754
59 # define GPG_ERR_LDAP_CONTROL_NOT_FOUND     755
60 # define GPG_ERR_LDAP_NOT_SUPPORTED         756
61 # define GPG_ERR_LDAP_CONNECT               757
62 # define GPG_ERR_LDAP_NO_MEMORY             758
63 # define GPG_ERR_LDAP_PARAM                 759
64 # define GPG_ERR_LDAP_USER_CANCELLED        760
65 # define GPG_ERR_LDAP_FILTER                761
66 # define GPG_ERR_LDAP_AUTH_UNKNOWN          762
67 # define GPG_ERR_LDAP_TIMEOUT               763
68 # define GPG_ERR_LDAP_DECODING              764
69 # define GPG_ERR_LDAP_ENCODING              765
70 # define GPG_ERR_LDAP_LOCAL                 766
71 # define GPG_ERR_LDAP_SERVER_DOWN           767
72 # define GPG_ERR_LDAP_SUCCESS               768
73 # define GPG_ERR_LDAP_OPERATIONS            769
74 # define GPG_ERR_LDAP_PROTOCOL              770
75 # define GPG_ERR_LDAP_TIMELIMIT             771
76 # define GPG_ERR_LDAP_SIZELIMIT             772
77 # define GPG_ERR_LDAP_COMPARE_FALSE         773
78 # define GPG_ERR_LDAP_COMPARE_TRUE          774
79 # define GPG_ERR_LDAP_UNSUPPORTED_AUTH      775
80 # define GPG_ERR_LDAP_STRONG_AUTH_RQRD      776
81 # define GPG_ERR_LDAP_PARTIAL_RESULTS       777
82 # define GPG_ERR_LDAP_REFERRAL              778
83 # define GPG_ERR_LDAP_ADMINLIMIT            779
84 # define GPG_ERR_LDAP_UNAVAIL_CRIT_EXTN     780
85 # define GPG_ERR_LDAP_CONFIDENT_RQRD        781
86 # define GPG_ERR_LDAP_SASL_BIND_INPROG      782
87 # define GPG_ERR_LDAP_NO_SUCH_ATTRIBUTE     784
88 # define GPG_ERR_LDAP_UNDEFINED_TYPE        785
89 # define GPG_ERR_LDAP_BAD_MATCHING          786
90 # define GPG_ERR_LDAP_CONST_VIOLATION       787
91 # define GPG_ERR_LDAP_TYPE_VALUE_EXISTS     788
92 # define GPG_ERR_LDAP_INV_SYNTAX            789
93 # define GPG_ERR_LDAP_NO_SUCH_OBJ           800
94 # define GPG_ERR_LDAP_ALIAS_PROBLEM         801
95 # define GPG_ERR_LDAP_INV_DN_SYNTAX         802
96 # define GPG_ERR_LDAP_IS_LEAF               803
97 # define GPG_ERR_LDAP_ALIAS_DEREF           804
98 # define GPG_ERR_LDAP_X_PROXY_AUTH_FAIL     815
99 # define GPG_ERR_LDAP_BAD_AUTH              816
100 # define GPG_ERR_LDAP_INV_CREDENTIALS       817
101 # define GPG_ERR_LDAP_INSUFFICIENT_ACC      818
102 # define GPG_ERR_LDAP_BUSY                  819
103 # define GPG_ERR_LDAP_UNAVAILABLE           820
104 # define GPG_ERR_LDAP_UNWILL_TO_PERFORM     821
105 # define GPG_ERR_LDAP_LOOP_DETECT           822
106 # define GPG_ERR_LDAP_NAMING_VIOLATION      832
107 # define GPG_ERR_LDAP_OBJ_CLS_VIOLATION     833
108 # define GPG_ERR_LDAP_NOT_ALLOW_NONLEAF     834
109 # define GPG_ERR_LDAP_NOT_ALLOW_ON_RDN      835
110 # define GPG_ERR_LDAP_ALREADY_EXISTS        836
111 # define GPG_ERR_LDAP_NO_OBJ_CLASS_MODS     837
112 # define GPG_ERR_LDAP_RESULTS_TOO_LARGE     838
113 # define GPG_ERR_LDAP_AFFECTS_MULT_DSAS     839
114 # define GPG_ERR_LDAP_VLV                   844
115 # define GPG_ERR_LDAP_OTHER                 848
116 # define GPG_ERR_LDAP_CUP_RESOURCE_LIMIT    881
117 # define GPG_ERR_LDAP_CUP_SEC_VIOLATION     882
118 # define GPG_ERR_LDAP_CUP_INV_DATA          883
119 # define GPG_ERR_LDAP_CUP_UNSUP_SCHEME      884
120 # define GPG_ERR_LDAP_CUP_RELOAD            885
121 # define GPG_ERR_LDAP_CANCELLED             886
122 # define GPG_ERR_LDAP_NO_SUCH_OPERATION     887
123 # define GPG_ERR_LDAP_TOO_LATE              888
124 # define GPG_ERR_LDAP_CANNOT_CANCEL         889
125 # define GPG_ERR_LDAP_ASSERTION_FAILED      890
126 # define GPG_ERR_LDAP_PROX_AUTH_DENIED      891
127 #endif /*GPG_ERROR_VERSION_NUMBER < 0x011300*/
128
129 /* Hash function used with libksba. */
130 #define HASH_FNC ((void (*)(void *, const void*,size_t))gcry_md_write)
131
132 /* Get all the stuff from jnlib. */
133 #include "../common/logging.h"
134 #include "../common/argparse.h"
135 #include "../common/stringhelp.h"
136 #include "../common/mischelp.h"
137 #include "../common/strlist.h"
138 #include "../common/dotlock.h"
139 #include "../common/utf8conv.h"
140 #include "../common/dynload.h"
141
142 #include "gettime.h"
143
144 /* Redefine asprintf by our estream version which uses our own memory
145    allocator..  */
146 #define asprintf gpgrt_asprintf
147 #define vasprintf gpgrt_vasprintf
148
149 /* Due to a bug in mingw32's snprintf related to the 'l' modifier and
150    for increased portability we use our snprintf on all systems. */
151 #undef snprintf
152 #define snprintf gpgrt_snprintf
153
154
155 /* GCC attributes.  */
156 #if __GNUC__ >= 4
157 # define GNUPG_GCC_A_SENTINEL(a) __attribute__ ((sentinel(a)))
158 #else
159 # define GNUPG_GCC_A_SENTINEL(a)
160 #endif
161
162 #if __GNUC__ >= 4
163 # define GNUPG_GCC_A_USED __attribute__ ((used))
164 #else
165 # define GNUPG_GCC_A_USED
166 #endif
167
168
169 /* We need this type even if we are not using libreadline and or we
170    did not include libreadline in the current file. */
171 #ifndef GNUPG_LIBREADLINE_H_INCLUDED
172 typedef char **rl_completion_func_t (const char *, int, int);
173 #endif /*!GNUPG_LIBREADLINE_H_INCLUDED*/
174
175
176 /* Handy malloc macros - please use only them. */
177 #define xtrymalloc(a)    gcry_malloc ((a))
178 #define xtrymalloc_secure(a)  gcry_malloc_secure ((a))
179 #define xtrycalloc(a,b)  gcry_calloc ((a),(b))
180 #define xtrycalloc_secure(a,b)  gcry_calloc_secure ((a),(b))
181 #define xtryrealloc(a,b) gcry_realloc ((a),(b))
182 #define xtrystrdup(a)    gcry_strdup ((a))
183 #define xfree(a)         gcry_free ((a))
184 #define xfree_fnc        gcry_free
185
186 #define xmalloc(a)       gcry_xmalloc ((a))
187 #define xmalloc_secure(a)  gcry_xmalloc_secure ((a))
188 #define xcalloc(a,b)     gcry_xcalloc ((a),(b))
189 #define xcalloc_secure(a,b) gcry_xcalloc_secure ((a),(b))
190 #define xrealloc(a,b)    gcry_xrealloc ((a),(b))
191 #define xstrdup(a)       gcry_xstrdup ((a))
192
193 /* For compatibility with gpg 1.4 we also define these: */
194 #define xmalloc_clear(a) gcry_xcalloc (1, (a))
195 #define xmalloc_secure_clear(a) gcry_xcalloc_secure (1, (a))
196
197 /* The default error source of the application.  This is different
198    from GPG_ERR_SOURCE_DEFAULT in that it does not depend on the
199    source file and thus is usable in code shared by applications.
200    Defined by init.c.  */
201 extern gpg_err_source_t default_errsource;
202
203 /* Convenience function to return a gpg-error code for memory
204    allocation failures.  This function makes sure that an error will
205    be returned even if accidently ERRNO is not set.  */
206 static inline gpg_error_t
207 out_of_core (void)
208 {
209   return gpg_error_from_syserror ();
210 }
211
212
213 /*-- signal.c --*/
214 void gnupg_init_signals (int mode, void (*fast_cleanup)(void));
215 void gnupg_block_all_signals (void);
216 void gnupg_unblock_all_signals (void);
217
218 /*-- yesno.c --*/
219 int answer_is_yes (const char *s);
220 int answer_is_yes_no_default (const char *s, int def_answer);
221 int answer_is_yes_no_quit (const char *s);
222 int answer_is_okay_cancel (const char *s, int def_answer);
223
224 /*-- xreadline.c --*/
225 ssize_t read_line (FILE *fp,
226                    char **addr_of_buffer, size_t *length_of_buffer,
227                    size_t *max_length);
228
229
230 /*-- b64enc.c and b64dec.c --*/
231 struct b64state
232 {
233   unsigned int flags;
234   int idx;
235   int quad_count;
236   FILE *fp;
237   estream_t stream;
238   char *title;
239   unsigned char radbuf[4];
240   u32 crc;
241   int stop_seen:1;
242   int invalid_encoding:1;
243   gpg_error_t lasterr;
244 };
245
246 gpg_error_t b64enc_start (struct b64state *state, FILE *fp, const char *title);
247 gpg_error_t b64enc_start_es (struct b64state *state, estream_t fp,
248                              const char *title);
249 gpg_error_t b64enc_write (struct b64state *state,
250                           const void *buffer, size_t nbytes);
251 gpg_error_t b64enc_finish (struct b64state *state);
252
253 gpg_error_t b64dec_start (struct b64state *state, const char *title);
254 gpg_error_t b64dec_proc (struct b64state *state, void *buffer, size_t length,
255                          size_t *r_nbytes);
256 gpg_error_t b64dec_finish (struct b64state *state);
257
258
259 /*-- zb32.c --*/
260 char *zb32_encode (const void *data, unsigned int databits);
261
262
263 /*-- sexputil.c */
264 char *canon_sexp_to_string (const unsigned char *canon, size_t canonlen);
265 void log_printcanon (const char *text,
266                      const unsigned char *sexp, size_t sexplen);
267 void log_printsexp (const char *text, gcry_sexp_t sexp);
268
269 gpg_error_t make_canon_sexp (gcry_sexp_t sexp,
270                              unsigned char **r_buffer, size_t *r_buflen);
271 gpg_error_t make_canon_sexp_pad (gcry_sexp_t sexp, int secure,
272                                  unsigned char **r_buffer, size_t *r_buflen);
273 gpg_error_t keygrip_from_canon_sexp (const unsigned char *key, size_t keylen,
274                                      unsigned char *grip);
275 int cmp_simple_canon_sexp (const unsigned char *a, const unsigned char *b);
276 unsigned char *make_simple_sexp_from_hexstr (const char *line,
277                                              size_t *nscanned);
278 int hash_algo_from_sigval (const unsigned char *sigval);
279 unsigned char *make_canon_sexp_from_rsa_pk (const void *m, size_t mlen,
280                                             const void *e, size_t elen,
281                                             size_t *r_len);
282 gpg_error_t get_rsa_pk_from_canon_sexp (const unsigned char *keydata,
283                                         size_t keydatalen,
284                                         unsigned char const **r_n,
285                                         size_t *r_nlen,
286                                         unsigned char const **r_e,
287                                         size_t *r_elen);
288 gpg_error_t get_pk_algo_from_canon_sexp (const unsigned char *keydata,
289                                          size_t keydatalen,
290                                          const char **r_algo);
291
292 /*-- convert.c --*/
293 int hex2bin (const char *string, void *buffer, size_t length);
294 int hexcolon2bin (const char *string, void *buffer, size_t length);
295 char *bin2hex (const void *buffer, size_t length, char *stringbuf);
296 char *bin2hexcolon (const void *buffer, size_t length, char *stringbuf);
297 const char *hex2str (const char *hexstring,
298                      char *buffer, size_t bufsize, size_t *buflen);
299 char *hex2str_alloc (const char *hexstring, size_t *r_count);
300
301 /*-- percent.c --*/
302 char *percent_plus_escape (const char *string);
303 char *percent_plus_unescape (const char *string, int nulrepl);
304 char *percent_unescape (const char *string, int nulrepl);
305
306 size_t percent_plus_unescape_inplace (char *string, int nulrepl);
307 size_t percent_unescape_inplace (char *string, int nulrepl);
308
309 /*-- openpgp-oid.c --*/
310 gpg_error_t openpgp_oid_from_str (const char *string, gcry_mpi_t *r_mpi);
311 char *openpgp_oid_to_str (gcry_mpi_t a);
312 int openpgp_oid_is_ed25519 (gcry_mpi_t a);
313 const char *openpgp_curve_to_oid (const char *name, unsigned int *r_nbits);
314 const char *openpgp_oid_to_curve (const char *oid);
315 const char *openpgp_enum_curves (int *idxp);
316
317
318
319 /*-- homedir.c --*/
320 const char *standard_homedir (void);
321 const char *default_homedir (void);
322 const char *gnupg_sysconfdir (void);
323 const char *gnupg_bindir (void);
324 const char *gnupg_libexecdir (void);
325 const char *gnupg_libdir (void);
326 const char *gnupg_datadir (void);
327 const char *gnupg_localedir (void);
328 const char *gnupg_cachedir (void);
329 const char *dirmngr_sys_socket_name (void);
330 const char *dirmngr_user_socket_name (void);
331
332 /* All module names.  We also include gpg and gpgsm for the sake for
333    gpgconf. */
334 #define GNUPG_MODULE_NAME_AGENT        1
335 #define GNUPG_MODULE_NAME_PINENTRY     2
336 #define GNUPG_MODULE_NAME_SCDAEMON     3
337 #define GNUPG_MODULE_NAME_DIRMNGR      4
338 #define GNUPG_MODULE_NAME_PROTECT_TOOL 5
339 #define GNUPG_MODULE_NAME_CHECK_PATTERN 6
340 #define GNUPG_MODULE_NAME_GPGSM         7
341 #define GNUPG_MODULE_NAME_GPG           8
342 #define GNUPG_MODULE_NAME_CONNECT_AGENT 9
343 #define GNUPG_MODULE_NAME_GPGCONF       10
344 #define GNUPG_MODULE_NAME_DIRMNGR_LDAP  11
345 const char *gnupg_module_name (int which);
346 void gnupg_module_name_flush_some (void);
347
348
349
350 /*-- gpgrlhelp.c --*/
351 void gnupg_rl_initialize (void);
352
353 /*-- helpfile.c --*/
354 char *gnupg_get_help_string (const char *key, int only_current_locale);
355
356 /*-- localename.c --*/
357 const char *gnupg_messages_locale_name (void);
358
359 /*-- miscellaneous.c --*/
360
361 /* This function is called at startup to tell libgcrypt to use our own
362    logging subsystem. */
363 void setup_libgcrypt_logging (void);
364
365 /* Same as estream_asprintf but die on memory failure.  */
366 char *xasprintf (const char *fmt, ...) GPGRT_GCC_A_PRINTF(1,2);
367 /* This is now an alias to estream_asprintf.  */
368 char *xtryasprintf (const char *fmt, ...) GPGRT_GCC_A_PRINTF(1,2);
369
370 /* Replacement for gcry_cipher_algo_name.  */
371 const char *gnupg_cipher_algo_name (int algo);
372
373 const char *print_fname_stdout (const char *s);
374 const char *print_fname_stdin (const char *s);
375 void print_utf8_buffer3 (estream_t fp, const void *p, size_t n,
376                          const char *delim);
377 void print_utf8_buffer2 (estream_t fp, const void *p, size_t n, int delim);
378 void print_utf8_buffer (estream_t fp, const void *p, size_t n);
379 void print_hexstring (FILE *fp, const void *buffer, size_t length,
380                       int reserved);
381 char *make_printable_string (const void *p, size_t n, int delim);
382
383 int is_file_compressed (const char *s, int *ret_rc);
384
385 int match_multistr (const char *multistr,const char *match);
386
387 int gnupg_compare_version (const char *a, const char *b);
388
389
390 /*-- Simple replacement functions. */
391
392 /* We use the gnupg_ttyname macro to be safe not to run into conflicts
393    which an extisting but broken ttyname.  */
394 #if !defined(HAVE_TTYNAME) || defined(HAVE_BROKEN_TTYNAME)
395 # define gnupg_ttyname(n) _gnupg_ttyname ((n))
396 /* Systems without ttyname (W32) will merely return NULL. */
397 static inline char *
398 _gnupg_ttyname (int fd)
399 {
400   (void)fd;
401   return NULL;
402 }
403 #else /*HAVE_TTYNAME*/
404 # define gnupg_ttyname(n) ttyname ((n))
405 #endif /*HAVE_TTYNAME */
406
407 #ifdef HAVE_W32CE_SYSTEM
408 #define getpid() GetCurrentProcessId ()
409 char *_gnupg_getenv (const char *name); /* See sysutils.c */
410 #define getenv(a)  _gnupg_getenv ((a))
411 char *_gnupg_setenv (const char *name); /* See sysutils.c */
412 #define setenv(a,b,c)  _gnupg_setenv ((a),(b),(c))
413 int _gnupg_isatty (int fd);
414 #define gnupg_isatty(a)  _gnupg_isatty ((a))
415 #else
416 #define gnupg_isatty(a)  isatty ((a))
417 #endif
418
419
420
421 /*-- Macros to replace ctype ones to avoid locale problems. --*/
422 #define spacep(p)   (*(p) == ' ' || *(p) == '\t')
423 #define digitp(p)   (*(p) >= '0' && *(p) <= '9')
424 #define hexdigitp(a) (digitp (a)                     \
425                       || (*(a) >= 'A' && *(a) <= 'F')  \
426                       || (*(a) >= 'a' && *(a) <= 'f'))
427   /* Note this isn't identical to a C locale isspace() without \f and
428      \v, but works for the purposes used here. */
429 #define ascii_isspace(a) ((a)==' ' || (a)=='\n' || (a)=='\r' || (a)=='\t')
430
431 /* The atoi macros assume that the buffer has only valid digits. */
432 #define atoi_1(p)   (*(p) - '0' )
433 #define atoi_2(p)   ((atoi_1(p) * 10) + atoi_1((p)+1))
434 #define atoi_4(p)   ((atoi_2(p) * 100) + atoi_2((p)+2))
435 #define xtoi_1(p)   (*(p) <= '9'? (*(p)- '0'): \
436                      *(p) <= 'F'? (*(p)-'A'+10):(*(p)-'a'+10))
437 #define xtoi_2(p)   ((xtoi_1(p) * 16) + xtoi_1((p)+1))
438 #define xtoi_4(p)   ((xtoi_2(p) * 256) + xtoi_2((p)+2))
439
440
441 /*-- Forward declaration of the commonly used server control structure.  */
442 /*   (We need it here as it is used by some callback prototypes.) */
443 struct server_control_s;
444 typedef struct server_control_s *ctrl_t;
445
446
447 #endif /*GNUPG_COMMON_UTIL_H*/