intermediate release
[gnupg.git] / g10 / getkey.c
1 /* getkey.c -  Get a key from the database
2  *      Copyright (C) 1998 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 <stdio.h>
23 #include <stdlib.h>
24 #include <string.h>
25 #include <assert.h>
26 #include <ctype.h>
27 #include "util.h"
28 #include "packet.h"
29 #include "memory.h"
30 #include "iobuf.h"
31 #include "keydb.h"
32 #include "options.h"
33 #include "main.h"
34
35 #define MAX_PK_CACHE_ENTRIES 500
36
37
38 typedef struct keyid_list {
39     struct keyid_list *next;
40     u32 keyid[2];
41 } *keyid_list_t;
42
43 typedef struct user_id_db {
44     struct user_id_db *next;
45     u32 keyid[2];
46     int len;
47     char name[1];
48 } *user_id_db_t;
49
50 typedef struct pk_cache_entry {
51     struct pk_cache_entry *next;
52     u32 keyid[2];
53     PKT_public_key *pk;
54 } *pk_cache_entry_t;
55
56 typedef struct enum_seckey_context {
57     int eof;
58     STRLIST sl;
59     IOBUF iobuf;
60 } enum_seckey_context_t;
61
62
63 static STRLIST keyrings;
64 static STRLIST secret_keyrings;
65
66 static keyid_list_t unknown_keyids;
67 static user_id_db_t user_id_db;
68 static pk_cache_entry_t pk_cache;
69 static int pk_cache_entries;   /* number of entries in pk cache */
70
71
72 static int lookup( PKT_public_key *pk,
73                    int mode,  u32 *keyid, const char *name,
74                    KBNODE *ret_keyblock  );
75 static int lookup_sk( PKT_secret_key *sk,
76                    int mode,  u32 *keyid, const char *name );
77
78 /* note this function may be called before secure memory is
79  * available
80  * The first keyring which is added by this function is
81  * created if it does not exist.
82  */
83 void
84 add_keyring( const char *name )
85 {
86     STRLIST sl;
87     int rc, force = !keyrings;
88
89     if( *name != '/' ) { /* do tilde expansion etc */
90         char *p ;
91
92         if( strchr(name, '/') )
93             p = make_filename(name, NULL);
94         else
95             p = make_filename(opt.homedir, name, NULL);
96         sl = append_to_strlist( &keyrings, p );
97         m_free(p);
98     }
99     else
100         sl = append_to_strlist( &keyrings, name );
101
102     /* fixme: We should remove much out of this module and
103      * combine it with the keyblock stuff from ringedit.c
104      * For now we will simple add the filename as keyblock resource
105      */
106     rc = add_keyblock_resource( sl->d, force, 0 );
107     if( rc )
108         log_error("keyblock resource '%s': %s\n", sl->d, g10_errstr(rc) );
109 }
110
111
112 /****************
113  * Get the name of the keyrings, start with a sequence number of 0.
114  */
115 const char *
116 get_keyring( int sequence )
117 {
118     STRLIST sl;
119
120     for(sl = keyrings; sl && sequence; sl = sl->next, sequence-- )
121         ;
122     return sl? sl->d : NULL;
123 }
124
125 const char *
126 get_secret_keyring( int sequence )
127 {
128     STRLIST sl;
129
130     for(sl = secret_keyrings; sl && sequence; sl = sl->next, sequence-- )
131         ;
132     return sl? sl->d : NULL;
133 }
134
135
136 void
137 add_secret_keyring( const char *name )
138 {
139     STRLIST sl;
140     int rc, force = !secret_keyrings;
141
142     if( *name != '/' ) { /* do tilde expansion etc */
143         char *p ;
144
145         if( strchr(name, '/') )
146             p = make_filename(name, NULL);
147         else
148             p = make_filename(opt.homedir, name, NULL);
149         sl = append_to_strlist( &secret_keyrings, p );
150         m_free(p);
151     }
152     else
153         sl = append_to_strlist( &secret_keyrings, name );
154
155     /* fixme: We should remove much out of this module and
156      * combine it with the keyblock stuff from ringedit.c
157      * For now we will simple add the filename as keyblock resource
158      */
159     rc = add_keyblock_resource( sl->d, force, 1 );
160     if( rc )
161         log_error("secret keyblock resource '%s': %s\n", sl->d, g10_errstr(rc));
162 }
163
164
165 static void
166 cache_public_key( PKT_public_key *pk )
167 {
168     pk_cache_entry_t ce;
169     u32 keyid[2];
170
171     if( is_ELGAMAL(pk->pubkey_algo)
172         || pk->pubkey_algo == PUBKEY_ALGO_DSA
173         || is_RSA(pk->pubkey_algo) ) {
174         keyid_from_pk( pk, keyid );
175     }
176     else
177         return; /* don't know how to get the keyid */
178
179     for( ce = pk_cache; ce; ce = ce->next )
180         if( ce->keyid[0] == keyid[0] && ce->keyid[1] == keyid[1] ) {
181             if( DBG_CACHE )
182                 log_debug("cache_public_key: already in cache\n");
183             return;
184         }
185
186     if( pk_cache_entries > MAX_PK_CACHE_ENTRIES ) {
187         /* FIMXE: use another algorithm to free some cache slots */
188         if( pk_cache_entries == MAX_PK_CACHE_ENTRIES )  {
189             pk_cache_entries++;
190             log_info("too many entries in pk cache - disabled\n");
191         }
192         ce = pk_cache;
193         free_public_key( ce->pk );
194     }
195     else {
196         pk_cache_entries++;
197         ce = m_alloc( sizeof *ce );
198         ce->next = pk_cache;
199         pk_cache = ce;
200     }
201     ce->pk = copy_public_key( NULL, pk );
202     ce->keyid[0] = keyid[0];
203     ce->keyid[1] = keyid[1];
204 }
205
206
207 /****************
208  * Store the association of keyid and userid
209  */
210 void
211 cache_user_id( PKT_user_id *uid, u32 *keyid )
212 {
213     user_id_db_t r;
214
215     for(r=user_id_db; r; r = r->next )
216         if( r->keyid[0] == keyid[0] && r->keyid[1] == keyid[1] ) {
217             if( DBG_CACHE )
218                log_debug("cache_user_id: already in cache\n");
219             return;
220         }
221
222     r = m_alloc( sizeof *r + uid->len-1 );
223     r->keyid[0] = keyid[0];
224     r->keyid[1] = keyid[1];
225     r->len = uid->len;
226     memcpy(r->name, uid->name, r->len);
227     r->next = user_id_db;
228     user_id_db = r;
229 }
230
231
232
233 /****************
234  * Get a public key and store it into the allocated pk
235  * can be called with PK set to NULL to just read it into some
236  * internal structures.
237  */
238 int
239 get_pubkey( PKT_public_key *pk, u32 *keyid )
240 {
241     keyid_list_t kl;
242     int internal = 0;
243     int rc = 0;
244     pk_cache_entry_t ce;
245
246     /* let's see whether we checked the keyid already */
247     for( kl = unknown_keyids; kl; kl = kl->next )
248         if( kl->keyid[0] == keyid[0] && kl->keyid[1] == keyid[1] )
249             return G10ERR_NO_PUBKEY; /* already checked and not found */
250
251     /* Try to get it from our cache */
252     for( ce = pk_cache; ce; ce = ce->next )
253         if( ce->keyid[0] == keyid[0] && ce->keyid[1] == keyid[1] ) {
254             if( pk )
255                 copy_public_key( pk, ce->pk );
256             return 0;
257         }
258     /* more init stuff */
259     if( !pk ) {
260         pk = m_alloc_clear( sizeof *pk );
261         internal++;
262     }
263
264
265     /* do a lookup */
266     rc = lookup( pk, 11, keyid, NULL, NULL );
267     if( !rc )
268         goto leave;
269
270     /* not found: store it for future reference */
271     kl = m_alloc( sizeof *kl );
272     kl->keyid[0] = keyid[0];
273     kl->keyid[1] = keyid[1];
274     kl->next = unknown_keyids;
275     unknown_keyids = kl;
276     rc = G10ERR_NO_PUBKEY;
277
278   leave:
279     if( !rc )
280         cache_public_key( pk );
281     if( internal )
282         m_free(pk);
283     return rc;
284 }
285
286
287 static int
288 hextobyte( const byte *s )
289 {
290     int c;
291
292     if( *s >= '0' && *s <= '9' )
293         c = 16 * (*s - '0');
294     else if( *s >= 'A' && *s <= 'F' )
295         c = 16 * (10 + *s - 'A');
296     else if( *s >= 'a' && *s <= 'f' )
297         c = 16 * (10 + *s - 'a');
298     else
299         return -1;
300     s++;
301     if( *s >= '0' && *s <= '9' )
302         c += *s - '0';
303     else if( *s >= 'A' && *s <= 'F' )
304         c += 10 + *s - 'A';
305     else if( *s >= 'a' && *s <= 'f' )
306         c += 10 + *s - 'a';
307     else
308         return -1;
309     return c;
310 }
311
312
313 /****************
314  * Try to get the pubkey by the userid. This function looks for the
315  * first pubkey certificate which has the given name in a user_id.
316  * if pk has the pubkey algo set, the function will only return
317  * a pubkey with that algo.
318  *
319  * - If the username starts with 8,9,16 or 17 hex-digits (the first one
320  *   must be in the range 0..9), this is considered a keyid; depending
321  *   on the length a short or complete one.
322  * - If the username starts with 32,33,40 or 41 hex-digits (the first one
323  *   must be in the range 0..9), this is considered a fingerprint.
324  *   (Not yet implemented)
325  * - If the username starts with a left angle, we assume it is a complete
326  *   email address and look only at this part.
327  * - If the username starts with a '.', we assume it is the ending
328  *   part of an email address
329  * - If the username starts with an '@', we assume it is a part of an
330  *   email address
331  * - If the userid start with an '=' an exact compare is done; this may
332  *   also follow the keyid in which case both parts are matched.
333  * - If the userid starts with a '*' a case insensitive substring search is
334  *   done (This is also the default).
335  */
336
337
338 static int
339 key_byname( int secret,
340             PKT_public_key *pk, PKT_secret_key *sk, const char *name )
341 {
342     int internal = 0;
343     int rc = 0;
344     const char *s;
345     u32 keyid[2] = {0}; /* init to avoid compiler warning */
346     byte fprint[20];
347     int mode = 0;
348
349     /* check what kind of name it is */
350     for(s = name; *s && isspace(*s); s++ )
351         ;
352     if( isdigit( *s ) ) { /* a keyid or a fingerprint */
353         int i, j;
354         char buf[9];
355
356         if( *s == '0' && s[1] == 'x' && isxdigit(s[2]) )
357             s += 2; /*kludge to allow 0x034343434 */
358         for(i=0; isxdigit(s[i]); i++ )
359             ;
360         if( s[i] && !isspace(s[i]) ) /* not terminated by EOS or blank*/
361             rc = G10ERR_INV_USER_ID;
362         else if( i == 8 || (i == 9 && *s == '0') ) { /* short keyid */
363             if( i==9 )
364                 s++;
365             keyid[1] = strtoul( s, NULL, 16 );
366             mode = 10;
367         }
368         else if( i == 16 || (i == 17 && *s == '0') ) { /* complete keyid */
369             if( i==17 )
370                 s++;
371             mem2str(buf, s, 9 );
372             keyid[0] = strtoul( buf, NULL, 16 );
373             keyid[1] = strtoul( s+8, NULL, 16 );
374             mode = 11;
375         }
376         else if( i == 32 || ( i == 33 && *s == '0' ) ) { /* md5 fingerprint */
377             if( i==33 )
378                 s++;
379             memset(fprint+16, 4, 0);
380             for(j=0; !rc && j < 16; j++, s+=2 ) {
381                 int c = hextobyte( s );
382                 if( c == -1 )
383                     rc = G10ERR_INV_USER_ID;
384                 else
385                     fprint[j] = c;
386             }
387             mode = 16;
388         }
389         else if( i == 40 || ( i == 41 && *s == '0' ) ) { /* sha1/rmd160 fprint*/
390             if( i==33 )
391                 s++;
392             for(j=0; !rc && j < 20; j++, s+=2 ) {
393                 int c = hextobyte( s );
394                 if( c == -1 )
395                     rc = G10ERR_INV_USER_ID;
396                 else
397                     fprint[j] = c;
398             }
399             mode = 20;
400         }
401         else
402             rc = G10ERR_INV_USER_ID;
403     }
404     else if( *s == '=' ) { /* exact search */
405         mode = 1;
406         s++;
407     }
408     else if( *s == '*' ) { /* substring search */
409         mode = 2;
410         s++;
411     }
412     else if( *s == '<' ) { /* an email address */
413         mode = 3;
414     }
415     else if( *s == '@' ) { /* a part of an email address */
416         mode = 4;
417         s++;
418     }
419     else if( *s == '.' ) { /* an email address, compare from end */
420         mode = 5;
421         s++;
422     }
423     else if( *s == '#' ) { /* use local id */
424         rc = G10ERR_INV_USER_ID; /* not yet implemented */
425     }
426     else if( !*s )  /* empty string */
427         rc = G10ERR_INV_USER_ID;
428     else
429         mode = 2;
430
431     if( rc )
432         goto leave;
433
434     if( secret ) {
435         if( !sk ) {
436             sk = m_alloc_clear( sizeof *sk );
437             internal++;
438         }
439         rc = mode < 16? lookup_sk( sk, mode, keyid, name )
440                       : lookup_sk( sk, mode, keyid, fprint );
441     }
442     else {
443         if( !pk ) {
444             pk = m_alloc_clear( sizeof *pk );
445             internal++;
446         }
447         rc = mode < 16? lookup( pk, mode, keyid, name, NULL )
448                       : lookup( pk, mode, keyid, fprint, NULL );
449     }
450
451
452   leave:
453     if( internal && secret )
454         m_free( sk );
455     else if( internal )
456         m_free( pk );
457     return rc;
458 }
459
460 int
461 get_pubkey_byname( PKT_public_key *pk, const char *name )
462 {
463     return key_byname( 0, pk, NULL, name );
464 }
465
466
467
468 /****************
469  * Search for a key with the given fingerprint and return the
470  * complete keyblock which may have more than only this key.
471  */
472 int
473 get_keyblock_byfprint( KBNODE *ret_keyblock, const byte *fprint,
474                                                 size_t fprint_len )
475 {
476     int rc;
477     PKT_public_key *pk = m_alloc_clear( sizeof *pk );
478
479     if( fprint_len == 20 || fprint_len == 16 )
480         rc = lookup( pk, fprint_len, NULL, fprint, ret_keyblock );
481     else
482         rc = G10ERR_GENERAL; /* Oops */
483
484     free_public_key( pk );
485     return rc;
486 }
487
488 /****************
489  * Get a secret key and store it into sk
490  */
491 int
492 get_seckey( PKT_secret_key *sk, u32 *keyid )
493 {
494     int rc;
495
496     rc = lookup_sk( sk, 11, keyid, NULL );
497     if( !rc ) {
498         /* check the secret key (this may prompt for a passprase to
499          * unlock the secret key
500          */
501         rc = check_secret_key( sk );
502     }
503
504     return rc;
505 }
506
507 /****************
508  * Check whether the secret key is available
509  * Returns: 0 := key is available
510  *          G10ERR_NO_SECKEY := not availabe
511  */
512 int
513 seckey_available( u32 *keyid )
514 {
515     PKT_secret_key *sk;
516     int rc;
517
518     sk = m_alloc_clear( sizeof *sk );
519     rc = lookup_sk( sk, 11, keyid, NULL );
520     free_secret_key( sk );
521     return rc;
522 }
523
524
525
526 /****************
527  * Get a secret key by name and store it into sk
528  * If NAME is NULL use the default key
529  */
530 int
531 get_seckey_byname( PKT_secret_key *sk, const char *name, int unprotect )
532 {
533     int rc;
534
535     rc = name ? key_byname( 1, NULL, sk, name )
536               : lookup_sk( sk, 15, NULL, NULL );
537     if( !rc && unprotect )
538         rc = check_secret_key( sk );
539
540     return rc;
541 }
542
543
544 static int
545 compare_name( const char *uid, size_t uidlen, const char *name, int mode )
546 {
547     int i;
548     const char *s, *se;
549
550     if( mode == 1 ) {  /* exact match */
551         for(i=0; name[i] && uidlen; i++, uidlen-- )
552             if( uid[i] != name[i] )
553                 break;
554         if( !uidlen && !name[i] )
555             return 0; /* found */
556     }
557     else if( mode == 2 ) { /* case insensitive substring */
558         if( memistr( uid, uidlen, name ) )
559             return 0;
560     }
561     else if( mode >= 3 && mode <= 5 ) { /* look at the email address */
562         for( i=0, s= uid; i < uidlen && *s != '<'; s++, i++ )
563             ;
564         if( i < uidlen )  {
565             /* skip opening delim and one char and look for the closing one*/
566             s++; i++;
567             for( se=s+1, i++; i < uidlen && *se != '>'; se++, i++ )
568                 ;
569             if( i < uidlen ) {
570                 i = se - s;
571                 if( mode == 3 ) { /* exact email address */
572                     if( strlen(name) == i && !memicmp( s, name, i) )
573                         return 0;
574                 }
575                 else if( mode == 4 ) {  /* email substring */
576                     if( memistr( s, i, name ) )
577                         return 0;
578                 }
579                 else { /* email from end */
580                     /* nyi */
581                 }
582             }
583         }
584     }
585     else
586         BUG();
587
588     return -1; /* not found */
589 }
590
591
592
593 /****************
594  * Assume that knode points to a public key packet  and keyblock is
595  * the entire keyblock.  This function adds all relevant information from
596  * a selfsignature to the public key.
597  */
598
599 static void
600 add_stuff_from_selfsig( KBNODE keyblock, KBNODE knode )
601 {
602     PKT_public_key *pk = knode->pkt->pkt.public_key;
603     PKT_signature *sig;
604     KBNODE k;
605     u32 kid[2];
606
607     assert(    knode->pkt->pkttype == PKT_PUBLIC_KEY
608             || knode->pkt->pkttype == PKT_PUBLIC_SUBKEY );
609
610     if( pk->version < 4 )
611         return; /* this is only needed for version >=4 packets */
612
613     /* find the selfsignature */
614     if( knode->pkt->pkttype == PKT_PUBLIC_SUBKEY ) {
615         k = find_kbnode( keyblock, PKT_PUBLIC_KEY );
616         if( !k )
617            BUG(); /* keyblock without primary key!!! */
618         keyid_from_pk( knode->pkt->pkt.public_key, kid );
619     }
620     else
621         keyid_from_pk( pk, kid );
622     for(k=keyblock; k; k = k->next ) {
623         if( k->pkt->pkttype == PKT_SIGNATURE
624             && (sig=k->pkt->pkt.signature)->sig_class >= 0x10
625             && sig->sig_class <= 0x13
626             && sig->keyid[0] == kid[0]
627             && sig->keyid[1] == kid[1]
628             && sig->version > 3 ) {
629             /* okay this is (the first) self-signature which can be used
630              * fixme: Check how to handle subkey bindings
631              * FIXME: We should only use this if the signature is valid
632              *        but this is time consuming - we muts provide another
633              *        way to handle this
634              */
635             const byte *p;
636             p = parse_sig_subpkt( sig->hashed_data, SIGSUBPKT_KEY_EXPIRE, NULL );
637             pk->valid_days = p? ((buffer_to_u32(p)+86399L)/86400L):0;
638             /* fixme: add usage etc. to pk */
639             break;
640         }
641     }
642 }
643
644
645 /****************
646  * Lookup a key by scanning all keyrings
647  *   mode 1 = lookup by NAME (exact)
648  *        2 = lookup by NAME (substring)
649  *        3 = lookup by NAME (email address)
650  *        4 = email address (substring)
651  *        5 = email address (compare from end)
652  *       10 = lookup by short KEYID (don't care about keyid[0])
653  *       11 = lookup by long  KEYID
654  *       15 = Get the first key.
655  *       16 = lookup by 16 byte fingerprint which is stored in NAME
656  *       20 = lookup by 20 byte fingerprint which is stored in NAME
657  * Caller must provide an empty PK, if the pubkey_algo is filled in, only
658  * a key of this algo will be returned.
659  * If ret_keyblock is not NULL, the complete keyblock is returned also
660  * and the caller must release it.
661  */
662 static int
663 lookup( PKT_public_key *pk, int mode,  u32 *keyid,
664         const char *name, KBNODE *ret_keyblock )
665 {
666     int rc;
667     KBNODE keyblock = NULL;
668     KBPOS kbpos;
669     int oldmode = set_packet_list_mode(0);
670
671     rc = enum_keyblocks( 0, &kbpos, &keyblock );
672     if( rc ) {
673         if( rc == -1 )
674             rc = G10ERR_NO_PUBKEY;
675         else if( rc )
676             log_error("enum_keyblocks(open) failed: %s\n", g10_errstr(rc) );
677         goto leave;
678     }
679
680     while( !(rc = enum_keyblocks( 1, &kbpos, &keyblock )) ) {
681         KBNODE k, kk;
682         if( mode < 10 ) { /* name lookup */
683             for(k=keyblock; k; k = k->next ) {
684                 if( k->pkt->pkttype == PKT_USER_ID
685                     && !compare_name( k->pkt->pkt.user_id->name,
686                                       k->pkt->pkt.user_id->len, name, mode)) {
687                     /* we found a matching name, look for the key */
688                     for(kk=keyblock; kk; kk = kk->next )
689                         if( (    kk->pkt->pkttype == PKT_PUBLIC_KEY
690                               || kk->pkt->pkttype == PKT_PUBLIC_SUBKEY )
691                             && ( !pk->pubkey_algo
692                                  || pk->pubkey_algo
693                                     == kk->pkt->pkt.public_key->pubkey_algo)
694                             && ( !pk->pubkey_usage
695                                  || !check_pubkey_algo2(
696                                        kk->pkt->pkt.public_key->pubkey_algo,
697                                                            pk->pubkey_usage ))
698                           )
699                         break;
700                     if( kk ) {
701                         u32 aki[2];
702                         keyid_from_pk( kk->pkt->pkt.public_key, aki );
703                         cache_user_id( k->pkt->pkt.user_id, aki );
704                         k = kk;
705                         break;
706                     }
707                     else
708                         log_error("No key for userid\n");
709                 }
710             }
711         }
712         else { /* keyid or fingerprint lookup */
713             /* No need to compare the usage here, as we already have the
714              * keyid to use
715              */
716             if( DBG_CACHE && (mode== 10 || mode==11) ) {
717                 log_debug("lookup keyid=%08lx%08lx req_algo=%d mode=%d\n",
718                                 (ulong)keyid[0], (ulong)keyid[1],
719                                  pk->pubkey_algo, mode );
720             }
721             for(k=keyblock; k; k = k->next ) {
722                 if(    k->pkt->pkttype == PKT_PUBLIC_KEY
723                     || k->pkt->pkttype == PKT_PUBLIC_SUBKEY ) {
724                     if( mode == 10 || mode == 11 ) {
725                         u32 aki[2];
726                         keyid_from_pk( k->pkt->pkt.public_key, aki );
727                         if( DBG_CACHE ) {
728                             log_debug("         aki=%08lx%08lx algo=%d\n",
729                                             (ulong)aki[0], (ulong)aki[1],
730                                     k->pkt->pkt.public_key->pubkey_algo    );
731                         }
732                         if( aki[1] == keyid[1]
733                             && ( mode == 10 || aki[0] == keyid[0] )
734                             && ( !pk->pubkey_algo
735                                  || pk->pubkey_algo
736                                     == k->pkt->pkt.public_key->pubkey_algo) ){
737                             /* cache the userid */
738                             for(kk=keyblock; kk; kk = kk->next )
739                                 if( kk->pkt->pkttype == PKT_USER_ID )
740                                     break;
741                             if( kk )
742                                 cache_user_id( kk->pkt->pkt.user_id, aki );
743                             else
744                                 log_error("No userid for key\n");
745                             break; /* found */
746                         }
747                     }
748                     else if( mode == 15 ) { /* get the first key */
749                         if( !pk->pubkey_algo
750                             || pk->pubkey_algo
751                                   == k->pkt->pkt.public_key->pubkey_algo )
752                             break;
753                     }
754                     else if( mode == 16 || mode == 20 ) {
755                         size_t an;
756                         byte *afp = fingerprint_from_pk(
757                                         k->pkt->pkt.public_key, &an );
758                         if( an == mode && !memcmp( afp, name, an)
759                             && ( !pk->pubkey_algo
760                                  || pk->pubkey_algo
761                                     == k->pkt->pkt.public_key->pubkey_algo) ) {
762                             m_free(afp);
763                             break;
764                         }
765                         m_free(afp);
766                     }
767                     else
768                         BUG();
769                 } /* end compare public keys */
770             }
771         }
772         if( k ) { /* found */
773             assert(    k->pkt->pkttype == PKT_PUBLIC_KEY
774                     || k->pkt->pkttype == PKT_PUBLIC_SUBKEY );
775             copy_public_key( pk, k->pkt->pkt.public_key );
776             add_stuff_from_selfsig( keyblock, k );
777             if( ret_keyblock ) {
778                 *ret_keyblock = keyblock;
779                 keyblock = NULL;
780             }
781             break; /* enumeration */
782         }
783         release_kbnode( keyblock );
784         keyblock = NULL;
785     }
786     if( rc == -1 )
787         rc = G10ERR_NO_PUBKEY;
788     else if( rc )
789         log_error("enum_keyblocks(read) failed: %s\n", g10_errstr(rc));
790
791   leave:
792     enum_keyblocks( 2, &kbpos, &keyblock ); /* close */
793     release_kbnode( keyblock );
794     set_packet_list_mode(oldmode);
795     return rc;
796 }
797
798 /****************
799  * Ditto for secret keys
800  */
801 static int
802 lookup_sk( PKT_secret_key *sk, int mode,  u32 *keyid, const char *name )
803 {
804     int rc;
805     KBNODE keyblock = NULL;
806     KBPOS kbpos;
807     int oldmode = set_packet_list_mode(0);
808
809     rc = enum_keyblocks( 5 /* open secret */, &kbpos, &keyblock );
810     if( rc ) {
811         if( rc == -1 )
812             rc = G10ERR_NO_SECKEY;
813         else if( rc )
814             log_error("enum_keyblocks(open secret) failed: %s\n", g10_errstr(rc) );
815         goto leave;
816     }
817
818     while( !(rc = enum_keyblocks( 1, &kbpos, &keyblock )) ) {
819         KBNODE k, kk;
820         if( mode < 10 ) { /* name lookup */
821             for(k=keyblock; k; k = k->next ) {
822                 if( k->pkt->pkttype == PKT_USER_ID
823                     && !compare_name( k->pkt->pkt.user_id->name,
824                                       k->pkt->pkt.user_id->len, name, mode)) {
825                     /* we found a matching name, look for the key */
826                     for(kk=keyblock; kk; kk = kk->next )
827                         if( (    kk->pkt->pkttype == PKT_SECRET_KEY
828                               || kk->pkt->pkttype == PKT_SECRET_SUBKEY )
829                             && ( !sk->pubkey_algo
830                                  || sk->pubkey_algo
831                                     == kk->pkt->pkt.secret_key->pubkey_algo))
832                         break;
833                     if( kk ) {
834                         u32 aki[2];
835                         keyid_from_sk( kk->pkt->pkt.secret_key, aki );
836                         cache_user_id( k->pkt->pkt.user_id, aki );
837                         k = kk;
838                         break;
839                     }
840                     else
841                         log_error("No key for userid (in sk)\n");
842                 }
843             }
844         }
845         else { /* keyid or fingerprint lookup */
846             if( DBG_CACHE && (mode== 10 || mode==11) ) {
847                 log_debug("lookup_sk keyid=%08lx%08lx req_algo=%d mode=%d\n",
848                                 (ulong)keyid[0], (ulong)keyid[1],
849                                  sk->pubkey_algo, mode );
850             }
851             for(k=keyblock; k; k = k->next ) {
852                 if(    k->pkt->pkttype == PKT_SECRET_KEY
853                     || k->pkt->pkttype == PKT_SECRET_SUBKEY ) {
854                     if( mode == 10 || mode == 11 ) {
855                         u32 aki[2];
856                         keyid_from_sk( k->pkt->pkt.secret_key, aki );
857                         if( DBG_CACHE ) {
858                             log_debug("             aki=%08lx%08lx algo=%d\n",
859                                             (ulong)aki[0], (ulong)aki[1],
860                                     k->pkt->pkt.secret_key->pubkey_algo    );
861                         }
862                         if( aki[1] == keyid[1]
863                             && ( mode == 10 || aki[0] == keyid[0] )
864                             && ( !sk->pubkey_algo
865                                  || sk->pubkey_algo
866                                     == k->pkt->pkt.secret_key->pubkey_algo) ){
867                             /* cache the userid */
868                             for(kk=keyblock; kk; kk = kk->next )
869                                 if( kk->pkt->pkttype == PKT_USER_ID )
870                                     break;
871                             if( kk )
872                                 cache_user_id( kk->pkt->pkt.user_id, aki );
873                             else
874                                 log_error("No userid for key\n");
875                             break; /* found */
876                         }
877                     }
878                     else if( mode == 15 ) { /* get the first key */
879                         if( !sk->pubkey_algo
880                             || sk->pubkey_algo
881                                   == k->pkt->pkt.secret_key->pubkey_algo )
882                             break;
883                     }
884                     else if( mode == 16 || mode == 20 ) {
885                         size_t an;
886                         byte *afp = fingerprint_from_sk(
887                                         k->pkt->pkt.secret_key, &an );
888                         if( an == mode && !memcmp( afp, name, an)
889                             && ( !sk->pubkey_algo
890                                  || sk->pubkey_algo
891                                     == k->pkt->pkt.secret_key->pubkey_algo) ) {
892                             m_free(afp);
893                             break;
894                         }
895                         m_free(afp);
896                     }
897                     else
898                         BUG();
899                 } /* end compare secret keys */
900             }
901         }
902         if( k ) { /* found */
903             assert(    k->pkt->pkttype == PKT_SECRET_KEY
904                     || k->pkt->pkttype == PKT_SECRET_SUBKEY );
905             copy_secret_key( sk, k->pkt->pkt.secret_key );
906             break; /* enumeration */
907         }
908         release_kbnode( keyblock );
909         keyblock = NULL;
910     }
911     if( rc == -1 )
912         rc = G10ERR_NO_SECKEY;
913     else if( rc )
914         log_error("enum_keyblocks(read) failed: %s\n", g10_errstr(rc));
915
916   leave:
917     enum_keyblocks( 2, &kbpos, &keyblock ); /* close */
918     release_kbnode( keyblock );
919     set_packet_list_mode(oldmode);
920     return rc;
921 }
922
923
924
925 /****************
926  * Enumerate all secret keys.  Caller must use these procedure:
927  *  1) create a void pointer and initialize it to NULL
928  *  2) pass this void pointer by reference to this function
929  *     and provide space for the secret key (pass a buffer for sk)
930  *  3) call this function as long as it does not return -1
931  *     to indicate EOF.
932  *  4) Always call this function a last time with SK set to NULL,
933  *     so that can free it's context.
934  *
935  * Return
936  */
937 int
938 enum_secret_keys( void **context, PKT_secret_key *sk )
939 {
940     int rc=0;
941     PACKET pkt;
942     int save_mode;
943     enum_seckey_context_t *c = *context;
944
945     if( !c ) { /* make a new context */
946         c = m_alloc_clear( sizeof *c );
947         *context = c;
948         c->sl = secret_keyrings;
949     }
950
951     if( !sk ) { /* free the context */
952         m_free( c );
953         *context = NULL;
954         return 0;
955     }
956
957     if( c->eof )
958         return -1;
959
960     for( ; c->sl; c->sl = c->sl->next ) {
961         if( !c->iobuf ) {
962             if( !(c->iobuf = iobuf_open( c->sl->d ) ) ) {
963                 log_error("enum_secret_keys: can't open '%s'\n", c->sl->d );
964                 continue; /* try next file */
965             }
966         }
967
968         save_mode = set_packet_list_mode(0);
969         init_packet(&pkt);
970         while( (rc=parse_packet(c->iobuf, &pkt)) != -1 ) {
971             if( rc )
972                 ; /* e.g. unknown packet */
973             else if( pkt.pkttype == PKT_SECRET_KEY
974                     || pkt.pkttype == PKT_SECRET_SUBKEY ) {
975                 copy_secret_key( sk, pkt.pkt.secret_key );
976                 set_packet_list_mode(save_mode);
977                 return 0; /* found */
978             }
979             free_packet(&pkt);
980         }
981         set_packet_list_mode(save_mode);
982         iobuf_close(c->iobuf); c->iobuf = NULL;
983     }
984     c->eof = 1;
985     return -1;
986 }
987
988
989 /****************
990  * Return a string with a printable representation of the user_id.
991  * this string must be freed by m_free.
992  */
993 char*
994 get_user_id_string( u32 *keyid )
995 {
996     user_id_db_t r;
997     char *p;
998     int pass=0;
999     /* try it two times; second pass reads from keyrings */
1000     do {
1001         for(r=user_id_db; r; r = r->next )
1002             if( r->keyid[0] == keyid[0] && r->keyid[1] == keyid[1] ) {
1003                 p = m_alloc( r->len + 10 );
1004                 sprintf(p, "%08lX %.*s", (ulong)keyid[1], r->len, r->name );
1005                 return p;
1006             }
1007     } while( ++pass < 2 && !get_pubkey( NULL, keyid ) );
1008     p = m_alloc( 15 );
1009     sprintf(p, "%08lX [?]", (ulong)keyid[1] );
1010     return p;
1011 }
1012
1013 char*
1014 get_user_id( u32 *keyid, size_t *rn )
1015 {
1016     user_id_db_t r;
1017     char *p;
1018     int pass=0;
1019     /* try it two times; second pass reads from keyrings */
1020     do {
1021         for(r=user_id_db; r; r = r->next )
1022             if( r->keyid[0] == keyid[0] && r->keyid[1] == keyid[1] ) {
1023                 p = m_alloc( r->len );
1024                 memcpy(p, r->name, r->len );
1025                 *rn = r->len;
1026                 return p;
1027             }
1028     } while( ++pass < 2 && !get_pubkey( NULL, keyid ) );
1029     p = m_alloc( 19 );
1030     memcpy(p, "[User id not found]", 19 );
1031     *rn = 19;
1032     return p;
1033 }
1034
1035