We have reached a state where we are able to import certs and
[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
26 #include "keybox-defs.h"
27
28 static ulong
29 get32 (const byte *buffer)
30 {
31   ulong a;
32   a =  *buffer << 24;
33   a |= buffer[1] << 16;
34   a |= buffer[2] << 8;
35   a |= buffer[3];
36   return a;
37 }
38
39 static ulong
40 get16 (const byte *buffer)
41 {
42   ulong a;
43   a =  *buffer << 8;
44   a |= buffer[1];
45   return a;
46 }
47
48
49
50 static int
51 blob_get_type (KEYBOXBLOB blob)
52 {
53   const unsigned char *buffer;
54   size_t length;
55
56   buffer = _keybox_get_blob_image (blob, &length);
57   if (length < 40)
58     return -1; /* blob too short */
59
60   return buffer[4];
61 }
62
63
64 static int
65 blob_cmp_sn (KEYBOXBLOB blob, const unsigned char *sn)
66 {
67   size_t snlen;
68   const unsigned char *buffer;
69   size_t length;
70   size_t pos, off;
71   size_t nkeys, keyinfolen;
72   size_t nserial;
73
74   snlen = (sn[0] << 24) | (sn[1] << 16) | (sn[2] << 8) | sn[3];
75   sn += 4;
76
77   buffer = _keybox_get_blob_image (blob, &length);
78   if (length < 40)
79     return 0; /* blob too short */
80
81   /*keys*/
82   nkeys = get16 (buffer + 16);
83   keyinfolen = get16 (buffer + 18 );
84   if (keyinfolen < 28)
85     return 0; /* invalid blob */
86   pos = 20 + keyinfolen*nkeys;
87   if (pos+2 > length)
88     return 0; /* out of bounds */
89
90   /*serial*/
91   nserial = get16 (buffer+pos); 
92   off = pos + 2;
93   if (off+nserial > length)
94     return 0; /* out of bounds */
95
96   return nserial == snlen && !memcmp (buffer+off, sn, snlen);
97 }
98
99 static int
100 blob_cmp_name (KEYBOXBLOB blob, int idx, const char *name, size_t namelen)
101 {
102   const unsigned char *buffer;
103   size_t length;
104   size_t pos, off, len;
105   size_t nkeys, keyinfolen;
106   size_t nuids, uidinfolen;
107   size_t nserial;
108
109   buffer = _keybox_get_blob_image (blob, &length);
110   if (length < 40)
111     return 0; /* blob too short */
112
113   /*keys*/
114   nkeys = get16 (buffer + 16);
115   keyinfolen = get16 (buffer + 18 );
116   if (keyinfolen < 28)
117     return 0; /* invalid blob */
118   pos = 20 + keyinfolen*nkeys;
119   if (pos+2 > length)
120     return 0; /* out of bounds */
121
122   /*serial*/
123   nserial = get16 (buffer+pos); 
124   pos += 2 + nserial;
125   if (pos+4 > length)
126     return 0; /* out of bounds */
127
128   /* user ids*/
129   nuids = get16 (buffer + pos);  pos += 2;
130   uidinfolen = get16 (buffer + pos);  pos += 2;
131   if (uidinfolen < 12 /* should add a: || nuidinfolen > MAX_UIDINFOLEN */)
132     return 0; /* invalid blob */
133   if (pos + uidinfolen*nuids > length)
134     return 0; /* out of bounds */
135
136   if (idx > nuids)
137     return 0; /* no user ID with that idx */
138   pos += idx*uidinfolen;
139   off = get32 (buffer+pos);
140   len = get32 (buffer+pos+4);
141   if (off+len > length)
142     return 0; /* out of bounds */
143   if (len < 2)
144     return 0; /* empty name or 0 not stored */
145   len--;
146   
147   return len == namelen && !memcmp (buffer+off, name, len);
148 }
149
150
151
152 \f
153 /*
154   The has_foo functions are used as helpers for search 
155 */
156 #if 0
157 static int
158 has_short_kid (KEYBOXBLOB blob, u32 kid)
159 {
160   return 0;
161 }
162
163 static int
164 has_long_kid (KEYBOXBLOB blob, u32 *kid)
165 {
166   return 0;
167 }
168 #endif
169
170 static int
171 has_fingerprint (KEYBOXBLOB blob, const unsigned char *fpr)
172 {
173   return 0;
174 }
175
176
177 static int
178 has_issuer (KEYBOXBLOB blob, const char *name)
179 {
180   size_t namelen;
181
182   return_val_if_fail (name, 0);
183
184   if (blob_get_type (blob) != BLOBTYPE_X509)
185     return 0;
186
187   namelen = strlen (name);
188   return blob_cmp_name (blob, 0 /* issuer */, name, namelen);
189 }
190
191 static int
192 has_issuer_sn (KEYBOXBLOB blob, const char *name, const unsigned char *sn)
193 {
194   size_t namelen;
195
196   return_val_if_fail (name, 0);
197   return_val_if_fail (sn, 0);
198
199   if (blob_get_type (blob) != BLOBTYPE_X509)
200     return 0;
201
202   namelen = strlen (name);
203   
204   return (blob_cmp_sn (blob, sn)
205           && blob_cmp_name (blob, 0 /* issuer */, name, namelen));
206 }
207
208
209 \f
210 /*
211
212   The search API
213
214 */
215
216 int 
217 keybox_search_reset (KEYBOX_HANDLE hd)
218 {
219   if (!hd)
220     return KEYBOX_Invalid_Value;
221
222   if (hd->found.blob)
223     {
224       _keybox_release_blob (hd->found.blob);
225       hd->found.blob = NULL;
226     }
227
228   if (hd->fp)
229     {
230       fclose (hd->fp);
231       hd->fp = NULL;
232     }
233   hd->error = 0;
234   hd->eof = 0;
235   return 0;   
236 }
237
238 int 
239 keybox_search (KEYBOX_HANDLE hd, KEYBOX_SEARCH_DESC *desc, size_t ndesc)
240 {
241   int rc;
242   size_t n;
243   int need_words, any_skip;
244   KEYBOXBLOB blob = NULL;
245
246   if (!hd)
247     return KEYBOX_Invalid_Value;
248
249   /* clear last found result */
250   if (hd->found.blob)
251     {
252       _keybox_release_blob (hd->found.blob);
253       hd->found.blob = NULL;
254     }
255
256   if (hd->error)  
257     return hd->error; /* still in error state */
258   if (hd->eof)  
259     return -1; /* still EOF */
260
261   /* figure out what information we need */
262   need_words = any_skip = 0;
263   for (n=0; n < ndesc; n++) 
264     {
265       switch (desc[n].mode) 
266         {
267         case KEYDB_SEARCH_MODE_WORDS: 
268           need_words = 1;
269           break;
270         case KEYDB_SEARCH_MODE_FIRST:
271           /* always restart the search in this mode */
272           keybox_search_reset (hd);
273           break;
274         default:
275           break;
276         }
277       if (desc[n].skipfnc) 
278         any_skip = 1;
279     }
280
281   if (!hd->fp)
282     {
283       hd->fp = fopen (hd->kb->fname, "rb");
284       if (!hd->fp)
285           return (hd->error = KEYBOX_File_Open_Error);
286     }
287
288
289   for (;;)
290     {
291       _keybox_release_blob (blob); blob = NULL;
292       rc = _keybox_read_blob (&blob, hd->fp);
293       if (rc)
294         break;
295
296       for (n=0; n < ndesc; n++) 
297         {
298           switch (desc[n].mode)
299             {
300             case KEYDB_SEARCH_MODE_NONE: 
301               never_reached ();
302               break;
303             case KEYDB_SEARCH_MODE_EXACT: 
304             case KEYDB_SEARCH_MODE_SUBSTR:
305             case KEYDB_SEARCH_MODE_MAIL:
306             case KEYDB_SEARCH_MODE_MAILSUB:
307             case KEYDB_SEARCH_MODE_MAILEND:
308             case KEYDB_SEARCH_MODE_WORDS: 
309               never_reached (); /* not yet implemented */
310               break;
311             case KEYDB_SEARCH_MODE_ISSUER:
312               if (has_issuer (blob, desc[n].u.name))
313                 goto found;
314               break;
315             case KEYDB_SEARCH_MODE_ISSUER_SN:
316               if (has_issuer_sn (blob, desc[n].u.name, desc[n].sn))
317                 goto found;
318               break;
319             case KEYDB_SEARCH_MODE_SHORT_KID: 
320 /*                if (has_short_kid (blob, desc[n].u.kid[1])) */
321 /*                  goto found; */
322               break;
323             case KEYDB_SEARCH_MODE_LONG_KID:
324 /*                if (has_long_kid (blob, desc[n].u.kid)) */
325 /*                  goto found; */
326               break;
327             case KEYDB_SEARCH_MODE_FPR:
328               if (has_fingerprint (blob, desc[n].u.fpr))
329                 goto found;
330               break;
331             case KEYDB_SEARCH_MODE_FIRST: 
332               goto found;
333               break;
334             case KEYDB_SEARCH_MODE_NEXT: 
335               goto found;
336               break;
337             default: 
338               rc = KEYBOX_Invalid_Value;
339               goto found;
340             }
341         }
342       continue;
343     found:  
344       for (n=any_skip?0:ndesc; n < ndesc; n++) 
345         {
346 /*            if (desc[n].skipfnc */
347 /*                && desc[n].skipfnc (desc[n].skipfncvalue, aki)) */
348 /*              break; */
349         }
350       if (n == ndesc)
351         break; /* got it */
352     }
353   
354   if (!rc)
355     {
356       hd->found.blob = blob;
357     }
358   else if (rc == -1)
359     {
360       _keybox_release_blob (blob);
361       hd->eof = 1;
362     }
363   else 
364     {
365       _keybox_release_blob (blob);
366       hd->error = rc;
367     }
368
369   return rc;
370 }
371
372
373
374 \f
375 /*
376    Functions to return a certificate or a keyblock.  To be used after
377    a successful search operation.
378 */
379 #ifdef KEYBOX_WITH_X509
380 /*
381   Return the last found cert.  Caller must free it.
382  */
383 int
384 keybox_get_cert (KEYBOX_HANDLE hd, KsbaCert *r_cert)
385 {
386   const unsigned char *buffer;
387   size_t length;
388   size_t cert_off, cert_len;
389   KsbaReader reader = NULL;
390   KsbaCert cert = NULL;
391   int rc;
392
393   if (!hd)
394     return KEYBOX_Invalid_Value;
395   if (!hd->found.blob)
396     return KEYBOX_Nothing_Found;
397
398   if (blob_get_type (hd->found.blob) != BLOBTYPE_X509)
399     return KEYBOX_Wrong_Blob_Type;
400
401   buffer = _keybox_get_blob_image (hd->found.blob, &length);
402   if (length < 40)
403     return KEYBOX_Blob_Too_Short;
404   cert_off = get32 (buffer+8);
405   cert_len = get32 (buffer+12);
406   if (cert_off+cert_len > length)
407     return KEYBOX_Blob_Too_Short;
408
409   reader = ksba_reader_new ();
410   if (!reader)
411     return KEYBOX_Out_Of_Core;
412   rc = ksba_reader_set_mem (reader, buffer+cert_off, cert_len);
413   if (rc)
414     {
415       ksba_reader_release (reader);
416       /* fixme: need to map the error codes */
417       return KEYBOX_General_Error;
418     }
419
420   cert = ksba_cert_new ();
421   if (!cert)
422     {
423       ksba_reader_release (reader);
424       return KEYBOX_Out_Of_Core;
425     }
426
427   rc = ksba_cert_read_der (cert, reader);
428   if (rc)
429     {
430       ksba_cert_release (cert);
431       ksba_reader_release (reader);
432       /* fixme: need to map the error codes */
433       return KEYBOX_General_Error;
434     }
435
436   *r_cert = cert;
437   ksba_reader_release (reader);
438   return 0;
439 }
440
441 #endif /*KEYBOX_WITH_X509*/