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