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