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