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