1 /* util.h - Utility functions for GnuPG
2 * Copyright (C) 2001, 2002, 2003, 2004, 2009 Free Software Foundation, Inc.
4 * This file is part of GnuPG.
6 * GnuPG is free software; you can redistribute and/or modify this
7 * part of GnuPG under the terms of either
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.
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.
19 * or both in parallel, as here.
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.
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/>.
31 #ifndef GNUPG_COMMON_UTIL_H
32 #define GNUPG_COMMON_UTIL_H
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. */
38 /* These error codes might be used but not defined in the required
39 * libgpg-error version. Define them here.
40 * Example: (#if GPG_ERROR_VERSION_NUMBER < 0x011500 // 1.21)
42 #if GPG_ERROR_VERSION_NUMBER < 0x012400 /* 1.36 */
43 # define GPG_ERR_NO_AUTH 314
44 # define GPG_ERR_BAD_AUTH 315
47 #ifndef EXTERN_UNLESS_MAIN_MODULE
48 # if !defined (INCLUDED_BY_MAIN_MODULE)
49 # define EXTERN_UNLESS_MAIN_MODULE extern
51 # define EXTERN_UNLESS_MAIN_MODULE
55 /* Hash function used with libksba. */
56 #define HASH_FNC ((void (*)(void *, const void*,size_t))gcry_md_write)
58 /* The length of the keygrip. This is a SHA-1 hash of the key
59 * parameters as generated by gcry_pk_get_keygrip. */
60 #define KEYGRIP_LEN 20
63 /* Get all the stuff from jnlib. */
64 #include "../common/logging.h"
65 #include "../common/argparse.h"
66 #include "../common/stringhelp.h"
67 #include "../common/mischelp.h"
68 #include "../common/strlist.h"
69 #include "../common/dotlock.h"
70 #include "../common/utf8conv.h"
71 #include "../common/dynload.h"
72 #include "../common/fwddecl.h"
73 #include "../common/utilproto.h"
77 /* Redefine asprintf by our estream version which uses our own memory
79 #define asprintf gpgrt_asprintf
80 #define vasprintf gpgrt_vasprintf
82 /* Due to a bug in mingw32's snprintf related to the 'l' modifier and
83 for increased portability we use our snprintf on all systems. */
85 #define snprintf gpgrt_snprintf
88 /* Replacements for macros not available with libgpg-error < 1.20. */
90 /* We need this type even if we are not using libreadline and or we
91 did not include libreadline in the current file. */
92 #ifndef GNUPG_LIBREADLINE_H_INCLUDED
93 typedef char **rl_completion_func_t (const char *, int, int);
94 #endif /*!GNUPG_LIBREADLINE_H_INCLUDED*/
97 /* Handy malloc macros - please use only them. */
98 #define xtrymalloc(a) gcry_malloc ((a))
99 #define xtrymalloc_secure(a) gcry_malloc_secure ((a))
100 #define xtrycalloc(a,b) gcry_calloc ((a),(b))
101 #define xtrycalloc_secure(a,b) gcry_calloc_secure ((a),(b))
102 #define xtryrealloc(a,b) gcry_realloc ((a),(b))
103 #define xtrystrdup(a) gcry_strdup ((a))
104 #define xfree(a) gcry_free ((a))
105 #define xfree_fnc gcry_free
107 #define xmalloc(a) gcry_xmalloc ((a))
108 #define xmalloc_secure(a) gcry_xmalloc_secure ((a))
109 #define xcalloc(a,b) gcry_xcalloc ((a),(b))
110 #define xcalloc_secure(a,b) gcry_xcalloc_secure ((a),(b))
111 #define xrealloc(a,b) gcry_xrealloc ((a),(b))
112 #define xstrdup(a) gcry_xstrdup ((a))
114 /* For compatibility with gpg 1.4 we also define these: */
115 #define xmalloc_clear(a) gcry_xcalloc (1, (a))
116 #define xmalloc_secure_clear(a) gcry_xcalloc_secure (1, (a))
118 /* The default error source of the application. This is different
119 from GPG_ERR_SOURCE_DEFAULT in that it does not depend on the
120 source file and thus is usable in code shared by applications.
121 Defined by init.c. */
122 extern gpg_err_source_t default_errsource;
124 /* Convenience function to return a gpg-error code for memory
125 allocation failures. This function makes sure that an error will
126 be returned even if accidentally ERRNO is not set. */
127 static inline gpg_error_t
130 return gpg_error_from_syserror ();
135 int answer_is_yes (const char *s);
136 int answer_is_yes_no_default (const char *s, int def_answer);
137 int answer_is_yes_no_quit (const char *s);
138 int answer_is_okay_cancel (const char *s, int def_answer);
140 /*-- xreadline.c --*/
141 ssize_t read_line (FILE *fp,
142 char **addr_of_buffer, size_t *length_of_buffer,
145 /*-- b64enc.c and b64dec.c --*/
154 unsigned char radbuf[4];
157 int invalid_encoding:1;
161 gpg_error_t b64enc_start (struct b64state *state, FILE *fp, const char *title);
162 gpg_error_t b64enc_start_es (struct b64state *state, estream_t fp,
164 gpg_error_t b64enc_write (struct b64state *state,
165 const void *buffer, size_t nbytes);
166 gpg_error_t b64enc_finish (struct b64state *state);
168 gpg_error_t b64dec_start (struct b64state *state, const char *title);
169 gpg_error_t b64dec_proc (struct b64state *state, void *buffer, size_t length,
171 gpg_error_t b64dec_finish (struct b64state *state);
174 char *canon_sexp_to_string (const unsigned char *canon, size_t canonlen);
175 void log_printcanon (const char *text,
176 const unsigned char *sexp, size_t sexplen);
177 void log_printsexp (const char *text, gcry_sexp_t sexp);
179 gpg_error_t make_canon_sexp (gcry_sexp_t sexp,
180 unsigned char **r_buffer, size_t *r_buflen);
181 gpg_error_t make_canon_sexp_pad (gcry_sexp_t sexp, int secure,
182 unsigned char **r_buffer, size_t *r_buflen);
183 gpg_error_t keygrip_from_canon_sexp (const unsigned char *key, size_t keylen,
184 unsigned char *grip);
185 int cmp_simple_canon_sexp (const unsigned char *a, const unsigned char *b);
186 int cmp_canon_sexp (const unsigned char *a, size_t alen,
187 const unsigned char *b, size_t blen,
188 int (*tcmp)(void *ctx, int depth,
189 const unsigned char *aval, size_t avallen,
190 const unsigned char *bval, size_t bvallen),
192 unsigned char *make_simple_sexp_from_hexstr (const char *line,
194 int hash_algo_from_sigval (const unsigned char *sigval);
195 unsigned char *make_canon_sexp_from_rsa_pk (const void *m, size_t mlen,
196 const void *e, size_t elen,
198 gpg_error_t get_rsa_pk_from_canon_sexp (const unsigned char *keydata,
200 unsigned char const **r_n,
202 unsigned char const **r_e,
204 gpg_error_t get_ecc_q_from_canon_sexp (const unsigned char *keydata,
206 unsigned char const **r_q,
208 gpg_error_t uncompress_ecc_q_in_canon_sexp (const unsigned char *keydata,
210 unsigned char **r_newkeydata,
211 size_t *r_newkeydatalen);
213 int get_pk_algo_from_key (gcry_sexp_t key);
214 int get_pk_algo_from_canon_sexp (const unsigned char *keydata,
216 char *pubkey_algo_string (gcry_sexp_t s_pkey, enum gcry_pk_algos *r_algoid);
217 const char *pubkey_algo_to_string (int algo);
218 const char *hash_algo_to_string (int algo);
219 const char *cipher_mode_to_string (int mode);
222 int hex2bin (const char *string, void *buffer, size_t length);
223 int hexcolon2bin (const char *string, void *buffer, size_t length);
224 char *bin2hex (const void *buffer, size_t length, char *stringbuf);
225 char *bin2hexcolon (const void *buffer, size_t length, char *stringbuf);
226 const char *hex2str (const char *hexstring,
227 char *buffer, size_t bufsize, size_t *buflen);
228 char *hex2str_alloc (const char *hexstring, size_t *r_count);
231 char *percent_plus_escape (const char *string);
232 char *percent_data_escape (int plus_escape, const char *prefix,
233 const void *data, size_t datalen);
234 char *percent_plus_unescape (const char *string, int nulrepl);
235 char *percent_unescape (const char *string, int nulrepl);
237 size_t percent_plus_unescape_inplace (char *string, int nulrepl);
238 size_t percent_unescape_inplace (char *string, int nulrepl);
240 /*-- openpgp-oid.c --*/
241 gpg_error_t openpgp_oid_from_str (const char *string, gcry_mpi_t *r_mpi);
242 char *openpgp_oidbuf_to_str (const unsigned char *buf, size_t len);
243 char *openpgp_oid_to_str (gcry_mpi_t a);
244 int openpgp_oidbuf_is_ed25519 (const void *buf, size_t len);
245 int openpgp_oid_is_ed25519 (gcry_mpi_t a);
246 int openpgp_oidbuf_is_cv25519 (const void *buf, size_t len);
247 int openpgp_oid_is_cv25519 (gcry_mpi_t a);
248 const char *openpgp_curve_to_oid (const char *name,
249 unsigned int *r_nbits, int *r_algo);
250 const char *openpgp_oid_to_curve (const char *oid, int canon);
251 const char *openpgp_enum_curves (int *idxp);
252 const char *openpgp_is_curve_supported (const char *name,
253 int *r_algo, unsigned int *r_nbits);
257 const char *standard_homedir (void);
258 const char *default_homedir (void);
259 void gnupg_set_homedir (const char *newdir);
260 void gnupg_maybe_make_homedir (const char *fname, int quiet);
261 const char *gnupg_homedir (void);
262 int gnupg_default_homedir_p (void);
263 const char *gnupg_daemon_rootdir (void);
264 const char *gnupg_socketdir (void);
265 const char *gnupg_sysconfdir (void);
266 const char *gnupg_bindir (void);
267 const char *gnupg_libexecdir (void);
268 const char *gnupg_libdir (void);
269 const char *gnupg_datadir (void);
270 const char *gnupg_localedir (void);
271 const char *gpg_agent_socket_name (void);
272 const char *dirmngr_socket_name (void);
274 char *_gnupg_socketdir_internal (int skip_checks, unsigned *r_info);
276 /* All module names. We also include gpg and gpgsm for the sake for
278 #define GNUPG_MODULE_NAME_AGENT 1
279 #define GNUPG_MODULE_NAME_PINENTRY 2
280 #define GNUPG_MODULE_NAME_SCDAEMON 3
281 #define GNUPG_MODULE_NAME_DIRMNGR 4
282 #define GNUPG_MODULE_NAME_PROTECT_TOOL 5
283 #define GNUPG_MODULE_NAME_CHECK_PATTERN 6
284 #define GNUPG_MODULE_NAME_GPGSM 7
285 #define GNUPG_MODULE_NAME_GPG 8
286 #define GNUPG_MODULE_NAME_CONNECT_AGENT 9
287 #define GNUPG_MODULE_NAME_GPGCONF 10
288 #define GNUPG_MODULE_NAME_DIRMNGR_LDAP 11
289 #define GNUPG_MODULE_NAME_GPGV 12
290 const char *gnupg_module_name (int which);
291 void gnupg_module_name_flush_some (void);
292 void gnupg_set_builddir (const char *newdir);
296 /*-- gpgrlhelp.c --*/
297 void gnupg_rl_initialize (void);
300 char *gnupg_get_help_string (const char *key, int only_current_locale);
302 /*-- localename.c --*/
303 const char *gnupg_messages_locale_name (void);
306 FILE *gnupg_fopen (const char *fname, const char *mode);
308 /*-- miscellaneous.c --*/
310 /* This function is called at startup to tell libgcrypt to use our own
311 logging subsystem. */
312 void setup_libgcrypt_logging (void);
314 /* Print an out of core message and die. */
315 void xoutofcore (void);
317 /* Array allocation. */
318 void *gnupg_reallocarray (void *a, size_t oldnmemb, size_t nmemb, size_t size);
319 void *xreallocarray (void *a, size_t oldnmemb, size_t nmemb, size_t size);
321 /* Same as estream_asprintf but die on memory failure. */
322 char *xasprintf (const char *fmt, ...) GPGRT_ATTR_PRINTF(1,2);
323 /* This is now an alias to estream_asprintf. */
324 char *xtryasprintf (const char *fmt, ...) GPGRT_ATTR_PRINTF(1,2);
326 void *xtryreallocarray (void *a, size_t oldnmemb, size_t nmemb, size_t size);
328 /* Replacement for gcry_cipher_algo_name. */
329 const char *gnupg_cipher_algo_name (int algo);
331 void obsolete_option (const char *configname, unsigned int configlineno,
334 const char *print_fname_stdout (const char *s);
335 const char *print_fname_stdin (const char *s);
336 void print_utf8_buffer3 (estream_t fp, const void *p, size_t n,
338 void print_utf8_buffer2 (estream_t fp, const void *p, size_t n, int delim);
339 void print_utf8_buffer (estream_t fp, const void *p, size_t n);
340 void print_utf8_string (estream_t stream, const char *p);
341 void print_hexstring (FILE *fp, const void *buffer, size_t length,
343 char *try_make_printable_string (const void *p, size_t n, int delim);
344 char *make_printable_string (const void *p, size_t n, int delim);
345 char *decode_c_string (const char *src);
347 int is_file_compressed (const char *s, int *ret_rc);
349 int match_multistr (const char *multistr,const char *match);
351 int gnupg_compare_version (const char *a, const char *b);
358 int parse_debug_flag (const char *string, unsigned int *debugvar,
359 const struct debug_flags_s *flags);
361 struct compatibility_flags_s
367 int parse_compatibility_flags (const char *string, unsigned int *flagvar,
368 const struct compatibility_flags_s *flags);
371 /*-- Simple replacement functions. */
373 /* We use the gnupg_ttyname macro to be safe not to run into conflicts
374 which an extisting but broken ttyname. */
375 #if !defined(HAVE_TTYNAME) || defined(HAVE_BROKEN_TTYNAME)
376 # define gnupg_ttyname(n) _gnupg_ttyname ((n))
377 /* Systems without ttyname (W32) will merely return NULL. */
379 _gnupg_ttyname (int fd)
384 #else /*HAVE_TTYNAME*/
385 # define gnupg_ttyname(n) ttyname ((n))
386 #endif /*HAVE_TTYNAME */
388 #ifdef HAVE_W32CE_SYSTEM
389 #define getpid() GetCurrentProcessId ()
390 char *_gnupg_getenv (const char *name); /* See sysutils.c */
391 #define getenv(a) _gnupg_getenv ((a))
392 char *_gnupg_setenv (const char *name); /* See sysutils.c */
393 #define setenv(a,b,c) _gnupg_setenv ((a),(b),(c))
394 int _gnupg_isatty (int fd);
395 #define gnupg_isatty(a) _gnupg_isatty ((a))
397 #define gnupg_isatty(a) isatty ((a))
402 /*-- Macros to replace ctype ones to avoid locale problems. --*/
403 #define spacep(p) (*(p) == ' ' || *(p) == '\t')
404 #define digitp(p) (*(p) >= '0' && *(p) <= '9')
405 #define alphap(p) ((*(p) >= 'A' && *(p) <= 'Z') \
406 || (*(p) >= 'a' && *(p) <= 'z'))
407 #define alnump(p) (alphap (p) || digitp (p))
408 #define hexdigitp(a) (digitp (a) \
409 || (*(a) >= 'A' && *(a) <= 'F') \
410 || (*(a) >= 'a' && *(a) <= 'f'))
411 /* Note this isn't identical to a C locale isspace() without \f and
412 \v, but works for the purposes used here. */
413 #define ascii_isspace(a) ((a)==' ' || (a)=='\n' || (a)=='\r' || (a)=='\t')
415 /* The atoi macros assume that the buffer has only valid digits. */
416 #define atoi_1(p) (*(p) - '0' )
417 #define atoi_2(p) ((atoi_1(p) * 10) + atoi_1((p)+1))
418 #define atoi_4(p) ((atoi_2(p) * 100) + atoi_2((p)+2))
419 #define xtoi_1(p) (*(p) <= '9'? (*(p)- '0'): \
420 *(p) <= 'F'? (*(p)-'A'+10):(*(p)-'a'+10))
421 #define xtoi_2(p) ((xtoi_1(p) * 16) + xtoi_1((p)+1))
422 #define xtoi_4(p) ((xtoi_2(p) * 256) + xtoi_2((p)+2))
424 #endif /*GNUPG_COMMON_UTIL_H*/