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