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