Improved logging for error orginating from libgcrypt.
[gnupg.git] / common / util.h
1 /* util.h - Utility functions for GnuPG
2  * Copyright (C) 2001, 2002, 2003, 2004 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 2 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, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
19  * USA.
20  */
21
22 #ifndef GNUPG_COMMON_UTIL_H
23 #define GNUPG_COMMON_UTIL_H
24
25 #include <gcrypt.h> /* We need this for the memory function protos. */
26 #include <time.h>   /* We need time_t. */
27 #include <errno.h>  /* We need errno.  */
28 #include <gpg-error.h> /* We need gpg_error_t. */
29
30 /* Common GNUlib includes (-I ../gl/). */
31 #include "vasprintf.h"
32
33
34 /* Hash function used with libksba. */
35 #define HASH_FNC ((void (*)(void *, const void*,size_t))gcry_md_write)
36
37 /* Get all the stuff from jnlib. */
38 #include "../jnlib/logging.h"
39 #include "../jnlib/argparse.h"
40 #include "../jnlib/stringhelp.h"
41 #include "../jnlib/mischelp.h"
42 #include "../jnlib/strlist.h"
43 #include "../jnlib/dotlock.h"
44 #include "../jnlib/utf8conv.h"
45
46 #if __GNUC__ >= 4 
47 # define GNUPG_GCC_A_SENTINEL(a) __attribute__ ((sentinel(a)))
48 #else
49 # define GNUPG_GCC_A_SENTINEL(a) 
50 #endif
51
52
53 /* We need this type even if we are not using libreadline and or we
54    did not include libreadline in the current file. */
55 #ifndef GNUPG_LIBREADLINE_H_INCLUDED
56 typedef char **rl_completion_func_t (const char *, int, int);
57 #endif /*!GNUPG_LIBREADLINE_H_INCLUDED*/
58
59
60 /* Handy malloc macros - please use only them. */
61 #define xtrymalloc(a)    gcry_malloc ((a))
62 #define xtrymalloc_secure(a)  gcry_malloc_secure ((a))
63 #define xtrycalloc(a,b)  gcry_calloc ((a),(b))
64 #define xtrycalloc_secure(a,b)  gcry_calloc_secure ((a),(b))
65 #define xtryrealloc(a,b) gcry_realloc ((a),(b))
66 #define xtrystrdup(a)    gcry_strdup ((a))
67 #define xfree(a)         gcry_free ((a))
68
69 #define xmalloc(a)       gcry_xmalloc ((a))
70 #define xmalloc_secure(a)  gcry_xmalloc_secure ((a))
71 #define xcalloc(a,b)     gcry_xcalloc ((a),(b))
72 #define xcalloc_secure(a,b) gcry_xcalloc_secure ((a),(b))
73 #define xrealloc(a,b)    gcry_xrealloc ((a),(b))
74 #define xstrdup(a)       gcry_xstrdup ((a))
75
76 /* For compatibility with gpg 1.4 we also define these: */
77 #define xmalloc_clear(a) gcry_xcalloc (1, (a))
78 #define xmalloc_secure_clear(a) gcry_xcalloc_secure (1, (a))
79
80 /* Convenience function to return a gpg-error code for memory
81    allocation failures.  This function makes sure that an error will
82    be returned even if accidently ERRNO is not set.  */
83 static inline gpg_error_t
84 out_of_core (void)
85 {
86   return gpg_error_from_syserror ();
87 }
88
89 /* A type to hold the ISO time.  Note that this this is the same as
90    the the KSBA type ksba_isotime_t. */
91 typedef char gnupg_isotime_t[16];
92
93
94 /*-- gettime.c --*/
95 time_t gnupg_get_time (void);
96 void   gnupg_get_isotime (gnupg_isotime_t timebuf);
97 void   gnupg_set_time (time_t newtime, int freeze);
98 int    gnupg_faked_time_p (void);
99 u32    make_timestamp (void);
100 u32    scan_isodatestr (const char *string);
101 u32    add_days_to_timestamp (u32 stamp, u16 days);
102 const char *strtimevalue (u32 stamp);
103 const char *strtimestamp (u32 stamp); /* GMT */
104 const char *isotimestamp (u32 stamp); /* GMT */
105 const char *asctimestamp (u32 stamp); /* localized */
106
107
108 /* Copy one iso ddate to another, this is inline so that we can do a
109    sanity check. */
110 static inline void
111 gnupg_copy_time (gnupg_isotime_t d, const gnupg_isotime_t s)
112 {
113   if (*s && (strlen (s) != 15 || s[8] != 'T'))
114     BUG();
115   strcpy (d, s);
116 }
117
118
119 /*-- signal.c --*/
120 void gnupg_init_signals (int mode, void (*fast_cleanup)(void));
121 void gnupg_pause_on_sigusr (int which);
122 void gnupg_block_all_signals (void);
123 void gnupg_unblock_all_signals (void);
124
125 /*-- yesno.c --*/
126 int answer_is_yes (const char *s);
127 int answer_is_yes_no_default (const char *s, int def_answer);
128 int answer_is_yes_no_quit (const char *s);
129 int answer_is_okay_cancel (const char *s, int def_answer);
130
131 /*-- xreadline.c --*/
132 ssize_t read_line (FILE *fp, 
133                    char **addr_of_buffer, size_t *length_of_buffer,
134                    size_t *max_length);
135
136
137 /*-- b64enc.c --*/
138 struct b64state 
139
140   unsigned int flags;
141   int idx;
142   int quad_count;
143   FILE *fp;
144   char *title;
145   unsigned char radbuf[4];
146 };
147 gpg_error_t b64enc_start (struct b64state *state, FILE *fp, const char *title);
148 gpg_error_t b64enc_write (struct b64state *state,
149                           const void *buffer, size_t nbytes);
150 gpg_error_t b64enc_finish (struct b64state *state);
151
152 /*-- sexputil.c */
153 gpg_error_t keygrip_from_canon_sexp (const unsigned char *key, size_t keylen,
154                                      unsigned char *grip);
155 int cmp_simple_canon_sexp (const unsigned char *a, const unsigned char *b);
156 unsigned char *make_simple_sexp_from_hexstr (const char *line,
157                                              size_t *nscanned);
158
159 /*-- convert.c --*/
160 int hex2bin (const char *string, void *buffer, size_t length);
161 int hexcolon2bin (const char *string, void *buffer, size_t length);
162 char *bin2hex (const void *buffer, size_t length, char *stringbuf);
163 char *bin2hexcolon (const void *buffer, size_t length, char *stringbuf);
164
165
166 /*-- homedir.c --*/
167 const char *default_homedir (void);
168
169 /*-- gpgrlhelp.c --*/
170 void gnupg_rl_initialize (void);
171
172 /*-- miscellaneous.c --*/
173
174 /* This function is called at startup to tell libgcrypt to use our own
175    logging subsystem. */
176 void setup_libgcrypt_logging (void);
177
178 /* Same as asprintf but return an allocated buffer suitable to be
179    freed using xfree.  This function simply dies on memory failure,
180    thus no extra check is required. */
181 char *xasprintf (const char *fmt, ...) JNLIB_GCC_A_PRINTF(1,2);
182 /* Same as asprintf but return an allocated buffer suitable to be
183    freed using xfree.  This function returns NULL on memory failure and
184    sets errno. */
185 char *xtryasprintf (const char *fmt, ...) JNLIB_GCC_A_PRINTF(1,2);
186
187 const char *print_fname_stdout (const char *s);
188 const char *print_fname_stdin (const char *s);
189 void print_string (FILE *fp, const byte *p, size_t n, int delim);
190 void print_utf8_string2 ( FILE *fp, const byte *p, size_t n, int delim);
191 void print_utf8_string (FILE *fp, const byte *p, size_t n);
192 void print_hexstring (FILE *fp, const void *buffer, size_t length,
193                       int reserved);
194 char *make_printable_string (const void *p, size_t n, int delim);
195
196 int is_file_compressed (const char *s, int *ret_rc);
197
198 int match_multistr (const char *multistr,const char *match);
199
200
201 /*-- Simple replacement functions. */
202 #ifndef HAVE_TTYNAME
203 /* Systems without ttyname (W32) will merely return NULL. */
204 static inline char *
205 ttyname (int fd) 
206 {
207   return NULL
208 };
209 #endif /* !HAVE_TTYNAME */
210
211
212 /*-- Macros to replace ctype ones to avoid locale problems. --*/
213 #define spacep(p)   (*(p) == ' ' || *(p) == '\t')
214 #define digitp(p)   (*(p) >= '0' && *(p) <= '9')
215 #define hexdigitp(a) (digitp (a)                     \
216                       || (*(a) >= 'A' && *(a) <= 'F')  \
217                       || (*(a) >= 'a' && *(a) <= 'f'))
218   /* Note this isn't identical to a C locale isspace() without \f and
219      \v, but works for the purposes used here. */
220 #define ascii_isspace(a) ((a)==' ' || (a)=='\n' || (a)=='\r' || (a)=='\t')
221
222 /* The atoi macros assume that the buffer has only valid digits. */
223 #define atoi_1(p)   (*(p) - '0' )
224 #define atoi_2(p)   ((atoi_1(p) * 10) + atoi_1((p)+1))
225 #define atoi_4(p)   ((atoi_2(p) * 100) + atoi_2((p)+2))
226 #define xtoi_1(p)   (*(p) <= '9'? (*(p)- '0'): \
227                      *(p) <= 'F'? (*(p)-'A'+10):(*(p)-'a'+10))
228 #define xtoi_2(p)   ((xtoi_1(p) * 16) + xtoi_1((p)+1))
229 #define xtoi_4(p)   ((xtoi_2(p) * 256) + xtoi_2((p)+2))
230
231
232
233 #endif /*GNUPG_COMMON_UTIL_H*/