* keybox-search.c (blob_cmp_name): Kludge to allow searching for
[gnupg.git] / kbx / keybox-search.c
1 /* keybox-search.c - Search operations
2  *      Copyright (C) 2001 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
19  */
20
21 #include <config.h>
22 #include <stdlib.h>
23 #include <stdio.h>
24 #include <string.h>
25 #include <assert.h>
26
27 #include "keybox-defs.h"
28
29 #define xtoi_1(p)   (*(p) <= '9'? (*(p)- '0'): \
30                      *(p) <= 'F'? (*(p)-'A'+10):(*(p)-'a'+10))
31 #define xtoi_2(p)   ((xtoi_1(p) * 16) + xtoi_1((p)+1))
32
33
34 static ulong
35 get32 (const byte *buffer)
36 {
37   ulong a;
38   a =  *buffer << 24;
39   a |= buffer[1] << 16;
40   a |= buffer[2] << 8;
41   a |= buffer[3];
42   return a;
43 }
44
45 static ulong
46 get16 (const byte *buffer)
47 {
48   ulong a;
49   a =  *buffer << 8;
50   a |= buffer[1];
51   return a;
52 }
53
54
55
56 static int
57 blob_get_type (KEYBOXBLOB blob)
58 {
59   const unsigned char *buffer;
60   size_t length;
61
62   buffer = _keybox_get_blob_image (blob, &length);
63   if (length < 40)
64     return -1; /* blob too short */
65
66   return buffer[4];
67 }
68
69
70 static int
71 blob_cmp_sn (KEYBOXBLOB blob, const unsigned char *sn)
72 {
73   size_t snlen;
74   const unsigned char *buffer;
75   size_t length;
76   size_t pos, off;
77   size_t nkeys, keyinfolen;
78   size_t nserial;
79
80   snlen = (sn[0] << 24) | (sn[1] << 16) | (sn[2] << 8) | sn[3];
81   sn += 4;
82
83   buffer = _keybox_get_blob_image (blob, &length);
84   if (length < 40)
85     return 0; /* blob too short */
86
87   /*keys*/
88   nkeys = get16 (buffer + 16);
89   keyinfolen = get16 (buffer + 18 );
90   if (keyinfolen < 28)
91     return 0; /* invalid blob */
92   pos = 20 + keyinfolen*nkeys;
93   if (pos+2 > length)
94     return 0; /* out of bounds */
95
96   /*serial*/
97   nserial = get16 (buffer+pos); 
98   off = pos + 2;
99   if (off+nserial > length)
100     return 0; /* out of bounds */
101
102   return nserial == snlen && !memcmp (buffer+off, sn, snlen);
103 }
104
105
106 static int
107 blob_cmp_name (KEYBOXBLOB blob, int idx, const char *name, size_t namelen)
108 {
109   const unsigned char *buffer;
110   size_t length;
111   size_t pos, off, len;
112   size_t nkeys, keyinfolen;
113   size_t nuids, uidinfolen;
114   size_t nserial;
115
116   buffer = _keybox_get_blob_image (blob, &length);
117   if (length < 40)
118     return 0; /* blob too short */
119
120   /*keys*/
121   nkeys = get16 (buffer + 16);
122   keyinfolen = get16 (buffer + 18 );
123   if (keyinfolen < 28)
124     return 0; /* invalid blob */
125   pos = 20 + keyinfolen*nkeys;
126   if (pos+2 > length)
127     return 0; /* out of bounds */
128
129   /*serial*/
130   nserial = get16 (buffer+pos); 
131   pos += 2 + nserial;
132   if (pos+4 > length)
133     return 0; /* out of bounds */
134
135   /* user ids*/
136   nuids = get16 (buffer + pos);  pos += 2;
137   uidinfolen = get16 (buffer + pos);  pos += 2;
138   if (uidinfolen < 12 /* should add a: || nuidinfolen > MAX_UIDINFOLEN */)
139     return 0; /* invalid blob */
140   if (pos + uidinfolen*nuids > length)
141     return 0; /* out of bounds */
142
143   if (idx < 0)
144     { /* compare all names starting with that (negated) index */
145       idx = -idx;
146       
147       for ( ;idx < nuids; idx++)
148         {
149           size_t mypos = pos;
150
151           mypos += idx*uidinfolen;
152           off = get32 (buffer+mypos);
153           len = get32 (buffer+mypos+4);
154           if (off+len > length)
155             return 0; /* error: better stop here out of bounds */
156           if (len < 2)
157             continue; /* empty name or 0 not stored */
158           len--;
159           if (len == namelen && !memcmp (buffer+off, name, len))
160             return 1; /* found */
161         }
162       return 0; /* not found */
163     }
164   else
165     {
166       if (idx > nuids)
167         return 0; /* no user ID with that idx */
168       pos += idx*uidinfolen;
169       off = get32 (buffer+pos);
170       len = get32 (buffer+pos+4);
171       if (off+len > length)
172         return 0; /* out of bounds */
173       if (len < 2)
174         return 0; /* empty name or 0 not stored */
175       len--;
176       
177       return len == namelen && !memcmp (buffer+off, name, len);
178     }
179 }
180
181
182 /* compare all email addresses of the subject */
183 static int
184 blob_cmp_mail (KEYBOXBLOB blob, const char *name, size_t namelen)
185 {
186   const unsigned char *buffer;
187   size_t length;
188   size_t pos, off, len;
189   size_t nkeys, keyinfolen;
190   size_t nuids, uidinfolen;
191   size_t nserial;
192   int idx;
193
194   /* fixme: this code is common to blob_cmp_mail */
195   buffer = _keybox_get_blob_image (blob, &length);
196   if (length < 40)
197     return 0; /* blob too short */
198
199   /*keys*/
200   nkeys = get16 (buffer + 16);
201   keyinfolen = get16 (buffer + 18 );
202   if (keyinfolen < 28)
203     return 0; /* invalid blob */
204   pos = 20 + keyinfolen*nkeys;
205   if (pos+2 > length)
206     return 0; /* out of bounds */
207
208   /*serial*/
209   nserial = get16 (buffer+pos); 
210   pos += 2 + nserial;
211   if (pos+4 > length)
212     return 0; /* out of bounds */
213
214   /* user ids*/
215   nuids = get16 (buffer + pos);  pos += 2;
216   uidinfolen = get16 (buffer + pos);  pos += 2;
217   if (uidinfolen < 12 /* should add a: || nuidinfolen > MAX_UIDINFOLEN */)
218     return 0; /* invalid blob */
219   if (pos + uidinfolen*nuids > length)
220     return 0; /* out of bounds */
221
222   for (idx=1 ;idx < nuids; idx++)
223     {
224       size_t mypos = pos;
225       
226       mypos += idx*uidinfolen;
227       off = get32 (buffer+mypos);
228       len = get32 (buffer+mypos+4);
229       if (off+len > length)
230         return 0; /* error: better stop here out of bounds */
231       if (len < 2 || buffer[off] != '<')
232         continue; /* empty name or trailing 0 not stored */
233       len--; /* remove the null */
234       if ( len < 3 || buffer[off+len-1] != '>')
235         continue; /* not a prober email address */
236       off++; len--;   /* skip the leading angle bracket */
237       len--;          /* don't compare the trailing one */
238       if (len == namelen && !memcmp (buffer+off, name, len))
239         return 1; /* found */
240     }
241   return 0; /* not found */
242 }
243
244
245
246 \f
247 /*
248   The has_foo functions are used as helpers for search 
249 */
250 #if 0
251 static int
252 has_short_kid (KEYBOXBLOB blob, u32 kid)
253 {
254   return 0;
255 }
256
257 static int
258 has_long_kid (KEYBOXBLOB blob, u32 *kid)
259 {
260   return 0;
261 }
262 #endif
263
264 static int
265 has_fingerprint (KEYBOXBLOB blob, const unsigned char *fpr)
266 {
267   return 0;
268 }
269
270
271 static int
272 has_issuer (KEYBOXBLOB blob, const char *name)
273 {
274   size_t namelen;
275
276   return_val_if_fail (name, 0);
277
278   if (blob_get_type (blob) != BLOBTYPE_X509)
279     return 0;
280
281   namelen = strlen (name);
282   return blob_cmp_name (blob, 0 /* issuer */, name, namelen);
283 }
284
285 static int
286 has_issuer_sn (KEYBOXBLOB blob, const char *name, const unsigned char *sn)
287 {
288   size_t namelen;
289
290   return_val_if_fail (name, 0);
291   return_val_if_fail (sn, 0);
292
293   if (blob_get_type (blob) != BLOBTYPE_X509)
294     return 0;
295
296   namelen = strlen (name);
297   
298   return (blob_cmp_sn (blob, sn)
299           && blob_cmp_name (blob, 0 /* issuer */, name, namelen));
300 }
301
302 static int
303 has_sn (KEYBOXBLOB blob, const unsigned char *sn)
304 {
305   return_val_if_fail (sn, 0);
306
307   if (blob_get_type (blob) != BLOBTYPE_X509)
308     return 0;
309   return blob_cmp_sn (blob, sn);
310 }
311
312 static int
313 has_subject (KEYBOXBLOB blob, const char *name)
314 {
315   size_t namelen;
316
317   return_val_if_fail (name, 0);
318
319   if (blob_get_type (blob) != BLOBTYPE_X509)
320     return 0;
321
322   namelen = strlen (name);
323   return blob_cmp_name (blob, 1 /* subject */, name, namelen);
324 }
325
326 static int
327 has_subject_or_alt (KEYBOXBLOB blob, const char *name)
328 {
329   size_t namelen;
330
331   return_val_if_fail (name, 0);
332
333   if (blob_get_type (blob) != BLOBTYPE_X509)
334     return 0;
335
336   namelen = strlen (name);
337   return blob_cmp_name (blob, -1 /* all subject names*/, name, namelen);
338 }
339
340
341 static int
342 has_mail (KEYBOXBLOB blob, const char *name)
343 {
344   size_t namelen;
345
346   return_val_if_fail (name, 0);
347
348   if (blob_get_type (blob) != BLOBTYPE_X509)
349     return 0;
350
351   namelen = strlen (name);
352   return blob_cmp_mail (blob, name, namelen);
353 }
354
355
356 static void
357 release_sn_array (unsigned char **array, size_t size)
358 {
359   size_t n;
360
361   for (n=0; n < size; n++)
362     xfree (array[n]);
363   xfree (array);
364 }
365
366 \f
367 /*
368
369   The search API
370
371 */
372
373 int 
374 keybox_search_reset (KEYBOX_HANDLE hd)
375 {
376   if (!hd)
377     return KEYBOX_Invalid_Value;
378
379   if (hd->found.blob)
380     {
381       _keybox_release_blob (hd->found.blob);
382       hd->found.blob = NULL;
383     }
384
385   if (hd->fp)
386     {
387       fclose (hd->fp);
388       hd->fp = NULL;
389     }
390   hd->error = 0;
391   hd->eof = 0;
392   return 0;   
393 }
394
395 int 
396 keybox_search (KEYBOX_HANDLE hd, KEYBOX_SEARCH_DESC *desc, size_t ndesc)
397 {
398   int rc;
399   size_t n;
400   int need_words, any_skip;
401   KEYBOXBLOB blob = NULL;
402   unsigned char **sn_array = NULL;
403
404   if (!hd)
405     return KEYBOX_Invalid_Value;
406
407   /* clear last found result */
408   if (hd->found.blob)
409     {
410       _keybox_release_blob (hd->found.blob);
411       hd->found.blob = NULL;
412     }
413
414   if (hd->error)  
415     return hd->error; /* still in error state */
416   if (hd->eof)  
417     return -1; /* still EOF */
418
419   /* figure out what information we need */
420   need_words = any_skip = 0;
421   for (n=0; n < ndesc; n++) 
422     {
423       switch (desc[n].mode) 
424         {
425         case KEYDB_SEARCH_MODE_WORDS: 
426           need_words = 1;
427           break;
428         case KEYDB_SEARCH_MODE_FIRST:
429           /* always restart the search in this mode */
430           keybox_search_reset (hd);
431           break;
432         default:
433           break;
434         }
435       if (desc[n].skipfnc) 
436         any_skip = 1;
437       if (desc[n].sn_is_string && !sn_array)
438         {
439           sn_array = xtrycalloc (ndesc, sizeof *sn_array);
440           if (!sn_array)
441             return (hd->error = KEYBOX_Out_Of_Core);
442         }
443     }
444
445   if (!hd->fp)
446     {
447       hd->fp = fopen (hd->kb->fname, "rb");
448       if (!hd->fp)
449         {
450           xfree (sn_array);
451           return (hd->error = KEYBOX_File_Open_Error);
452         }
453     }
454
455   /* kludge: we need to convert an SN given as hexstring to it's
456      binary representation - in some cases we are not able to store it
457      in the search descriptor, because due to its usgae it is not
458      possible to free allocated memory */
459   if (sn_array)
460     {
461       const unsigned char *s;
462       int i, odd;
463       size_t snlen;
464
465       for (n=0; n < ndesc; n++) 
466         {
467           if (!desc[n].sn)
468             ;
469           else if (desc[n].sn_is_string)
470             {
471               unsigned char *sn;
472
473               s = desc[n].sn;
474               for (i=0; *s && *s != '/'; s++, i++)
475                 ;
476               odd = (i & 1);
477               snlen = (i+1)/2;
478               sn_array[n] = xtrymalloc (4+snlen);
479               if (!sn_array[n])
480                 {
481                   release_sn_array (sn_array, n);
482                   return (hd->error = KEYBOX_Out_Of_Core);
483                 }
484               sn = sn_array[n] + 4;
485               s = desc[n].sn;
486               if (odd)
487                 {
488                   *sn++ = xtoi_1 (s);
489                   s++;
490                 }
491               for (; *s && *s != '/';  s += 2)
492                 *sn++ = xtoi_2 (s);
493               assert (sn - sn_array[n] == 4+snlen);
494               sn = sn_array[n];
495               sn[0] = snlen >> 24;
496               sn[1] = snlen >> 16;
497               sn[2] = snlen >> 8;
498               sn[3] = snlen;
499             }
500           else
501             {
502               const unsigned char *sn;
503
504               sn = desc[n].sn;
505               snlen = (sn[0] << 24) | (sn[1] << 16) | (sn[2] << 8) | sn[3];
506               sn_array[n] = xtrymalloc (4+snlen);
507               if (!sn_array[n])
508                 {
509                   release_sn_array (sn_array, n);
510                   return (hd->error = KEYBOX_Out_Of_Core);
511                 }
512               memcpy (sn_array[n], sn, 4+snlen);
513             }
514         }
515     }
516
517
518   for (;;)
519     {
520       _keybox_release_blob (blob); blob = NULL;
521       rc = _keybox_read_blob (&blob, hd->fp);
522       if (rc)
523         break;
524
525       for (n=0; n < ndesc; n++) 
526         {
527           switch (desc[n].mode)
528             {
529             case KEYDB_SEARCH_MODE_NONE: 
530               never_reached ();
531               break;
532             case KEYDB_SEARCH_MODE_EXACT: 
533               if (has_subject_or_alt (blob, desc[n].u.name))
534                 goto found;
535               break;
536             case KEYDB_SEARCH_MODE_MAIL:
537               if (has_mail (blob, desc[n].u.name))
538                 goto found;
539               break;
540             case KEYDB_SEARCH_MODE_SUBSTR:
541             case KEYDB_SEARCH_MODE_MAILSUB:
542             case KEYDB_SEARCH_MODE_MAILEND:
543             case KEYDB_SEARCH_MODE_WORDS: 
544               never_reached (); /* not yet implemented */
545               break;
546             case KEYDB_SEARCH_MODE_ISSUER:
547               if (has_issuer (blob, desc[n].u.name))
548                 goto found;
549               break;
550             case KEYDB_SEARCH_MODE_ISSUER_SN:
551               if (has_issuer_sn (blob, desc[n].u.name,
552                                  sn_array? sn_array[n] : desc[n].sn))
553                 goto found;
554               break;
555             case KEYDB_SEARCH_MODE_SN:
556               if (has_sn (blob, sn_array? sn_array[n] : desc[n].sn))
557                 goto found;
558               break;
559             case KEYDB_SEARCH_MODE_SUBJECT:
560               if (has_subject (blob, desc[n].u.name))
561                 goto found;
562               break;
563             case KEYDB_SEARCH_MODE_SHORT_KID: 
564 /*                if (has_short_kid (blob, desc[n].u.kid[1])) */
565 /*                  goto found; */
566               break;
567             case KEYDB_SEARCH_MODE_LONG_KID:
568 /*                if (has_long_kid (blob, desc[n].u.kid)) */
569 /*                  goto found; */
570               break;
571             case KEYDB_SEARCH_MODE_FPR:
572               if (has_fingerprint (blob, desc[n].u.fpr))
573                 goto found;
574               break;
575             case KEYDB_SEARCH_MODE_FIRST: 
576               goto found;
577               break;
578             case KEYDB_SEARCH_MODE_NEXT: 
579               goto found;
580               break;
581             default: 
582               rc = KEYBOX_Invalid_Value;
583               goto found;
584             }
585         }
586       continue;
587     found:  
588       for (n=any_skip?0:ndesc; n < ndesc; n++) 
589         {
590 /*            if (desc[n].skipfnc */
591 /*                && desc[n].skipfnc (desc[n].skipfncvalue, aki)) */
592 /*              break; */
593         }
594       if (n == ndesc)
595         break; /* got it */
596     }
597   
598   if (!rc)
599     {
600       hd->found.blob = blob;
601     }
602   else if (rc == -1)
603     {
604       _keybox_release_blob (blob);
605       hd->eof = 1;
606     }
607   else 
608     {
609       _keybox_release_blob (blob);
610       hd->error = rc;
611     }
612
613   if (sn_array)
614     release_sn_array (sn_array, ndesc);
615
616   return rc;
617 }
618
619
620
621 \f
622 /*
623    Functions to return a certificate or a keyblock.  To be used after
624    a successful search operation.
625 */
626 #ifdef KEYBOX_WITH_X509
627 /*
628   Return the last found cert.  Caller must free it.
629  */
630 int
631 keybox_get_cert (KEYBOX_HANDLE hd, KsbaCert *r_cert)
632 {
633   const unsigned char *buffer;
634   size_t length;
635   size_t cert_off, cert_len;
636   KsbaReader reader = NULL;
637   KsbaCert cert = NULL;
638   int rc;
639
640   if (!hd)
641     return KEYBOX_Invalid_Value;
642   if (!hd->found.blob)
643     return KEYBOX_Nothing_Found;
644
645   if (blob_get_type (hd->found.blob) != BLOBTYPE_X509)
646     return KEYBOX_Wrong_Blob_Type;
647
648   buffer = _keybox_get_blob_image (hd->found.blob, &length);
649   if (length < 40)
650     return KEYBOX_Blob_Too_Short;
651   cert_off = get32 (buffer+8);
652   cert_len = get32 (buffer+12);
653   if (cert_off+cert_len > length)
654     return KEYBOX_Blob_Too_Short;
655
656   reader = ksba_reader_new ();
657   if (!reader)
658     return KEYBOX_Out_Of_Core;
659   rc = ksba_reader_set_mem (reader, buffer+cert_off, cert_len);
660   if (rc)
661     {
662       ksba_reader_release (reader);
663       /* fixme: need to map the error codes */
664       return KEYBOX_General_Error;
665     }
666
667   cert = ksba_cert_new ();
668   if (!cert)
669     {
670       ksba_reader_release (reader);
671       return KEYBOX_Out_Of_Core;
672     }
673
674   rc = ksba_cert_read_der (cert, reader);
675   if (rc)
676     {
677       ksba_cert_release (cert);
678       ksba_reader_release (reader);
679       /* fixme: need to map the error codes */
680       return KEYBOX_General_Error;
681     }
682
683   *r_cert = cert;
684   ksba_reader_release (reader);
685   return 0;
686 }
687
688 #endif /*KEYBOX_WITH_X509*/