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