core: Extend decryption result with symkey_algo.
[gpgme.git] / src / util.h
1 /* util.h
2    Copyright (C) 2000 Werner Koch (dd9jn)
3    Copyright (C) 2001, 2002, 2003, 2004, 2005 g10 Code GmbH
4
5    This file is part of GPGME.
6
7    GPGME is free software; you can redistribute it and/or modify it
8    under the terms of the GNU Lesser General Public License as
9    published by the Free Software Foundation; either version 2.1 of
10    the License, or (at your option) any later version.
11
12    GPGME is distributed in the hope that it will be useful, but
13    WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15    Lesser General Public License for more details.
16
17    You should have received a copy of the GNU Lesser General Public
18    License along with this program; if not, write to the Free Software
19    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
20    02111-1307, USA.  */
21
22 #ifndef UTIL_H
23 #define UTIL_H
24
25 #ifdef HAVE_W32_SYSTEM
26 # ifdef HAVE_W32CE_SYSTEM
27 #  include "w32-ce.h"
28 # else
29 #  include "winsock2.h"
30 #  include "windows.h"
31 # endif
32 #endif
33
34 /* For pid_t.  */
35 #ifdef HAVE_SYS_TYPES_H
36 # include <sys/types.h>
37 #endif
38 /* We must see the symbol ttyname_r before a redefinition. */
39 #ifdef HAVE_UNISTD_H
40 # include <unistd.h>
41 #endif
42
43 #include "gpgme.h"
44
45 \f
46 #define DIM(v) (sizeof(v)/sizeof((v)[0]))
47
48 #if GPG_ERROR_VERSION_NUMBER < 0x011900 /* 1.25 */
49 # define GPG_ERR_ENGINE_TOO_OLD 300
50 # define GPG_ERR_TOO_OLD        308
51 #endif
52
53 #ifndef GPGRT_ATTR_SENTINEL
54 # define GPGRT_ATTR_SENTINEL(a)  /* */
55 #endif
56
57
58 \f
59 /*-- {posix,w32}-util.c --*/
60 int _gpgme_get_conf_int (const char *key, int *value);
61 void _gpgme_allow_set_foreground_window (pid_t pid);
62
63 /*-- dirinfo.c --*/
64 void _gpgme_dirinfo_disable_gpgconf (void);
65
66 const char *_gpgme_get_default_homedir (void);
67 const char *_gpgme_get_default_agent_socket (void);
68 const char *_gpgme_get_default_gpg_name (void);
69 const char *_gpgme_get_default_gpgsm_name (void);
70 const char *_gpgme_get_default_g13_name (void);
71 const char *_gpgme_get_default_gpgconf_name (void);
72 const char *_gpgme_get_default_uisrv_socket (void);
73 int _gpgme_in_gpg_one_mode (void);
74
75 const char *_gpgme_get_basename (const char *name);
76
77
78 \f
79 /*-- replacement functions in <funcname>.c --*/
80 #ifdef HAVE_CONFIG_H
81
82 #ifndef HAVE_STPCPY
83 static _GPGME_INLINE char *
84 _gpgme_stpcpy (char *a, const char *b)
85 {
86   while (*b)
87     *a++ = *b++;
88   *a = 0;
89   return a;
90 }
91 #define stpcpy(a,b) _gpgme_stpcpy ((a), (b))
92 #endif /*!HAVE_STPCPY*/
93
94
95 /* Due to a bug in mingw32's snprintf related to the 'l' modifier and
96    for increased portability we use our snprintf on all systems. */
97 #undef snprintf
98 #define snprintf gpgrt_snprintf
99
100
101 #if REPLACE_TTYNAME_R
102 int _gpgme_ttyname_r (int fd, char *buf, size_t buflen);
103 #undef  ttyname_r
104 #define ttyname_r(a,b,c) _gpgme_ttyname_r ((a), (b), (c))
105 #endif
106
107 #endif /*HAVE_CONFIG_H*/
108
109 \f
110 /*-- conversion.c --*/
111
112 /* Concatenate the string S1 with all the following strings up to a
113    NULL.  Returns a malloced buffer with the new string or NULL on a
114    malloc error or if too many arguments are given.  */
115 char *_gpgme_strconcat (const char *s1, ...) GPGRT_ATTR_SENTINEL(0);
116
117 /* Convert two hexadecimal digits from STR to the value they
118    represent.  Returns -1 if one of the characters is not a
119    hexadecimal digit.  */
120 int _gpgme_hextobyte (const char *str);
121
122 /* Decode the C formatted string SRC and store the result in the
123    buffer *DESTP which is LEN bytes long.  If LEN is zero, then a
124    large enough buffer is allocated with malloc and *DESTP is set to
125    the result.  Currently, LEN is only used to specify if allocation
126    is desired or not, the caller is expected to make sure that *DESTP
127    is large enough if LEN is not zero.  */
128 gpgme_error_t _gpgme_decode_c_string (const char *src, char **destp,
129                                       size_t len);
130
131 /* Decode the percent escaped string SRC and store the result in the
132    buffer *DESTP which is LEN bytes long.  If LEN is zero, then a
133    large enough buffer is allocated with malloc and *DESTP is set to
134    the result.  Currently, LEN is only used to specify if allocation
135    is desired or not, the caller is expected to make sure that *DESTP
136    is large enough if LEN is not zero.  If BINARY is 1, then '\0'
137    characters are allowed in the output.  */
138 gpgme_error_t _gpgme_decode_percent_string (const char *src, char **destp,
139                                             size_t len, int binary);
140
141 gpgme_error_t _gpgme_encode_percent_string (const char *src, char **destp,
142                                             size_t len);
143
144 /* Split a string into space delimited fields and remove leading and
145  * trailing spaces from each field.  A pointer to the each field is
146  * stored in ARRAY.  Stop splitting at ARRAYSIZE fields.  The function
147  * modifies STRING.  The number of parsed fields is returned.  */
148 int _gpgme_split_fields (char *string, char **array, int arraysize);
149
150 /* Convert the field STRING into an unsigned long value.  Check for
151  * trailing garbage.  */
152 gpgme_error_t _gpgme_strtoul_field (const char *string, unsigned long *result);
153
154 /* Convert STRING into an offset value similar to atoi().  */
155 gpgme_off_t _gpgme_string_to_off (const char *string);
156
157 /* Parse the string TIMESTAMP into a time_t.  The string may either be
158    seconds since Epoch or in the ISO 8601 format like
159    "20390815T143012".  Returns 0 for an empty string or seconds since
160    Epoch. Leading spaces are skipped. If ENDP is not NULL, it will
161    point to the next non-parsed character in TIMESTRING. */
162 time_t _gpgme_parse_timestamp (const char *timestamp, char **endp);
163
164 /* Variant of _gpgme_parse_timestamp to return an unsigned long or 0
165  * on error or missing timestamp.  */
166 unsigned long _gpgme_parse_timestamp_ul (const char *timestamp);
167
168 int _gpgme_map_pk_algo (int algo, gpgme_protocol_t protocol);
169
170 const char *_gpgme_cipher_algo_name (int algo, gpgme_protocol_t protocol);
171 const char *_gpgme_cipher_mode_name (int algo, gpgme_protocol_t protocol);
172
173 \f
174 /*-- b64dec.c --*/
175
176 struct b64state
177 {
178   int idx;
179   int quad_count;
180   char *title;
181   unsigned char radbuf[4];
182   int stop_seen:1;
183   int invalid_encoding:1;
184   gpg_error_t lasterr;
185 };
186
187 gpg_error_t _gpgme_b64dec_start (struct b64state *state, const char *title);
188 gpg_error_t _gpgme_b64dec_proc (struct b64state *state,
189                                 void *buffer, size_t length, size_t *r_nbytes);
190 gpg_error_t _gpgme_b64dec_finish (struct b64state *state);
191
192
193 \f
194 /* Retrieve the environment variable NAME and return a copy of it in a
195    malloc()'ed buffer in *VALUE.  If the environment variable is not
196    set, return NULL in *VALUE.  */
197 gpgme_error_t _gpgme_getenv (const char *name, char **value);
198
199 \f
200 /*-- status-table.c --*/
201 /* Convert a status string to a status code.  */
202 void _gpgme_status_init (void);
203 gpgme_status_code_t _gpgme_parse_status (const char *name);
204 const char *_gpgme_status_to_string (gpgme_status_code_t code);
205
206 \f
207 #ifdef HAVE_W32_SYSTEM
208 int _gpgme_mkstemp (int *fd, char **name);
209 const char *_gpgme_get_w32spawn_path (void);
210 #endif /*HAVE_W32_SYSTEM*/
211 #ifdef HAVE_W32CE_SYSTEM
212 char *_gpgme_w32ce_get_debug_envvar (void);
213 #endif /*HAVE_W32CE_SYSTEM*/
214
215
216 \f
217 #include <assuan.h>
218 /* System hooks for assuan integration.  */
219 extern struct assuan_system_hooks _gpgme_assuan_system_hooks;
220 extern struct assuan_malloc_hooks _gpgme_assuan_malloc_hooks;
221 int _gpgme_assuan_log_cb (assuan_context_t ctx, void *hook,
222                           unsigned int cat, const char *msg);
223
224 \f
225
226 /* Parse the compliance field.  */
227 #define PARSE_COMPLIANCE_FLAGS(flags, result)                           \
228   do {                                                                  \
229     char *comp_p, *comp_endp;                                           \
230     unsigned long comp_ul;                                              \
231                                                                         \
232     for (comp_p = (flags);                                              \
233          comp_p                                                         \
234            && (comp_ul = strtoul (comp_p, &comp_endp, 10))              \
235            && comp_p != comp_endp;                                      \
236          comp_p = comp_endp)                                            \
237       {                                                                 \
238         switch (comp_ul)                                                \
239           {                                                             \
240           case 23: (result)->is_de_vs = 1; break;                       \
241           }                                                             \
242       }                                                                 \
243   } while (0)
244
245
246 #endif /* UTIL_H */