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