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