Add support for gpg --fetch-keys.
[gpgme.git] / src / version.c
1 /* version.c - Version check routines.
2    Copyright (C) 2000 Werner Koch (dd9jn)
3    Copyright (C) 2001, 2002, 2003, 2004, 2005, 2007, 2008 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 #if HAVE_CONFIG_H
23 #include <config.h>
24 #endif
25 #include <stdlib.h>
26 #include <string.h>
27 #include <limits.h>
28 #include <ctype.h>
29 #ifdef HAVE_W32_SYSTEM
30 #include <winsock2.h>
31 #endif
32
33 #include "gpgme.h"
34 #include "priv-io.h"
35 #include "debug.h"
36 #include "context.h"
37
38 /* For _gpgme_sema_subsystem_init ().  */
39 #include "sema.h"
40
41 #ifdef HAVE_ASSUAN_H
42 #include "assuan.h"
43 #endif
44
45 #ifdef HAVE_W32_SYSTEM
46 #include "windows.h"
47 #endif
48
49 /* We implement this function, so we have to disable the overriding
50    macro.  */
51 #undef gpgme_check_version
52
53 \f
54 /* Bootstrap the subsystems needed for concurrent operation.  This
55    must be done once at startup.  We can not guarantee this using a
56    lock, though, because the semaphore subsystem needs to be
57    initialized itself before it can be used.  So we expect that the
58    user performs the necessary synchronization.  */
59 static void
60 do_subsystem_inits (void)
61 {
62   static int done = 0;
63
64   if (done)
65     return;
66
67 #ifdef HAVE_W32_SYSTEM
68       {
69         WSADATA wsadat;
70         
71         WSAStartup (0x202, &wsadat);
72       }
73 #endif
74
75   _gpgme_sema_subsystem_init ();
76 #ifdef HAVE_ASSUAN_H
77   assuan_set_assuan_err_source (GPG_ERR_SOURCE_GPGME);
78 #endif /*HAVE_ASSUAN_H*/
79   _gpgme_debug_subsystem_init ();
80   _gpgme_io_subsystem_init ();
81 #if defined(HAVE_W32_SYSTEM) && defined(HAVE_ASSUAN_H)
82   /* We need to make sure that the sockets are initialized.  */
83   {
84     WSADATA wsadat;
85     
86     WSAStartup (0x202, &wsadat);
87   }
88 #endif /*HAVE_W32_SYSTEM && HAVE_ASSUAN_H*/
89
90   done = 1;
91 }
92
93
94 /* Read the next number in the version string STR and return it in
95    *NUMBER.  Return a pointer to the tail of STR after parsing, or
96    *NULL if the version string was invalid.  */
97 static const char *
98 parse_version_number (const char *str, int *number)
99 {
100 #define MAXVAL ((INT_MAX - 10) / 10)
101   int val = 0;
102
103   /* Leading zeros are not allowed.  */
104   if (*str == '0' && isdigit(str[1]))
105     return NULL;
106
107   while (isdigit (*str) && val <= MAXVAL)
108     {
109       val *= 10;
110       val += *(str++) - '0';
111     }
112   *number = val;
113   return val > MAXVAL ? NULL : str;
114 }
115
116
117 /* Parse the version string STR in the format MAJOR.MINOR.MICRO (for
118    example, 9.3.2) and return the components in MAJOR, MINOR and MICRO
119    as integers.  The function returns the tail of the string that
120    follows the version number.  This might be te empty string if there
121    is nothing following the version number, or a patchlevel.  The
122    function returns NULL if the version string is not valid.  */
123 static const char *
124 parse_version_string (const char *str, int *major, int *minor, int *micro)
125 {
126   str = parse_version_number (str, major);
127   if (!str || *str != '.')
128     return NULL;
129   str++;
130
131   str = parse_version_number (str, minor);
132   if (!str || *str != '.')
133     return NULL;
134   str++;
135
136   str = parse_version_number (str, micro);
137   if (!str)
138     return NULL;
139
140   /* A patchlevel might follow.  */
141   return str;
142 }
143
144
145 /* Return true if MY_VERSION is at least REQ_VERSION, and false
146    otherwise.  */
147 int
148 _gpgme_compare_versions (const char *my_version,
149                          const char *rq_version)
150 {
151   int my_major, my_minor, my_micro;
152   int rq_major, rq_minor, rq_micro;
153   const char *my_plvl, *rq_plvl;
154
155   if (!rq_version)
156     return 1;
157   if (!my_version)
158     return 0;
159
160   my_plvl = parse_version_string (my_version, &my_major, &my_minor, &my_micro);
161   if (!my_plvl)
162     return 0;
163
164   rq_plvl = parse_version_string (rq_version, &rq_major, &rq_minor, &rq_micro);
165   if (!rq_plvl)
166     return 0;
167
168   if (my_major > rq_major
169       || (my_major == rq_major && my_minor > rq_minor)
170       || (my_major == rq_major && my_minor == rq_minor 
171           && my_micro > rq_micro)
172       || (my_major == rq_major && my_minor == rq_minor
173           && my_micro == rq_micro && strcmp (my_plvl, rq_plvl) >= 0))
174     return 1;
175
176   return 0;
177 }
178
179
180 /* Check that the the version of the library is at minimum the
181    requested one and return the version string; return NULL if the
182    condition is not met.  If a NULL is passed to this function, no
183    check is done and the version string is simply returned.
184
185    This function must be run once at startup, as it also initializes
186    some subsystems.  Its invocation must be synchronized against
187    calling any of the other functions in a multi-threaded
188    environments.  */
189 const char *
190 gpgme_check_version (const char *req_version)
191 {
192   char *result;
193   do_subsystem_inits ();
194
195   /* Catch-22: We need to get at least the debug subsystem ready
196      before using the tarce facility.  If we won't the tarce would
197      automagically initialize the debug system with out the locks
198      being initialized and missing the assuan log level setting. */
199   TRACE2 (DEBUG_INIT, "gpgme_check_version: ", 0,
200           "req_version=%s, VERSION=%s",
201           req_version? req_version:"(null)", VERSION);
202  
203   result = _gpgme_compare_versions (VERSION, req_version) ? VERSION : NULL;
204   if (result != NULL)
205     _gpgme_selftest = 0;
206
207   return result;
208 }
209
210 /* Check the version and also at runtime if the struct layout of the
211    library matches the one of the user.  This is particular useful for
212    Windows targets (-mms-bitfields).  */
213 const char *
214 gpgme_check_version_internal (const char *req_version,
215                               size_t offset_sig_validity)
216 {
217   const char *result;
218
219   TRACE2 (DEBUG_INIT, "gpgme_check_version_internal: ", 0,
220           "req_version=%s, offset_sig_validity=%i",
221           req_version ? req_version : "(null)", offset_sig_validity);
222
223   result = gpgme_check_version (req_version);
224   if (result == NULL)
225     return result;
226
227   if (offset_sig_validity != offsetof (struct _gpgme_signature, validity))
228     {
229       TRACE1 (DEBUG_INIT, "gpgme_check_version_internal: ", 0,
230               "offset_sig_validity mismatch: expected %i",
231               offsetof (struct _gpgme_signature, validity));
232       _gpgme_selftest = GPG_ERR_SELFTEST_FAILED;
233     }
234
235   return result;
236 }
237
238 \f
239 #define LINELENGTH 80
240
241 /* Extract the version string of a program from STRING.  The version
242    number is expected to be in GNU style format:
243    
244      foo 1.2.3
245      foo (bar system) 1.2.3
246      foo 1.2.3 cruft
247      foo (bar system) 1.2.3 cruft.
248
249   Spaces and tabs are skipped and used as delimiters, a term in
250   (nested) parenthesis before the version string is skipped, the
251   version string may consist of any non-space and non-tab characters
252   but needs to bstart with a digit.
253 */
254 static const char *
255 extract_version_string (const char *string, size_t *r_len)
256 {
257   const char *s;
258   int count, len;
259
260   for (s=string; *s; s++)
261     if (*s == ' ' || *s == '\t')
262         break;
263   while (*s == ' ' || *s == '\t')
264     s++;
265   if (*s == '(')
266     {
267       for (count=1, s++; count && *s; s++)
268         if (*s == '(')
269           count++;
270         else if (*s == ')')
271           count--;
272     }
273   /* For robustness we look for a digit.  */
274   while ( *s && !(*s >= '0' && *s <= '9') )
275     s++;
276   if (*s >= '0' && *s <= '9')
277     {
278       for (len=0; s[len]; len++)
279         if (s[len] == ' ' || s[len] == '\t')
280           break;
281     }
282   else
283     len = 0;
284
285   *r_len = len;
286   return s;
287 }
288
289
290 /* Retrieve the version number from the --version output of the
291    program FILE_NAME.  */
292 char *
293 _gpgme_get_program_version (const char *const file_name)
294 {
295   char line[LINELENGTH] = "";
296   int linelen = 0;
297   char *mark = NULL;
298   int rp[2];
299   int nread;
300   char *argv[] = {NULL /* file_name */, "--version", 0};
301   struct spawn_fd_item_s cfd[] = { {-1, 1 /* STDOUT_FILENO */, -1, 0},
302                                    {-1, -1} };
303   int status;
304
305   if (!file_name)
306     return NULL;
307   argv[0] = (char *) file_name;
308
309   if (_gpgme_io_pipe (rp, 1) < 0)
310     return NULL;
311
312   cfd[0].fd = rp[1];
313
314   status = _gpgme_io_spawn (file_name, argv, 0, cfd, NULL);
315   if (status < 0)
316     {
317       _gpgme_io_close (rp[0]);
318       _gpgme_io_close (rp[1]);
319       return NULL;
320     }
321
322   do
323     {
324       nread = _gpgme_io_read (rp[0], &line[linelen], LINELENGTH - linelen - 1);
325       if (nread > 0)
326         {
327           line[linelen + nread] = '\0';
328           mark = strchr (&line[linelen], '\n');
329           if (mark)
330             {
331               if (mark > &line[0] && *mark == '\r')
332                 mark--;
333               *mark = '\0';
334               break;
335             }
336           linelen += nread;
337         }
338     }
339   while (nread > 0 && linelen < LINELENGTH - 1);
340
341   _gpgme_io_close (rp[0]);
342
343   if (mark)
344     {
345       size_t len;
346       const char *s;
347
348       s = extract_version_string (line, &len);
349       if (!len)
350         return NULL;
351       mark = malloc (len + 1);
352       if (!mark)
353         return NULL;
354       memcpy (mark, s, len);
355       mark[len] = 0;
356       return mark;
357     }
358
359   return NULL;
360 }