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