scd: Do not conflict if a card with another serialno is demanded.
[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 and/or modify this
7  * part of GnuPG 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  * GnuPG 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 <https://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 and estream. */
37
38 /* These error codes are used but not defined in the required
39  * libgpg-error version.  Define them here.
40  * Example: (#if GPG_ERROR_VERSION_NUMBER < 0x011500 // 1.21)
41  */
42 #if GPG_ERROR_VERSION_NUMBER < 0x012400 /* 1.36 */
43 #define GPG_ERR_NO_AUTH   314
44 #define GPG_ERR_BAD_AUTH  315
45 #endif /*GPG_ERROR_VERSION_NUMBER*/
46
47 /* Hash function used with libksba. */
48 #define HASH_FNC ((void (*)(void *, const void*,size_t))gcry_md_write)
49
50 /* The length of the keygrip.  This is a SHA-1 hash of the key
51  * parameters as generated by gcry_pk_get_keygrip.  */
52 #define KEYGRIP_LEN 20
53
54
55 /* Get all the stuff from jnlib. */
56 #include "../common/logging.h"
57 #include "../common/argparse.h"
58 #include "../common/stringhelp.h"
59 #include "../common/mischelp.h"
60 #include "../common/strlist.h"
61 #include "../common/dotlock.h"
62 #include "../common/utf8conv.h"
63 #include "../common/dynload.h"
64 #include "../common/fwddecl.h"
65 #include "../common/utilproto.h"
66
67 #include "gettime.h"
68
69 /* Redefine asprintf by our estream version which uses our own memory
70    allocator..  */
71 #define asprintf gpgrt_asprintf
72 #define vasprintf gpgrt_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 gpgrt_snprintf
78
79
80 /* Replacements for macros not available with libgpg-error < 1.20.  */
81
82 /* We need this type even if we are not using libreadline and or we
83    did not include libreadline in the current file. */
84 #ifndef GNUPG_LIBREADLINE_H_INCLUDED
85 typedef char **rl_completion_func_t (const char *, int, int);
86 #endif /*!GNUPG_LIBREADLINE_H_INCLUDED*/
87
88
89 /* Handy malloc macros - please use only them. */
90 #define xtrymalloc(a)    gcry_malloc ((a))
91 #define xtrymalloc_secure(a)  gcry_malloc_secure ((a))
92 #define xtrycalloc(a,b)  gcry_calloc ((a),(b))
93 #define xtrycalloc_secure(a,b)  gcry_calloc_secure ((a),(b))
94 #define xtryrealloc(a,b) gcry_realloc ((a),(b))
95 #define xtrystrdup(a)    gcry_strdup ((a))
96 #define xfree(a)         gcry_free ((a))
97 #define xfree_fnc        gcry_free
98
99 #define xmalloc(a)       gcry_xmalloc ((a))
100 #define xmalloc_secure(a)  gcry_xmalloc_secure ((a))
101 #define xcalloc(a,b)     gcry_xcalloc ((a),(b))
102 #define xcalloc_secure(a,b) gcry_xcalloc_secure ((a),(b))
103 #define xrealloc(a,b)    gcry_xrealloc ((a),(b))
104 #define xstrdup(a)       gcry_xstrdup ((a))
105
106 /* For compatibility with gpg 1.4 we also define these: */
107 #define xmalloc_clear(a) gcry_xcalloc (1, (a))
108 #define xmalloc_secure_clear(a) gcry_xcalloc_secure (1, (a))
109
110 /* The default error source of the application.  This is different
111    from GPG_ERR_SOURCE_DEFAULT in that it does not depend on the
112    source file and thus is usable in code shared by applications.
113    Defined by init.c.  */
114 extern gpg_err_source_t default_errsource;
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 accidentally 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 /*-- yesno.c --*/
127 int answer_is_yes (const char *s);
128 int answer_is_yes_no_default (const char *s, int def_answer);
129 int answer_is_yes_no_quit (const char *s);
130 int answer_is_okay_cancel (const char *s, int def_answer);
131
132 /*-- xreadline.c --*/
133 ssize_t read_line (FILE *fp,
134                    char **addr_of_buffer, size_t *length_of_buffer,
135                    size_t *max_length);
136
137
138 /*-- b64enc.c and b64dec.c --*/
139 struct b64state
140 {
141   unsigned int flags;
142   int idx;
143   int quad_count;
144   FILE *fp;
145   estream_t stream;
146   char *title;
147   unsigned char radbuf[4];
148   u32 crc;
149   int stop_seen:1;
150   int invalid_encoding:1;
151   gpg_error_t lasterr;
152 };
153
154 gpg_error_t b64enc_start (struct b64state *state, FILE *fp, const char *title);
155 gpg_error_t b64enc_start_es (struct b64state *state, estream_t fp,
156                              const char *title);
157 gpg_error_t b64enc_write (struct b64state *state,
158                           const void *buffer, size_t nbytes);
159 gpg_error_t b64enc_finish (struct b64state *state);
160
161 gpg_error_t b64dec_start (struct b64state *state, const char *title);
162 gpg_error_t b64dec_proc (struct b64state *state, void *buffer, size_t length,
163                          size_t *r_nbytes);
164 gpg_error_t b64dec_finish (struct b64state *state);
165
166 /*-- sexputil.c */
167 char *canon_sexp_to_string (const unsigned char *canon, size_t canonlen);
168 void log_printcanon (const char *text,
169                      const unsigned char *sexp, size_t sexplen);
170 void log_printsexp (const char *text, gcry_sexp_t sexp);
171
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
192 int get_pk_algo_from_key (gcry_sexp_t key);
193 int get_pk_algo_from_canon_sexp (const unsigned char *keydata,
194                                  size_t keydatalen);
195 char *pubkey_algo_string (gcry_sexp_t s_pkey, enum gcry_pk_algos *r_algoid);
196
197 /*-- convert.c --*/
198 int hex2bin (const char *string, void *buffer, size_t length);
199 int hexcolon2bin (const char *string, void *buffer, size_t length);
200 char *bin2hex (const void *buffer, size_t length, char *stringbuf);
201 char *bin2hexcolon (const void *buffer, size_t length, char *stringbuf);
202 const char *hex2str (const char *hexstring,
203                      char *buffer, size_t bufsize, size_t *buflen);
204 char *hex2str_alloc (const char *hexstring, size_t *r_count);
205
206 /*-- percent.c --*/
207 char *percent_plus_escape (const char *string);
208 char *percent_data_escape (int plus, const char *prefix,
209                            const void *data, size_t datalen);
210 char *percent_plus_unescape (const char *string, int nulrepl);
211 char *percent_unescape (const char *string, int nulrepl);
212
213 size_t percent_plus_unescape_inplace (char *string, int nulrepl);
214 size_t percent_unescape_inplace (char *string, int nulrepl);
215
216 /*-- openpgp-oid.c --*/
217 gpg_error_t openpgp_oid_from_str (const char *string, gcry_mpi_t *r_mpi);
218 char *openpgp_oidbuf_to_str (const unsigned char *buf, size_t len);
219 char *openpgp_oid_to_str (gcry_mpi_t a);
220 int openpgp_oidbuf_is_ed25519 (const void *buf, size_t len);
221 int openpgp_oid_is_ed25519 (gcry_mpi_t a);
222 int openpgp_oidbuf_is_cv25519 (const void *buf, size_t len);
223 int openpgp_oid_is_cv25519 (gcry_mpi_t a);
224 const char *openpgp_curve_to_oid (const char *name, unsigned int *r_nbits);
225 const char *openpgp_oid_to_curve (const char *oid, int canon);
226 const char *openpgp_enum_curves (int *idxp);
227 const char *openpgp_is_curve_supported (const char *name,
228                                         int *r_algo, unsigned int *r_nbits);
229
230
231 /*-- homedir.c --*/
232 const char *standard_homedir (void);
233 const char *default_homedir (void);
234 void gnupg_set_homedir (const char *newdir);
235 const char *gnupg_homedir (void);
236 int gnupg_default_homedir_p (void);
237 const char *gnupg_daemon_rootdir (void);
238 const char *gnupg_socketdir (void);
239 const char *gnupg_sysconfdir (void);
240 const char *gnupg_bindir (void);
241 const char *gnupg_libexecdir (void);
242 const char *gnupg_libdir (void);
243 const char *gnupg_datadir (void);
244 const char *gnupg_localedir (void);
245 const char *gnupg_cachedir (void);
246 const char *dirmngr_socket_name (void);
247
248 char *_gnupg_socketdir_internal (int skip_checks, unsigned *r_info);
249
250 /* All module names.  We also include gpg and gpgsm for the sake for
251    gpgconf. */
252 #define GNUPG_MODULE_NAME_AGENT        1
253 #define GNUPG_MODULE_NAME_PINENTRY     2
254 #define GNUPG_MODULE_NAME_SCDAEMON     3
255 #define GNUPG_MODULE_NAME_DIRMNGR      4
256 #define GNUPG_MODULE_NAME_PROTECT_TOOL 5
257 #define GNUPG_MODULE_NAME_CHECK_PATTERN 6
258 #define GNUPG_MODULE_NAME_GPGSM         7
259 #define GNUPG_MODULE_NAME_GPG           8
260 #define GNUPG_MODULE_NAME_CONNECT_AGENT 9
261 #define GNUPG_MODULE_NAME_GPGCONF       10
262 #define GNUPG_MODULE_NAME_DIRMNGR_LDAP  11
263 #define GNUPG_MODULE_NAME_GPGV          12
264 const char *gnupg_module_name (int which);
265 void gnupg_module_name_flush_some (void);
266 void gnupg_set_builddir (const char *newdir);
267
268
269 /* A list of constants to identify protocols.  This is used by tools
270  * which need to distinguish between the different protocols
271  * implemented by GnuPG.  May be used as bit flags.  */
272 #define GNUPG_PROTOCOL_OPENPGP    1   /* The one and only (gpg).      */
273 #define GNUPG_PROTOCOL_CMS        2   /* The core of S/MIME (gpgsm)   */
274 #define GNUPG_PROTOCOL_SSH_AGENT  4   /* Out ssh-agent implementation */
275
276
277 /*-- gpgrlhelp.c --*/
278 void gnupg_rl_initialize (void);
279
280 /*-- helpfile.c --*/
281 char *gnupg_get_help_string (const char *key, int only_current_locale);
282
283 /*-- localename.c --*/
284 const char *gnupg_messages_locale_name (void);
285
286 /*-- miscellaneous.c --*/
287
288 /* This function is called at startup to tell libgcrypt to use our own
289    logging subsystem. */
290 void setup_libgcrypt_logging (void);
291
292 /* Print an out of core message and die.  */
293 void xoutofcore (void);
294
295 /* Same as estream_asprintf but die on memory failure.  */
296 char *xasprintf (const char *fmt, ...) GPGRT_ATTR_PRINTF(1,2);
297 /* This is now an alias to estream_asprintf.  */
298 char *xtryasprintf (const char *fmt, ...) GPGRT_ATTR_PRINTF(1,2);
299
300 /* Replacement for gcry_cipher_algo_name.  */
301 const char *gnupg_cipher_algo_name (int algo);
302
303 void obsolete_option (const char *configname, unsigned int configlineno,
304                       const char *name);
305
306 const char *print_fname_stdout (const char *s);
307 const char *print_fname_stdin (const char *s);
308 void print_utf8_buffer3 (estream_t fp, const void *p, size_t n,
309                          const char *delim);
310 void print_utf8_buffer2 (estream_t fp, const void *p, size_t n, int delim);
311 void print_utf8_buffer (estream_t fp, const void *p, size_t n);
312 void print_utf8_string (estream_t stream, const char *p);
313 void print_hexstring (FILE *fp, const void *buffer, size_t length,
314                       int reserved);
315 char *try_make_printable_string (const void *p, size_t n, int delim);
316 char *make_printable_string (const void *p, size_t n, int delim);
317 char *decode_c_string (const char *src);
318
319 int is_file_compressed (const char *s, int *ret_rc);
320
321 int match_multistr (const char *multistr,const char *match);
322
323 int gnupg_compare_version (const char *a, const char *b);
324
325 struct debug_flags_s
326 {
327   unsigned int flag;
328   const char *name;
329 };
330 int parse_debug_flag (const char *string, unsigned int *debugvar,
331                       const struct debug_flags_s *flags);
332
333
334 /*-- Simple replacement functions. */
335
336 /* We use the gnupg_ttyname macro to be safe not to run into conflicts
337    which an extisting but broken ttyname.  */
338 #if !defined(HAVE_TTYNAME) || defined(HAVE_BROKEN_TTYNAME)
339 # define gnupg_ttyname(n) _gnupg_ttyname ((n))
340 /* Systems without ttyname (W32) will merely return NULL. */
341 static inline char *
342 _gnupg_ttyname (int fd)
343 {
344   (void)fd;
345   return NULL;
346 }
347 #else /*HAVE_TTYNAME*/
348 # define gnupg_ttyname(n) ttyname ((n))
349 #endif /*HAVE_TTYNAME */
350
351 #ifdef HAVE_W32CE_SYSTEM
352 #define getpid() GetCurrentProcessId ()
353 char *_gnupg_getenv (const char *name); /* See sysutils.c */
354 #define getenv(a)  _gnupg_getenv ((a))
355 char *_gnupg_setenv (const char *name); /* See sysutils.c */
356 #define setenv(a,b,c)  _gnupg_setenv ((a),(b),(c))
357 int _gnupg_isatty (int fd);
358 #define gnupg_isatty(a)  _gnupg_isatty ((a))
359 #else
360 #define gnupg_isatty(a)  isatty ((a))
361 #endif
362
363
364
365 /*-- Macros to replace ctype ones to avoid locale problems. --*/
366 #define spacep(p)   (*(p) == ' ' || *(p) == '\t')
367 #define digitp(p)   (*(p) >= '0' && *(p) <= '9')
368 #define alphap(p)   ((*(p) >= 'A' && *(p) <= 'Z')       \
369                      || (*(p) >= 'a' && *(p) <= 'z'))
370 #define alnump(p)   (alphap (p) || digitp (p))
371 #define hexdigitp(a) (digitp (a)                     \
372                       || (*(a) >= 'A' && *(a) <= 'F')  \
373                       || (*(a) >= 'a' && *(a) <= 'f'))
374   /* Note this isn't identical to a C locale isspace() without \f and
375      \v, but works for the purposes used here. */
376 #define ascii_isspace(a) ((a)==' ' || (a)=='\n' || (a)=='\r' || (a)=='\t')
377
378 /* The atoi macros assume that the buffer has only valid digits. */
379 #define atoi_1(p)   (*(p) - '0' )
380 #define atoi_2(p)   ((atoi_1(p) * 10) + atoi_1((p)+1))
381 #define atoi_4(p)   ((atoi_2(p) * 100) + atoi_2((p)+2))
382 #define xtoi_1(p)   (*(p) <= '9'? (*(p)- '0'): \
383                      *(p) <= 'F'? (*(p)-'A'+10):(*(p)-'a'+10))
384 #define xtoi_2(p)   ((xtoi_1(p) * 16) + xtoi_1((p)+1))
385 #define xtoi_4(p)   ((xtoi_2(p) * 256) + xtoi_2((p)+2))
386
387 #endif /*GNUPG_COMMON_UTIL_H*/