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