add salted and iterated mode
[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  * Search for a key with the given fingerprint.
469  */
470 int
471 get_pubkey_byfprint( PKT_public_key *pk, const byte *fprint, size_t fprint_len)
472 {
473     int rc;
474
475     if( fprint_len == 20 || fprint_len == 16 )
476         rc = lookup( pk, fprint_len, NULL, fprint, NULL );
477     else
478         rc = G10ERR_GENERAL; /* Oops */
479     return rc;
480 }
481
482 /****************
483  * Search for a key with the given fingerprint and return the
484  * complete keyblock which may have more than only this key.
485  */
486 int
487 get_keyblock_byfprint( KBNODE *ret_keyblock, const byte *fprint,
488                                                 size_t fprint_len )
489 {
490     int rc;
491     PKT_public_key *pk = m_alloc_clear( sizeof *pk );
492
493     if( fprint_len == 20 || fprint_len == 16 )
494         rc = lookup( pk, fprint_len, NULL, fprint, ret_keyblock );
495     else
496         rc = G10ERR_GENERAL; /* Oops */
497
498     free_public_key( pk );
499     return rc;
500 }
501
502 /****************
503  * Get a secret key and store it into sk
504  */
505 int
506 get_seckey( PKT_secret_key *sk, u32 *keyid )
507 {
508     int rc;
509
510     rc = lookup_sk( sk, 11, keyid, NULL );
511     if( !rc ) {
512         /* check the secret key (this may prompt for a passprase to
513          * unlock the secret key
514          */
515         rc = check_secret_key( sk );
516     }
517
518     return rc;
519 }
520
521 /****************
522  * Check whether the secret key is available
523  * Returns: 0 := key is available
524  *          G10ERR_NO_SECKEY := not availabe
525  */
526 int
527 seckey_available( u32 *keyid )
528 {
529     PKT_secret_key *sk;
530     int rc;
531
532     sk = m_alloc_clear( sizeof *sk );
533     rc = lookup_sk( sk, 11, keyid, NULL );
534     free_secret_key( sk );
535     return rc;
536 }
537
538
539
540 /****************
541  * Get a secret key by name and store it into sk
542  * If NAME is NULL use the default key
543  */
544 int
545 get_seckey_byname( PKT_secret_key *sk, const char *name, int unprotect )
546 {
547     int rc;
548
549     if( !name && opt.def_secret_key && *opt.def_secret_key )
550         rc = key_byname( 1, NULL, sk, opt.def_secret_key );
551     else if( !name ) /* use the first one as default key */
552         rc = lookup_sk( sk, 15, NULL, NULL );
553     else
554         rc = key_byname( 1, NULL, sk, name );
555     if( !rc && unprotect )
556         rc = check_secret_key( sk );
557
558     return rc;
559 }
560
561
562 static int
563 compare_name( const char *uid, size_t uidlen, const char *name, int mode )
564 {
565     int i;
566     const char *s, *se;
567
568     if( mode == 1 ) {  /* exact match */
569         for(i=0; name[i] && uidlen; i++, uidlen-- )
570             if( uid[i] != name[i] )
571                 break;
572         if( !uidlen && !name[i] )
573             return 0; /* found */
574     }
575     else if( mode == 2 ) { /* case insensitive substring */
576         if( memistr( uid, uidlen, name ) )
577             return 0;
578     }
579     else if( mode >= 3 && mode <= 5 ) { /* look at the email address */
580         for( i=0, s= uid; i < uidlen && *s != '<'; s++, i++ )
581             ;
582         if( i < uidlen )  {
583             /* skip opening delim and one char and look for the closing one*/
584             s++; i++;
585             for( se=s+1, i++; i < uidlen && *se != '>'; se++, i++ )
586                 ;
587             if( i < uidlen ) {
588                 i = se - s;
589                 if( mode == 3 ) { /* exact email address */
590                     if( strlen(name) == i && !memicmp( s, name, i) )
591                         return 0;
592                 }
593                 else if( mode == 4 ) {  /* email substring */
594                     if( memistr( s, i, name ) )
595                         return 0;
596                 }
597                 else { /* email from end */
598                     /* nyi */
599                 }
600             }
601         }
602     }
603     else
604         BUG();
605
606     return -1; /* not found */
607 }
608
609
610
611 /****************
612  * Assume that knode points to a public key packet  and keyblock is
613  * the entire keyblock.  This function adds all relevant information from
614  * a selfsignature to the public key.
615  */
616
617 static void
618 add_stuff_from_selfsig( KBNODE keyblock, KBNODE knode )
619 {
620     PKT_public_key *pk = knode->pkt->pkt.public_key;
621     PKT_signature *sig;
622     KBNODE k;
623     u32 kid[2];
624
625     assert(    knode->pkt->pkttype == PKT_PUBLIC_KEY
626             || knode->pkt->pkttype == PKT_PUBLIC_SUBKEY );
627
628     if( pk->version < 4 )
629         return; /* this is only needed for version >=4 packets */
630
631     /* find the selfsignature */
632     if( knode->pkt->pkttype == PKT_PUBLIC_SUBKEY ) {
633         k = find_kbnode( keyblock, PKT_PUBLIC_KEY );
634         if( !k )
635            BUG(); /* keyblock without primary key!!! */
636         keyid_from_pk( knode->pkt->pkt.public_key, kid );
637     }
638     else
639         keyid_from_pk( pk, kid );
640     for(k=keyblock; k; k = k->next ) {
641         if( k->pkt->pkttype == PKT_SIGNATURE
642             && (sig=k->pkt->pkt.signature)->sig_class >= 0x10
643             && sig->sig_class <= 0x13
644             && sig->keyid[0] == kid[0]
645             && sig->keyid[1] == kid[1]
646             && sig->version > 3 ) {
647             /* okay this is (the first) self-signature which can be used
648              * fixme: Check how to handle subkey bindings
649              * FIXME: We should only use this if the signature is valid
650              *        but this is time consuming - we muts provide another
651              *        way to handle this
652              */
653             const byte *p;
654             p = parse_sig_subpkt( sig->hashed_data, SIGSUBPKT_KEY_EXPIRE, NULL );
655             pk->valid_days = p? ((buffer_to_u32(p)+86399L)/86400L):0;
656             /* fixme: add usage etc. to pk */
657             break;
658         }
659     }
660 }
661
662
663 /****************
664  * Lookup a key by scanning all keyrings
665  *   mode 1 = lookup by NAME (exact)
666  *        2 = lookup by NAME (substring)
667  *        3 = lookup by NAME (email address)
668  *        4 = email address (substring)
669  *        5 = email address (compare from end)
670  *       10 = lookup by short KEYID (don't care about keyid[0])
671  *       11 = lookup by long  KEYID
672  *       15 = Get the first key.
673  *       16 = lookup by 16 byte fingerprint which is stored in NAME
674  *       20 = lookup by 20 byte fingerprint which is stored in NAME
675  * Caller must provide an empty PK, if the pubkey_algo is filled in, only
676  * a key of this algo will be returned.
677  * If ret_keyblock is not NULL, the complete keyblock is returned also
678  * and the caller must release it.
679  */
680 static int
681 lookup( PKT_public_key *pk, int mode,  u32 *keyid,
682         const char *name, KBNODE *ret_keyblock )
683 {
684     int rc;
685     KBNODE keyblock = NULL;
686     KBPOS kbpos;
687     int oldmode = set_packet_list_mode(0);
688     byte namehash[20];
689     int use_namehash=0;
690
691     rc = enum_keyblocks( 0, &kbpos, &keyblock );
692     if( rc ) {
693         if( rc == -1 )
694             rc = G10ERR_NO_PUBKEY;
695         else if( rc )
696             log_error("enum_keyblocks(open) failed: %s\n", g10_errstr(rc) );
697         goto leave;
698     }
699
700     while( !(rc = enum_keyblocks( 1, &kbpos, &keyblock )) ) {
701         KBNODE k, kk;
702         if( mode < 10 ) { /* name lookup */
703             for(k=keyblock; k; k = k->next ) {
704                 if( k->pkt->pkttype == PKT_USER_ID
705                     && !compare_name( k->pkt->pkt.user_id->name,
706                                       k->pkt->pkt.user_id->len, name, mode)) {
707                     /* we found a matching name, look for the key */
708                     for(kk=keyblock; kk; kk = kk->next )
709                         if( (    kk->pkt->pkttype == PKT_PUBLIC_KEY
710                               || kk->pkt->pkttype == PKT_PUBLIC_SUBKEY )
711                             && ( !pk->pubkey_algo
712                                  || pk->pubkey_algo
713                                     == kk->pkt->pkt.public_key->pubkey_algo)
714                             && ( !pk->pubkey_usage
715                                  || !check_pubkey_algo2(
716                                        kk->pkt->pkt.public_key->pubkey_algo,
717                                                            pk->pubkey_usage ))
718                           )
719                         break;
720                     if( kk ) {
721                         u32 aki[2];
722                         keyid_from_pk( kk->pkt->pkt.public_key, aki );
723                         cache_user_id( k->pkt->pkt.user_id, aki );
724                         rmd160_hash_buffer( namehash,
725                                             k->pkt->pkt.user_id->name,
726                                             k->pkt->pkt.user_id->len );
727                         use_namehash = 1;
728                         k = kk;
729                         break;
730                     }
731                     else
732                         log_error("No key for userid\n");
733                 }
734             }
735         }
736         else { /* keyid or fingerprint lookup */
737             /* No need to compare the usage here, as we already have the
738              * keyid to use
739              */
740             if( DBG_CACHE && (mode== 10 || mode==11) ) {
741                 log_debug("lookup keyid=%08lx%08lx req_algo=%d mode=%d\n",
742                                 (ulong)keyid[0], (ulong)keyid[1],
743                                  pk->pubkey_algo, mode );
744             }
745             for(k=keyblock; k; k = k->next ) {
746                 if(    k->pkt->pkttype == PKT_PUBLIC_KEY
747                     || k->pkt->pkttype == PKT_PUBLIC_SUBKEY ) {
748                     if( mode == 10 || mode == 11 ) {
749                         u32 aki[2];
750                         keyid_from_pk( k->pkt->pkt.public_key, aki );
751                         if( DBG_CACHE ) {
752                             log_debug("         aki=%08lx%08lx algo=%d\n",
753                                             (ulong)aki[0], (ulong)aki[1],
754                                     k->pkt->pkt.public_key->pubkey_algo    );
755                         }
756                         if( aki[1] == keyid[1]
757                             && ( mode == 10 || aki[0] == keyid[0] )
758                             && ( !pk->pubkey_algo
759                                  || pk->pubkey_algo
760                                     == k->pkt->pkt.public_key->pubkey_algo) ){
761                             /* cache the userid */
762                             for(kk=keyblock; kk; kk = kk->next )
763                                 if( kk->pkt->pkttype == PKT_USER_ID )
764                                     break;
765                             if( kk )
766                                 cache_user_id( kk->pkt->pkt.user_id, aki );
767                             else
768                                 log_error("No userid for key\n");
769                             break; /* found */
770                         }
771                     }
772                     else if( mode == 15 ) { /* get the first key */
773                         if( !pk->pubkey_algo
774                             || pk->pubkey_algo
775                                   == k->pkt->pkt.public_key->pubkey_algo )
776                             break;
777                     }
778                     else if( mode == 16 || mode == 20 ) {
779                         size_t an;
780                         byte *afp = fingerprint_from_pk(
781                                         k->pkt->pkt.public_key, NULL, &an );
782
783                         if( DBG_CACHE ) {
784                             u32 aki[2];
785                             keyid_from_pk( k->pkt->pkt.public_key, aki );
786                             log_debug("         aki=%08lx%08lx algo=%d mode=%d an=%u\n",
787                                             (ulong)aki[0], (ulong)aki[1],
788                                     k->pkt->pkt.public_key->pubkey_algo,
789                                                         mode, an );
790                         }
791                         if( an == mode && !memcmp( afp, name, an)
792                             && ( !pk->pubkey_algo
793                                  || pk->pubkey_algo
794                                     == k->pkt->pkt.public_key->pubkey_algo) ) {
795                             m_free(afp);
796                             break;
797                         }
798                         m_free(afp);
799                     }
800                     else
801                         BUG();
802                 } /* end compare public keys */
803             }
804         }
805         if( k ) { /* found */
806             assert(    k->pkt->pkttype == PKT_PUBLIC_KEY
807                     || k->pkt->pkttype == PKT_PUBLIC_SUBKEY );
808             copy_public_key_new_namehash( pk, k->pkt->pkt.public_key,
809                                           use_namehash? namehash:NULL);
810             add_stuff_from_selfsig( keyblock, k );
811             if( ret_keyblock ) {
812                 *ret_keyblock = keyblock;
813                 keyblock = NULL;
814             }
815             break; /* enumeration */
816         }
817         release_kbnode( keyblock );
818         keyblock = NULL;
819     }
820     if( rc == -1 )
821         rc = G10ERR_NO_PUBKEY;
822     else if( rc )
823         log_error("enum_keyblocks(read) failed: %s\n", g10_errstr(rc));
824
825   leave:
826     enum_keyblocks( 2, &kbpos, &keyblock ); /* close */
827     release_kbnode( keyblock );
828     set_packet_list_mode(oldmode);
829     return rc;
830 }
831
832 /****************
833  * Ditto for secret keys
834  */
835 static int
836 lookup_sk( PKT_secret_key *sk, int mode,  u32 *keyid, const char *name )
837 {
838     int rc;
839     KBNODE keyblock = NULL;
840     KBPOS kbpos;
841     int oldmode = set_packet_list_mode(0);
842
843     rc = enum_keyblocks( 5 /* open secret */, &kbpos, &keyblock );
844     if( rc ) {
845         if( rc == -1 )
846             rc = G10ERR_NO_SECKEY;
847         else if( rc )
848             log_error("enum_keyblocks(open secret) failed: %s\n", g10_errstr(rc) );
849         goto leave;
850     }
851
852     while( !(rc = enum_keyblocks( 1, &kbpos, &keyblock )) ) {
853         KBNODE k, kk;
854         if( mode < 10 ) { /* name lookup */
855             for(k=keyblock; k; k = k->next ) {
856                 if( k->pkt->pkttype == PKT_USER_ID
857                     && !compare_name( k->pkt->pkt.user_id->name,
858                                       k->pkt->pkt.user_id->len, name, mode)) {
859                     /* we found a matching name, look for the key */
860                     for(kk=keyblock; kk; kk = kk->next )
861                         if( (    kk->pkt->pkttype == PKT_SECRET_KEY
862                               || kk->pkt->pkttype == PKT_SECRET_SUBKEY )
863                             && ( !sk->pubkey_algo
864                                  || sk->pubkey_algo
865                                     == kk->pkt->pkt.secret_key->pubkey_algo))
866                         break;
867                     if( kk ) {
868                         u32 aki[2];
869                         keyid_from_sk( kk->pkt->pkt.secret_key, aki );
870                         cache_user_id( k->pkt->pkt.user_id, aki );
871                         k = kk;
872                         break;
873                     }
874                     else
875                         log_error("No key for userid (in sk)\n");
876                 }
877             }
878         }
879         else { /* keyid or fingerprint lookup */
880             if( DBG_CACHE && (mode== 10 || mode==11) ) {
881                 log_debug("lookup_sk keyid=%08lx%08lx req_algo=%d mode=%d\n",
882                                 (ulong)keyid[0], (ulong)keyid[1],
883                                  sk->pubkey_algo, mode );
884             }
885             for(k=keyblock; k; k = k->next ) {
886                 if(    k->pkt->pkttype == PKT_SECRET_KEY
887                     || k->pkt->pkttype == PKT_SECRET_SUBKEY ) {
888                     if( mode == 10 || mode == 11 ) {
889                         u32 aki[2];
890                         keyid_from_sk( k->pkt->pkt.secret_key, aki );
891                         if( DBG_CACHE ) {
892                             log_debug("             aki=%08lx%08lx algo=%d\n",
893                                             (ulong)aki[0], (ulong)aki[1],
894                                     k->pkt->pkt.secret_key->pubkey_algo    );
895                         }
896                         if( aki[1] == keyid[1]
897                             && ( mode == 10 || aki[0] == keyid[0] )
898                             && ( !sk->pubkey_algo
899                                  || sk->pubkey_algo
900                                     == k->pkt->pkt.secret_key->pubkey_algo) ){
901                             /* cache the userid */
902                             for(kk=keyblock; kk; kk = kk->next )
903                                 if( kk->pkt->pkttype == PKT_USER_ID )
904                                     break;
905                             if( kk )
906                                 cache_user_id( kk->pkt->pkt.user_id, aki );
907                             else
908                                 log_error("No userid for key\n");
909                             break; /* found */
910                         }
911                     }
912                     else if( mode == 15 ) { /* get the first key */
913                         if( !sk->pubkey_algo
914                             || sk->pubkey_algo
915                                   == k->pkt->pkt.secret_key->pubkey_algo )
916                             break;
917                     }
918                     else if( mode == 16 || mode == 20 ) {
919                         size_t an;
920                         byte *afp = fingerprint_from_sk(
921                                         k->pkt->pkt.secret_key, NULL, &an );
922                         if( an == mode && !memcmp( afp, name, an)
923                             && ( !sk->pubkey_algo
924                                  || sk->pubkey_algo
925                                     == k->pkt->pkt.secret_key->pubkey_algo) ) {
926                             m_free(afp);
927                             break;
928                         }
929                         m_free(afp);
930                     }
931                     else
932                         BUG();
933                 } /* end compare secret keys */
934             }
935         }
936         if( k ) { /* found */
937             assert(    k->pkt->pkttype == PKT_SECRET_KEY
938                     || k->pkt->pkttype == PKT_SECRET_SUBKEY );
939             copy_secret_key( sk, k->pkt->pkt.secret_key );
940             break; /* enumeration */
941         }
942         release_kbnode( keyblock );
943         keyblock = NULL;
944     }
945     if( rc == -1 )
946         rc = G10ERR_NO_SECKEY;
947     else if( rc )
948         log_error("enum_keyblocks(read) failed: %s\n", g10_errstr(rc));
949
950   leave:
951     enum_keyblocks( 2, &kbpos, &keyblock ); /* close */
952     release_kbnode( keyblock );
953     set_packet_list_mode(oldmode);
954     return rc;
955 }
956
957
958
959 /****************
960  * Enumerate all primary secret keys.  Caller must use these procedure:
961  *  1) create a void pointer and initialize it to NULL
962  *  2) pass this void pointer by reference to this function
963  *     and provide space for the secret key (pass a buffer for sk)
964  *  3) call this function as long as it does not return -1
965  *     to indicate EOF.
966  *  4) Always call this function a last time with SK set to NULL,
967  *     so that can free it's context.
968  *
969  * Return
970  */
971 int
972 enum_secret_keys( void **context, PKT_secret_key *sk )
973 {
974     int rc=0;
975     PACKET pkt;
976     int save_mode;
977     enum_seckey_context_t *c = *context;
978
979     if( !c ) { /* make a new context */
980         c = m_alloc_clear( sizeof *c );
981         *context = c;
982         c->sl = secret_keyrings;
983     }
984
985     if( !sk ) { /* free the context */
986         m_free( c );
987         *context = NULL;
988         return 0;
989     }
990
991     if( c->eof )
992         return -1;
993
994     for( ; c->sl; c->sl = c->sl->next ) {
995         if( !c->iobuf ) {
996             if( !(c->iobuf = iobuf_open( c->sl->d ) ) ) {
997                 log_error("enum_secret_keys: can't open '%s'\n", c->sl->d );
998                 continue; /* try next file */
999             }
1000         }
1001
1002         save_mode = set_packet_list_mode(0);
1003         init_packet(&pkt);
1004         while( (rc=parse_packet(c->iobuf, &pkt)) != -1 ) {
1005             if( rc )
1006                 ; /* e.g. unknown packet */
1007             else if( pkt.pkttype == PKT_SECRET_KEY ) {
1008                 copy_secret_key( sk, pkt.pkt.secret_key );
1009                 set_packet_list_mode(save_mode);
1010                 return 0; /* found */
1011             }
1012             free_packet(&pkt);
1013         }
1014         set_packet_list_mode(save_mode);
1015         iobuf_close(c->iobuf); c->iobuf = NULL;
1016     }
1017     c->eof = 1;
1018     return -1;
1019 }
1020
1021
1022 /****************
1023  * Return a string with a printable representation of the user_id.
1024  * this string must be freed by m_free.
1025  */
1026 char*
1027 get_user_id_string( u32 *keyid )
1028 {
1029     user_id_db_t r;
1030     char *p;
1031     int pass=0;
1032     /* try it two times; second pass reads from keyrings */
1033     do {
1034         for(r=user_id_db; r; r = r->next )
1035             if( r->keyid[0] == keyid[0] && r->keyid[1] == keyid[1] ) {
1036                 p = m_alloc( r->len + 10 );
1037                 sprintf(p, "%08lX %.*s", (ulong)keyid[1], r->len, r->name );
1038                 return p;
1039             }
1040     } while( ++pass < 2 && !get_pubkey( NULL, keyid ) );
1041     p = m_alloc( 15 );
1042     sprintf(p, "%08lX [?]", (ulong)keyid[1] );
1043     return p;
1044 }
1045
1046 char*
1047 get_user_id( u32 *keyid, size_t *rn )
1048 {
1049     user_id_db_t r;
1050     char *p;
1051     int pass=0;
1052     /* try it two times; second pass reads from keyrings */
1053     do {
1054         for(r=user_id_db; r; r = r->next )
1055             if( r->keyid[0] == keyid[0] && r->keyid[1] == keyid[1] ) {
1056                 p = m_alloc( r->len );
1057                 memcpy(p, r->name, r->len );
1058                 *rn = r->len;
1059                 return p;
1060             }
1061     } while( ++pass < 2 && !get_pubkey( NULL, keyid ) );
1062     p = m_alloc( 19 );
1063     memcpy(p, "[User id not found]", 19 );
1064     *rn = 19;
1065     return p;
1066 }
1067
1068