2006-09-06 Marcus Brinkmann <marcus@g10code.de>
[gnupg.git] / g10 / keyserver.c
blob125872e1cbf3229148c053e9fba1a0a7291b5528
1 /* keyserver.c - generic keyserver code
2 * Copyright (C) 2001, 2002, 2003, 2004, 2005,
3 * 2006 Free Software Foundation, Inc.
5 * This file is part of GnuPG.
7 * GnuPG is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * GnuPG is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
20 * USA.
23 #include <config.h>
24 #include <ctype.h>
25 #include <stdio.h>
26 #include <string.h>
27 #include <stdlib.h>
28 #include <assert.h>
29 #include <errno.h>
31 #include "gpg.h"
32 #include "iobuf.h"
33 #include "filter.h"
34 #include "keydb.h"
35 #include "status.h"
36 #include "exec.h"
37 #include "main.h"
38 #include "i18n.h"
39 #include "ttyio.h"
40 #include "options.h"
41 #include "packet.h"
42 #include "trustdb.h"
43 #include "keyserver-internal.h"
44 #include "util.h"
45 #include "dns-cert.h"
46 #include "pka.h"
49 struct keyrec
51 KEYDB_SEARCH_DESC desc;
52 u32 createtime,expiretime;
53 int size,flags;
54 byte type;
55 IOBUF uidbuf;
56 unsigned int lines;
59 enum ks_action {KS_UNKNOWN=0,KS_GET,KS_GETNAME,KS_SEND,KS_SEARCH};
61 static struct parse_options keyserver_opts[]=
63 /* some of these options are not real - just for the help
64 message */
65 {"max-cert-size",0,NULL,NULL},
66 {"include-revoked",0,NULL,N_("include revoked keys in search results")},
67 {"include-subkeys",0,NULL,N_("include subkeys when searching by key ID")},
68 {"use-temp-files",0,NULL,
69 N_("use temporary files to pass data to keyserver helpers")},
70 {"keep-temp-files",KEYSERVER_KEEP_TEMP_FILES,NULL,
71 N_("do not delete temporary files after using them")},
72 {"refresh-add-fake-v3-keyids",KEYSERVER_ADD_FAKE_V3,NULL,
73 NULL},
74 {"auto-key-retrieve",KEYSERVER_AUTO_KEY_RETRIEVE,NULL,
75 N_("automatically retrieve keys when verifying signatures")},
76 {"honor-keyserver-url",KEYSERVER_HONOR_KEYSERVER_URL,NULL,
77 N_("honor the preferred keyserver URL set on the key")},
78 {"honor-pka-record",KEYSERVER_HONOR_PKA_RECORD,NULL,
79 N_("honor the PKA record set on a key when retrieving keys")},
80 {NULL,0,NULL,NULL}
83 static int keyserver_work(enum ks_action action,STRLIST list,
84 KEYDB_SEARCH_DESC *desc,int count,
85 unsigned char **fpr,size_t *fpr_len,
86 struct keyserver_spec *keyserver);
88 /* Reasonable guess */
89 #define DEFAULT_MAX_CERT_SIZE 16384
91 static size_t max_cert_size=DEFAULT_MAX_CERT_SIZE;
93 static void
94 add_canonical_option(char *option,STRLIST *list)
96 char *arg=argsplit(option);
98 if(arg)
100 char *joined;
102 joined=xmalloc(strlen(option)+1+strlen(arg)+1);
103 /* Make a canonical name=value form with no spaces */
104 strcpy(joined,option);
105 strcat(joined,"=");
106 strcat(joined,arg);
107 append_to_strlist(list,joined);
108 xfree(joined);
110 else
111 append_to_strlist(list,option);
115 parse_keyserver_options(char *options)
117 int ret=1;
118 char *tok;
119 char *max_cert=NULL;
121 keyserver_opts[0].value=&max_cert;
123 while((tok=optsep(&options)))
125 if(tok[0]=='\0')
126 continue;
128 /* For backwards compatibility. 1.2.x used honor-http-proxy and
129 there are a good number of documents published that recommend
130 it. */
131 if(ascii_strcasecmp(tok,"honor-http-proxy")==0)
132 tok="http-proxy";
133 else if(ascii_strcasecmp(tok,"no-honor-http-proxy")==0)
134 tok="no-http-proxy";
136 /* We accept quite a few possible options here - some options to
137 handle specially, the keyserver_options list, and import and
138 export options that pertain to keyserver operations. Note
139 that you must use strncasecmp here as there might be an
140 =argument attached which will foil the use of strcasecmp. */
142 #ifdef EXEC_TEMPFILE_ONLY
143 if(ascii_strncasecmp(tok,"use-temp-files",14)==0 ||
144 ascii_strncasecmp(tok,"no-use-temp-files",17)==0)
145 log_info(_("WARNING: keyserver option `%s' is not used"
146 " on this platform\n"),tok);
147 #else
148 if(ascii_strncasecmp(tok,"use-temp-files",14)==0)
149 opt.keyserver_options.options|=KEYSERVER_USE_TEMP_FILES;
150 else if(ascii_strncasecmp(tok,"no-use-temp-files",17)==0)
151 opt.keyserver_options.options&=~KEYSERVER_USE_TEMP_FILES;
152 #endif
153 else if(!parse_options(tok,&opt.keyserver_options.options,
154 keyserver_opts,0)
155 && !parse_import_options(tok,
156 &opt.keyserver_options.import_options,0)
157 && !parse_export_options(tok,
158 &opt.keyserver_options.export_options,0))
160 /* All of the standard options have failed, so the option is
161 destined for a keyserver plugin. */
162 add_canonical_option(tok,&opt.keyserver_options.other);
166 if(max_cert)
168 max_cert_size=strtoul(max_cert,(char **)NULL,10);
170 if(max_cert_size==0)
171 max_cert_size=DEFAULT_MAX_CERT_SIZE;
174 return ret;
177 void
178 free_keyserver_spec(struct keyserver_spec *keyserver)
180 xfree(keyserver->uri);
181 xfree(keyserver->scheme);
182 xfree(keyserver->auth);
183 xfree(keyserver->host);
184 xfree(keyserver->port);
185 xfree(keyserver->path);
186 xfree(keyserver->opaque);
187 free_strlist(keyserver->options);
188 xfree(keyserver);
191 /* Return 0 for match */
192 static int
193 cmp_keyserver_spec(struct keyserver_spec *one,struct keyserver_spec *two)
195 if(ascii_strcasecmp(one->scheme,two->scheme)==0)
197 if(one->host && two->host && ascii_strcasecmp(one->host,two->host)==0)
199 if((one->port && two->port
200 && ascii_strcasecmp(one->port,two->port)==0)
201 || (!one->port && !two->port))
202 return 0;
204 else if(one->opaque && two->opaque
205 && ascii_strcasecmp(one->opaque,two->opaque)==0)
206 return 0;
209 return 1;
212 /* Try and match one of our keyservers. If we can, return that. If
213 we can't, return our input. */
214 struct keyserver_spec *
215 keyserver_match(struct keyserver_spec *spec)
217 struct keyserver_spec *ks;
219 for(ks=opt.keyserver;ks;ks=ks->next)
220 if(cmp_keyserver_spec(spec,ks)==0)
221 return ks;
223 return spec;
226 /* TODO: once we cut over to an all-curl world, we don't need this
227 parser any longer so it can be removed, or at least moved to
228 keyserver/ksutil.c for limited use in gpgkeys_ldap or the like. */
230 struct keyserver_spec *
231 parse_keyserver_uri(const char *string,int require_scheme,
232 const char *configname,unsigned int configlineno)
234 int assume_hkp=0;
235 struct keyserver_spec *keyserver;
236 const char *idx;
237 int count;
238 char *uri,*options;
240 assert(string!=NULL);
242 keyserver=xmalloc_clear(sizeof(struct keyserver_spec));
244 uri=xstrdup(string);
246 options=strchr(uri,' ');
247 if(options)
249 char *tok;
251 *options='\0';
252 options++;
254 while((tok=optsep(&options)))
255 add_canonical_option(tok,&keyserver->options);
258 /* Get the scheme */
260 for(idx=uri,count=0;*idx && *idx!=':';idx++)
262 count++;
264 /* Do we see the start of an RFC-2732 ipv6 address here? If so,
265 there clearly isn't a scheme so get out early. */
266 if(*idx=='[')
268 /* Was the '[' the first thing in the string? If not, we
269 have a mangled scheme with a [ in it so fail. */
270 if(count==1)
271 break;
272 else
273 goto fail;
277 if(count==0)
278 goto fail;
280 if(*idx=='\0' || *idx=='[')
282 if(require_scheme)
283 return NULL;
285 /* Assume HKP if there is no scheme */
286 assume_hkp=1;
287 keyserver->scheme=xstrdup("hkp");
289 keyserver->uri=xmalloc(strlen(keyserver->scheme)+3+strlen(uri)+1);
290 strcpy(keyserver->uri,keyserver->scheme);
291 strcat(keyserver->uri,"://");
292 strcat(keyserver->uri,uri);
294 else
296 int i;
298 keyserver->uri=xstrdup(uri);
300 keyserver->scheme=xmalloc(count+1);
302 /* Force to lowercase */
303 for(i=0;i<count;i++)
304 keyserver->scheme[i]=ascii_tolower(uri[i]);
306 keyserver->scheme[i]='\0';
308 /* Skip past the scheme and colon */
309 uri+=count+1;
312 if(ascii_strcasecmp(keyserver->scheme,"x-broken-hkp")==0)
314 deprecated_warning(configname,configlineno,"x-broken-hkp",
315 "--keyserver-options ","broken-http-proxy");
316 xfree(keyserver->scheme);
317 keyserver->scheme=xstrdup("hkp");
318 append_to_strlist(&opt.keyserver_options.other,"broken-http-proxy");
320 else if(ascii_strcasecmp(keyserver->scheme,"x-hkp")==0)
322 /* Canonicalize this to "hkp" so it works with both the internal
323 and external keyserver interface. */
324 xfree(keyserver->scheme);
325 keyserver->scheme=xstrdup("hkp");
328 if(assume_hkp || (uri[0]=='/' && uri[1]=='/'))
330 /* Two slashes means network path. */
332 /* Skip over the "//", if any */
333 if(!assume_hkp)
334 uri+=2;
336 /* Do we have userinfo auth data present? */
337 for(idx=uri,count=0;*idx && *idx!='@' && *idx!='/';idx++)
338 count++;
340 /* We found a @ before the slash, so that means everything
341 before the @ is auth data. */
342 if(*idx=='@')
344 if(count==0)
345 goto fail;
347 keyserver->auth=xmalloc(count+1);
348 strncpy(keyserver->auth,uri,count);
349 keyserver->auth[count]='\0';
350 uri+=count+1;
353 /* Is it an RFC-2732 ipv6 [literal address] ? */
354 if(*uri=='[')
356 for(idx=uri+1,count=1;*idx
357 && ((isascii (*idx) && isxdigit(*idx))
358 || *idx==':' || *idx=='.');idx++)
359 count++;
361 /* Is the ipv6 literal address terminated? */
362 if(*idx==']')
363 count++;
364 else
365 goto fail;
367 else
368 for(idx=uri,count=0;*idx && *idx!=':' && *idx!='/';idx++)
369 count++;
371 if(count==0)
372 goto fail;
374 keyserver->host=xmalloc(count+1);
375 strncpy(keyserver->host,uri,count);
376 keyserver->host[count]='\0';
378 /* Skip past the host */
379 uri+=count;
381 if(*uri==':')
383 /* It would seem to be reasonable to limit the range of the
384 ports to values between 1-65535, but RFC 1738 and 1808
385 imply there is no limit. Of course, the real world has
386 limits. */
388 for(idx=uri+1,count=0;*idx && *idx!='/';idx++)
390 count++;
392 /* Ports are digits only */
393 if(!digitp(idx))
394 goto fail;
397 keyserver->port=xmalloc(count+1);
398 strncpy(keyserver->port,uri+1,count);
399 keyserver->port[count]='\0';
401 /* Skip past the colon and port number */
402 uri+=1+count;
405 /* Everything else is the path */
406 if(*uri)
407 keyserver->path=xstrdup(uri);
408 else
409 keyserver->path=xstrdup("/");
411 if(keyserver->path[1])
412 keyserver->flags.direct_uri=1;
414 else if(uri[0]!='/')
416 /* No slash means opaque. Just record the opaque blob and get
417 out. */
418 keyserver->opaque=xstrdup(uri);
420 else
422 /* One slash means absolute path. We don't need to support that
423 yet. */
424 goto fail;
427 return keyserver;
429 fail:
430 free_keyserver_spec(keyserver);
432 return NULL;
435 struct keyserver_spec *
436 parse_preferred_keyserver(PKT_signature *sig)
438 struct keyserver_spec *spec=NULL;
439 const byte *p;
440 size_t plen;
442 p=parse_sig_subpkt(sig->hashed,SIGSUBPKT_PREF_KS,&plen);
443 if(p && plen)
445 byte *dupe=xmalloc(plen+1);
447 memcpy(dupe,p,plen);
448 dupe[plen]='\0';
449 spec=parse_keyserver_uri(dupe,1,NULL,0);
450 xfree(dupe);
453 return spec;
456 static void
457 print_keyrec(int number,struct keyrec *keyrec)
459 int i;
461 iobuf_writebyte(keyrec->uidbuf,0);
462 iobuf_flush_temp(keyrec->uidbuf);
463 printf("(%d)\t%s ",number,iobuf_get_temp_buffer(keyrec->uidbuf));
465 if(keyrec->size>0)
466 printf("%d bit ",keyrec->size);
468 if(keyrec->type)
470 const char *str = gcry_pk_algo_name (keyrec->type);
472 if(str)
473 printf("%s ",str);
474 else
475 printf("unknown ");
478 switch(keyrec->desc.mode)
480 /* If the keyserver helper gave us a short keyid, we have no
481 choice but to use it. Do check --keyid-format to add a 0x if
482 needed. */
483 case KEYDB_SEARCH_MODE_SHORT_KID:
484 printf("key %s%08lX",
485 (opt.keyid_format==KF_0xSHORT
486 || opt.keyid_format==KF_0xLONG)?"0x":"",
487 (ulong)keyrec->desc.u.kid[1]);
488 break;
490 /* However, if it gave us a long keyid, we can honor
491 --keyid-format */
492 case KEYDB_SEARCH_MODE_LONG_KID:
493 printf("key %s",keystr(keyrec->desc.u.kid));
494 break;
496 case KEYDB_SEARCH_MODE_FPR16:
497 printf("key ");
498 for(i=0;i<16;i++)
499 printf("%02X",keyrec->desc.u.fpr[i]);
500 break;
502 case KEYDB_SEARCH_MODE_FPR20:
503 printf("key ");
504 for(i=0;i<20;i++)
505 printf("%02X",keyrec->desc.u.fpr[i]);
506 break;
508 default:
509 BUG();
510 break;
513 if(keyrec->createtime>0)
515 printf(", ");
516 printf(_("created: %s"),strtimestamp(keyrec->createtime));
519 if(keyrec->expiretime>0)
521 printf(", ");
522 printf(_("expires: %s"),strtimestamp(keyrec->expiretime));
525 if(keyrec->flags&1)
526 printf(" (%s)",_("revoked"));
527 if(keyrec->flags&2)
528 printf(" (%s)",_("disabled"));
529 if(keyrec->flags&4)
530 printf(" (%s)",_("expired"));
532 printf("\n");
535 /* Returns a keyrec (which must be freed) once a key is complete, and
536 NULL otherwise. Call with a NULL keystring once key parsing is
537 complete to return any unfinished keys. */
538 static struct keyrec *
539 parse_keyrec(char *keystring)
541 static struct keyrec *work=NULL;
542 struct keyrec *ret=NULL;
543 char *record;
544 int i;
546 if(keystring==NULL)
548 if(work==NULL)
549 return NULL;
550 else if(work->desc.mode==KEYDB_SEARCH_MODE_NONE)
552 xfree(work);
553 return NULL;
555 else
557 ret=work;
558 work=NULL;
559 return ret;
563 if(work==NULL)
565 work=xmalloc_clear(sizeof(struct keyrec));
566 work->uidbuf=iobuf_temp();
569 /* Remove trailing whitespace */
570 for(i=strlen(keystring);i>0;i--)
571 if(ascii_isspace(keystring[i-1]))
572 keystring[i-1]='\0';
573 else
574 break;
576 if((record=strsep(&keystring,":"))==NULL)
577 return ret;
579 if(ascii_strcasecmp("pub",record)==0)
581 char *tok;
583 if(work->desc.mode)
585 ret=work;
586 work=xmalloc_clear(sizeof(struct keyrec));
587 work->uidbuf=iobuf_temp();
590 if((tok=strsep(&keystring,":"))==NULL)
591 return ret;
593 classify_user_id(tok,&work->desc);
594 if(work->desc.mode!=KEYDB_SEARCH_MODE_SHORT_KID
595 && work->desc.mode!=KEYDB_SEARCH_MODE_LONG_KID
596 && work->desc.mode!=KEYDB_SEARCH_MODE_FPR16
597 && work->desc.mode!=KEYDB_SEARCH_MODE_FPR20)
599 work->desc.mode=KEYDB_SEARCH_MODE_NONE;
600 return ret;
603 /* Note all items after this are optional. This allows us to
604 have a pub line as simple as pub:keyid and nothing else. */
606 work->lines++;
608 if((tok=strsep(&keystring,":"))==NULL)
609 return ret;
611 work->type=atoi(tok);
613 if((tok=strsep(&keystring,":"))==NULL)
614 return ret;
616 work->size=atoi(tok);
618 if((tok=strsep(&keystring,":"))==NULL)
619 return ret;
621 if(atoi(tok)<=0)
622 work->createtime=0;
623 else
624 work->createtime=atoi(tok);
626 if((tok=strsep(&keystring,":"))==NULL)
627 return ret;
629 if(atoi(tok)<=0)
630 work->expiretime=0;
631 else
633 work->expiretime=atoi(tok);
634 /* Force the 'e' flag on if this key is expired. */
635 if(work->expiretime<=make_timestamp())
636 work->flags|=4;
639 if((tok=strsep(&keystring,":"))==NULL)
640 return ret;
642 while(*tok)
643 switch(*tok++)
645 case 'r':
646 case 'R':
647 work->flags|=1;
648 break;
650 case 'd':
651 case 'D':
652 work->flags|=2;
653 break;
655 case 'e':
656 case 'E':
657 work->flags|=4;
658 break;
661 else if(ascii_strcasecmp("uid",record)==0 && work->desc.mode)
663 char *userid,*tok,*decoded;
665 if((tok=strsep(&keystring,":"))==NULL)
666 return ret;
668 if(strlen(tok)==0)
669 return ret;
671 userid=tok;
673 /* By definition, de-%-encoding is always smaller than the
674 original string so we can decode in place. */
676 i=0;
678 while(*tok)
679 if(tok[0]=='%' && tok[1] && tok[2])
681 if((userid[i]=hextobyte(&tok[1]))==-1)
682 userid[i]='?';
684 i++;
685 tok+=3;
687 else
688 userid[i++]=*tok++;
690 /* We don't care about the other info provided in the uid: line
691 since no keyserver supports marking userids with timestamps
692 or revoked/expired/disabled yet. */
694 /* No need to check for control characters, as utf8_to_native
695 does this for us. */
697 decoded=utf8_to_native(userid,i,0);
698 if(strlen(decoded)>opt.screen_columns-10)
699 decoded[opt.screen_columns-10]='\0';
700 iobuf_writestr(work->uidbuf,decoded);
701 xfree(decoded);
702 iobuf_writestr(work->uidbuf,"\n\t");
703 work->lines++;
706 /* Ignore any records other than "pri" and "uid" for easy future
707 growth. */
709 return ret;
712 /* TODO: do this as a list sent to keyserver_work rather than calling
713 it once for each key to get the correct counts after the import
714 (cosmetics, really) and to better take advantage of the keyservers
715 that can do multiple fetches in one go (LDAP). */
716 static int
717 show_prompt(KEYDB_SEARCH_DESC *desc,int numdesc,int count,const char *search)
719 char *answer;
721 if(count && opt.command_fd==-1)
723 static int from=1;
724 tty_printf("Keys %d-%d of %d for \"%s\". ",from,numdesc,count,search);
725 from=numdesc+1;
728 answer=cpr_get_no_help("keysearch.prompt",
729 _("Enter number(s), N)ext, or Q)uit > "));
730 /* control-d */
731 if(answer[0]=='\x04')
733 printf("Q\n");
734 answer[0]='q';
737 if(answer[0]=='q' || answer[0]=='Q')
739 xfree(answer);
740 return 1;
742 else if(atoi(answer)>=1 && atoi(answer)<=numdesc)
744 char *split=answer,*num;
746 while((num=strsep(&split," ,"))!=NULL)
747 if(atoi(num)>=1 && atoi(num)<=numdesc)
748 keyserver_work(KS_GET,NULL,&desc[atoi(num)-1],1,
749 NULL,NULL,opt.keyserver);
751 xfree(answer);
752 return 1;
755 return 0;
758 /* Count and searchstr are just for cosmetics. If the count is too
759 small, it will grow safely. If negative it disables the "Key x-y
760 of z" messages. searchstr should be UTF-8 (rather than native). */
761 static void
762 keyserver_search_prompt(IOBUF buffer,const char *searchstr)
764 int i=0,validcount=0,started=0,header=0,count=1;
765 unsigned int maxlen,buflen,numlines=0;
766 KEYDB_SEARCH_DESC *desc;
767 byte *line=NULL;
768 char *localstr=NULL;
770 if(searchstr)
771 localstr=utf8_to_native(searchstr,strlen(searchstr),0);
773 desc=xmalloc(count*sizeof(KEYDB_SEARCH_DESC));
775 for(;;)
777 struct keyrec *keyrec;
778 int rl;
780 maxlen=1024;
781 rl=iobuf_read_line(buffer,&line,&buflen,&maxlen);
783 if(opt.with_colons)
785 if(!header && ascii_strncasecmp("SEARCH ",line,7)==0
786 && ascii_strncasecmp(" BEGIN",&line[strlen(line)-7],6)==0)
788 header=1;
789 continue;
791 else if(ascii_strncasecmp("SEARCH ",line,7)==0
792 && ascii_strncasecmp(" END",&line[strlen(line)-5],4)==0)
793 continue;
795 printf("%s",line);
798 /* Look for an info: line. The only current info: values
799 defined are the version and key count. */
800 if(!started && rl>0 && ascii_strncasecmp("info:",line,5)==0)
802 char *tok,*str=&line[5];
804 if((tok=strsep(&str,":"))!=NULL)
806 int version;
808 if(sscanf(tok,"%d",&version)!=1)
809 version=1;
811 if(version!=1)
813 log_error(_("invalid keyserver protocol "
814 "(us %d!=handler %d)\n"),1,version);
815 break;
819 if((tok=strsep(&str,":"))!=NULL && sscanf(tok,"%d",&count)==1)
821 if(count==0)
822 goto notfound;
823 else if(count<0)
824 count=10;
825 else
826 validcount=1;
828 desc=xrealloc(desc,count*sizeof(KEYDB_SEARCH_DESC));
831 started=1;
832 continue;
835 if(rl==0)
837 keyrec=parse_keyrec(NULL);
839 if(keyrec==NULL)
841 if(i==0)
843 count=0;
844 break;
847 if(i!=count)
848 validcount=0;
850 for(;;)
852 if(show_prompt(desc,i,validcount?count:0,localstr))
853 break;
854 validcount=0;
857 break;
860 else
861 keyrec=parse_keyrec(line);
863 if(i==count)
865 /* keyserver helper sent more keys than they claimed in the
866 info: line. */
867 count+=10;
868 desc=xrealloc(desc,count*sizeof(KEYDB_SEARCH_DESC));
869 validcount=0;
872 if(keyrec)
874 desc[i]=keyrec->desc;
876 if(!opt.with_colons)
878 /* screen_lines - 1 for the prompt. */
879 if(numlines+keyrec->lines>opt.screen_lines-1)
881 if(show_prompt(desc,i,validcount?count:0,localstr))
882 break;
883 else
884 numlines=0;
887 print_keyrec(i+1,keyrec);
890 numlines+=keyrec->lines;
891 iobuf_close(keyrec->uidbuf);
892 xfree(keyrec);
894 started=1;
895 i++;
899 notfound:
900 /* Leave this commented out or now, and perhaps for a very long
901 time. All HKPish servers return HTML error messages for
902 no-key-found. */
904 if(!started)
905 log_info(_("keyserver does not support searching\n"));
906 else
908 if(count==0)
910 if(localstr)
911 log_info(_("key \"%s\" not found on keyserver\n"),localstr);
912 else
913 log_info(_("key not found on keyserver\n"));
916 xfree(localstr);
917 xfree(desc);
918 xfree(line);
921 /* We sometimes want to use a different gpgkeys_xxx for a given
922 protocol (for example, ldaps is handled by gpgkeys_ldap). Map
923 these here. */
924 static const char *
925 keyserver_typemap(const char *type)
927 if(strcmp(type,"ldaps")==0)
928 return "ldap";
929 else
930 return type;
933 /* The PGP LDAP and the curl fetch-a-LDAP-object methodologies are
934 sufficiently different that we can't use curl to do LDAP. */
935 static int
936 direct_uri_map(const char *scheme,unsigned int is_direct)
938 if(is_direct && strcmp(scheme,"ldap")==0)
939 return 1;
941 return 0;
944 #if GNUPG_MAJOR_VERSION == 2
945 #define GPGKEYS_PREFIX "gpg2keys_"
946 #else
947 #define GPGKEYS_PREFIX "gpgkeys_"
948 #endif
949 #define GPGKEYS_CURL GPGKEYS_PREFIX "curl" EXEEXT
950 #define GPGKEYS_PREFIX_LEN (strlen(GPGKEYS_CURL))
951 #define KEYSERVER_ARGS_KEEP " -o \"%O\" \"%I\""
952 #define KEYSERVER_ARGS_NOKEEP " -o \"%o\" \"%i\""
954 static int
955 keyserver_spawn(enum ks_action action,STRLIST list,KEYDB_SEARCH_DESC *desc,
956 int count,int *prog,unsigned char **fpr,size_t *fpr_len,
957 struct keyserver_spec *keyserver)
959 int ret=0,i,gotversion=0,outofband=0;
960 STRLIST temp;
961 unsigned int maxlen,buflen;
962 char *command,*end,*searchstr=NULL;
963 byte *line=NULL;
964 struct exec_info *spawn;
965 const char *scheme;
966 const char *libexecdir = get_libexecdir ();
968 assert(keyserver);
970 #ifdef EXEC_TEMPFILE_ONLY
971 opt.keyserver_options.options|=KEYSERVER_USE_TEMP_FILES;
972 #endif
974 /* Build the filename for the helper to execute */
975 scheme=keyserver_typemap(keyserver->scheme);
977 #ifdef DISABLE_KEYSERVER_PATH
978 /* Destroy any path we might have. This is a little tricky,
979 portability-wise. It's not correct to delete the PATH
980 environment variable, as that may fall back to a system built-in
981 PATH. Similarly, it is not correct to set PATH to the null
982 string (PATH="") since this actually deletes the PATH environment
983 variable under MinGW. The safest thing to do here is to force
984 PATH to be GNUPG_LIBEXECDIR. All this is not that meaningful on
985 Unix-like systems (since we're going to give a full path to
986 gpgkeys_foo), but on W32 it prevents loading any DLLs from
987 directories in %PATH%.
989 After some more thinking about this we came to the conclusion
990 that it is better to load the helpers from the directory where
991 the program of this process lives. Fortunately Windows provides
992 a way to retrieve this and our get_libexecdir function has been
993 modified to return just this. Setting the exec-path is not
994 anymore required.
995 set_exec_path(libexecdir);
997 #else
998 if(opt.exec_path_set)
1000 /* If exec-path was set, and DISABLE_KEYSERVER_PATH is
1001 undefined, then don't specify a full path to gpgkeys_foo, so
1002 that the PATH can work. */
1003 command=xmalloc(GPGKEYS_PREFIX_LEN+strlen(scheme)+3+strlen(EXEEXT)+1);
1004 command[0]='\0';
1006 else
1007 #endif
1009 /* Specify a full path to gpgkeys_foo. */
1010 command=xmalloc(strlen(libexecdir)+strlen(DIRSEP_S)+
1011 GPGKEYS_PREFIX_LEN+strlen(scheme)+3+strlen(EXEEXT)+1);
1012 strcpy(command,libexecdir);
1013 strcat(command,DIRSEP_S);
1016 end=command+strlen(command);
1018 /* Build a path for the keyserver helper. If it is direct_uri
1019 (i.e. an object fetch and not a keyserver), then add "_uri" to
1020 the end to distinguish the keyserver helper from an object
1021 fetcher that can speak that protocol (this is a problem for
1022 LDAP). */
1024 strcat(command,GPGKEYS_PREFIX);
1025 strcat(command,scheme);
1027 /* This "_uri" thing is in case we need to call a direct handler
1028 instead of the keyserver handler. This lets us use gpgkeys_curl
1029 or gpgkeys_ldap_uri (we don't provide it, but a user might)
1030 instead of gpgkeys_ldap to fetch things like
1031 ldap://keyserver.pgp.com/o=PGP%20keys?pgpkey?sub?pgpkeyid=99242560 */
1033 if(direct_uri_map(scheme,keyserver->flags.direct_uri))
1034 strcat(command,"_uri");
1036 strcat(command,EXEEXT);
1038 /* Can we execute it? If not, try curl as our catchall. */
1039 if(path_access(command,X_OK)!=0)
1040 strcpy(end,GPGKEYS_CURL);
1042 if(opt.keyserver_options.options&KEYSERVER_USE_TEMP_FILES)
1044 if(opt.keyserver_options.options&KEYSERVER_KEEP_TEMP_FILES)
1046 command=xrealloc(command,strlen(command)+
1047 strlen(KEYSERVER_ARGS_KEEP)+1);
1048 strcat(command,KEYSERVER_ARGS_KEEP);
1050 else
1052 command=xrealloc(command,strlen(command)+
1053 strlen(KEYSERVER_ARGS_NOKEEP)+1);
1054 strcat(command,KEYSERVER_ARGS_NOKEEP);
1057 ret=exec_write(&spawn,NULL,command,NULL,0,0);
1059 else
1060 ret=exec_write(&spawn,command,NULL,NULL,0,0);
1062 xfree(command);
1064 if(ret)
1065 return ret;
1067 fprintf(spawn->tochild,
1068 "# This is a GnuPG %s keyserver communications file\n",VERSION);
1069 fprintf(spawn->tochild,"VERSION %d\n",KEYSERVER_PROTO_VERSION);
1070 fprintf(spawn->tochild,"PROGRAM %s\n",VERSION);
1071 fprintf(spawn->tochild,"SCHEME %s\n",keyserver->scheme);
1073 if(keyserver->opaque)
1074 fprintf(spawn->tochild,"OPAQUE %s\n",keyserver->opaque);
1075 else
1077 if(keyserver->auth)
1078 fprintf(spawn->tochild,"AUTH %s\n",keyserver->auth);
1080 if(keyserver->host)
1081 fprintf(spawn->tochild,"HOST %s\n",keyserver->host);
1083 if(keyserver->port)
1084 fprintf(spawn->tochild,"PORT %s\n",keyserver->port);
1086 if(keyserver->path)
1087 fprintf(spawn->tochild,"PATH %s\n",keyserver->path);
1090 /* Write global options */
1092 for(temp=opt.keyserver_options.other;temp;temp=temp->next)
1093 fprintf(spawn->tochild,"OPTION %s\n",temp->d);
1095 /* Write per-keyserver options */
1097 for(temp=keyserver->options;temp;temp=temp->next)
1098 fprintf(spawn->tochild,"OPTION %s\n",temp->d);
1100 switch(action)
1102 case KS_GET:
1104 fprintf(spawn->tochild,"COMMAND GET\n\n");
1106 /* Which keys do we want? */
1108 for(i=0;i<count;i++)
1110 int quiet=0;
1112 if(desc[i].mode==KEYDB_SEARCH_MODE_FPR20)
1114 int f;
1116 fprintf(spawn->tochild,"0x");
1118 for(f=0;f<MAX_FINGERPRINT_LEN;f++)
1119 fprintf(spawn->tochild,"%02X",desc[i].u.fpr[f]);
1121 fprintf(spawn->tochild,"\n");
1123 else if(desc[i].mode==KEYDB_SEARCH_MODE_FPR16)
1125 int f;
1127 fprintf(spawn->tochild,"0x");
1129 for(f=0;f<16;f++)
1130 fprintf(spawn->tochild,"%02X",desc[i].u.fpr[f]);
1132 fprintf(spawn->tochild,"\n");
1134 else if(desc[i].mode==KEYDB_SEARCH_MODE_LONG_KID)
1135 fprintf(spawn->tochild,"0x%08lX%08lX\n",
1136 (ulong)desc[i].u.kid[0],
1137 (ulong)desc[i].u.kid[1]);
1138 else if(desc[i].mode==KEYDB_SEARCH_MODE_SHORT_KID)
1139 fprintf(spawn->tochild,"0x%08lX\n",
1140 (ulong)desc[i].u.kid[1]);
1141 else if(desc[i].mode==KEYDB_SEARCH_MODE_EXACT)
1143 fprintf(spawn->tochild,"0x0000000000000000\n");
1144 quiet=1;
1146 else if(desc[i].mode==KEYDB_SEARCH_MODE_NONE)
1147 continue;
1148 else
1149 BUG();
1151 if(!quiet)
1153 if(keyserver->host)
1154 log_info(_("requesting key %s from %s server %s\n"),
1155 keystr_from_desc(&desc[i]),
1156 keyserver->scheme,keyserver->host);
1157 else
1158 log_info(_("requesting key %s from %s\n"),
1159 keystr_from_desc(&desc[i]),keyserver->uri);
1163 fprintf(spawn->tochild,"\n");
1165 break;
1168 case KS_GETNAME:
1170 STRLIST key;
1172 fprintf(spawn->tochild,"COMMAND GETNAME\n\n");
1174 /* Which names do we want? */
1176 for(key=list;key!=NULL;key=key->next)
1177 fprintf(spawn->tochild,"%s\n",key->d);
1179 fprintf(spawn->tochild,"\n");
1181 if(keyserver->host)
1182 log_info(_("searching for names from %s server %s\n"),
1183 keyserver->scheme,keyserver->host);
1184 else
1185 log_info(_("searching for names from %s\n"),keyserver->uri);
1187 break;
1190 case KS_SEND:
1192 STRLIST key;
1194 /* Note the extra \n here to send an empty keylist block */
1195 fprintf(spawn->tochild,"COMMAND SEND\n\n\n");
1197 for(key=list;key!=NULL;key=key->next)
1199 armor_filter_context_t afx;
1200 IOBUF buffer=iobuf_temp();
1201 KBNODE block;
1203 temp=NULL;
1204 add_to_strlist(&temp,key->d);
1206 memset(&afx,0,sizeof(afx));
1207 afx.what=1;
1208 /* Tell the armor filter to use Unix-style \n line
1209 endings, since we're going to fprintf this to a file
1210 that (on Win32) is open in text mode. The win32 stdio
1211 will transform the \n to \r\n and we'll end up with the
1212 proper line endings on win32. This is a no-op on
1213 Unix. */
1214 afx.eol[0]='\n';
1215 iobuf_push_filter(buffer,armor_filter,&afx);
1217 /* TODO: Remove Comment: lines from keys exported this
1218 way? */
1220 if(export_pubkeys_stream(buffer,temp,&block,
1221 opt.keyserver_options.export_options)==-1)
1222 iobuf_close(buffer);
1223 else
1225 KBNODE node;
1227 iobuf_flush_temp(buffer);
1229 merge_keys_and_selfsig(block);
1231 fprintf(spawn->tochild,"INFO %08lX%08lX BEGIN\n",
1232 (ulong)block->pkt->pkt.public_key->keyid[0],
1233 (ulong)block->pkt->pkt.public_key->keyid[1]);
1235 for(node=block;node;node=node->next)
1237 switch(node->pkt->pkttype)
1239 default:
1240 continue;
1242 case PKT_PUBLIC_KEY:
1243 case PKT_PUBLIC_SUBKEY:
1245 PKT_public_key *pk=node->pkt->pkt.public_key;
1247 keyid_from_pk(pk,NULL);
1249 fprintf(spawn->tochild,"%sb:%08lX%08lX:%u:%u:%u:%u:",
1250 node->pkt->pkttype==PKT_PUBLIC_KEY?"pu":"su",
1251 (ulong)pk->keyid[0],(ulong)pk->keyid[1],
1252 pk->pubkey_algo,
1253 nbits_from_pk(pk),
1254 pk->timestamp,
1255 pk->expiredate);
1257 if(pk->is_revoked)
1258 fprintf(spawn->tochild,"r");
1259 if(pk->has_expired)
1260 fprintf(spawn->tochild,"e");
1262 fprintf(spawn->tochild,"\n");
1264 break;
1266 case PKT_USER_ID:
1268 PKT_user_id *uid=node->pkt->pkt.user_id;
1269 int r;
1271 if(uid->attrib_data)
1272 continue;
1274 fprintf(spawn->tochild,"uid:");
1276 /* Quote ':', '%', and any 8-bit
1277 characters */
1278 for(r=0;r<uid->len;r++)
1280 if(uid->name[r]==':' || uid->name[r]=='%'
1281 || uid->name[r]&0x80)
1282 fprintf(spawn->tochild,"%%%02X",
1283 (byte)uid->name[r]);
1284 else
1285 fprintf(spawn->tochild,"%c",uid->name[r]);
1288 fprintf(spawn->tochild,":%u:%u:",
1289 uid->created,uid->expiredate);
1291 if(uid->is_revoked)
1292 fprintf(spawn->tochild,"r");
1293 if(uid->is_expired)
1294 fprintf(spawn->tochild,"e");
1296 fprintf(spawn->tochild,"\n");
1298 break;
1300 /* This bit is really for the benefit of
1301 people who store their keys in LDAP
1302 servers. It makes it easy to do queries
1303 for things like "all keys signed by
1304 Isabella". */
1305 case PKT_SIGNATURE:
1307 PKT_signature *sig=node->pkt->pkt.signature;
1309 if(!IS_UID_SIG(sig))
1310 continue;
1312 fprintf(spawn->tochild,"sig:%08lX%08lX:%X:%u:%u\n",
1313 (ulong)sig->keyid[0],(ulong)sig->keyid[1],
1314 sig->sig_class,sig->timestamp,
1315 sig->expiredate);
1317 break;
1321 fprintf(spawn->tochild,"INFO %08lX%08lX END\n",
1322 (ulong)block->pkt->pkt.public_key->keyid[0],
1323 (ulong)block->pkt->pkt.public_key->keyid[1]);
1325 fprintf(spawn->tochild,"KEY %s BEGIN\n",key->d);
1326 fwrite(iobuf_get_temp_buffer(buffer),
1327 iobuf_get_temp_length(buffer),1,spawn->tochild);
1328 fprintf(spawn->tochild,"KEY %s END\n",key->d);
1330 iobuf_close(buffer);
1332 if(keyserver->host)
1333 log_info(_("sending key %s to %s server %s\n"),
1334 keystr(block->pkt->pkt.public_key->keyid),
1335 keyserver->scheme,keyserver->host);
1336 else
1337 log_info(_("sending key %s to %s\n"),
1338 keystr(block->pkt->pkt.public_key->keyid),
1339 keyserver->uri);
1341 release_kbnode(block);
1344 free_strlist(temp);
1347 break;
1350 case KS_SEARCH:
1352 STRLIST key;
1354 fprintf(spawn->tochild,"COMMAND SEARCH\n\n");
1356 /* Which keys do we want? Remember that the gpgkeys_ program
1357 is going to lump these together into a search string. */
1359 for(key=list;key!=NULL;key=key->next)
1361 fprintf(spawn->tochild,"%s\n",key->d);
1362 if(key!=list)
1364 searchstr=xrealloc(searchstr,
1365 strlen(searchstr)+strlen(key->d)+2);
1366 strcat(searchstr," ");
1368 else
1370 searchstr=xmalloc(strlen(key->d)+1);
1371 searchstr[0]='\0';
1374 strcat(searchstr,key->d);
1377 fprintf(spawn->tochild,"\n");
1379 if(keyserver->host)
1380 log_info(_("searching for \"%s\" from %s server %s\n"),
1381 searchstr,keyserver->scheme,keyserver->host);
1382 else
1383 log_info(_("searching for \"%s\" from %s\n"),
1384 searchstr,keyserver->uri);
1386 break;
1389 default:
1390 log_fatal(_("no keyserver action!\n"));
1391 break;
1394 /* Done sending, so start reading. */
1395 ret=exec_read(spawn);
1396 if(ret)
1397 goto fail;
1399 /* Now handle the response */
1401 for(;;)
1403 int plen;
1404 char *ptr;
1406 maxlen=1024;
1407 if(iobuf_read_line(spawn->fromchild,&line,&buflen,&maxlen)==0)
1409 ret = gpg_error_from_errno (errno);
1410 goto fail; /* i.e. EOF */
1413 ptr=line;
1415 /* remove trailing whitespace */
1416 plen=strlen(ptr);
1417 while(plen>0 && ascii_isspace(ptr[plen-1]))
1418 plen--;
1419 plen[ptr]='\0';
1421 if(*ptr=='\0')
1422 break;
1424 if(ascii_strncasecmp(ptr,"VERSION ",8)==0)
1426 gotversion=1;
1428 if(atoi(&ptr[8])!=KEYSERVER_PROTO_VERSION)
1430 log_error(_("invalid keyserver protocol (us %d!=handler %d)\n"),
1431 KEYSERVER_PROTO_VERSION,atoi(&ptr[8]));
1432 goto fail;
1435 else if(ascii_strncasecmp(ptr,"PROGRAM ",8)==0)
1437 if(ascii_strncasecmp(&ptr[8],VERSION,strlen(VERSION))!=0)
1438 log_info(_("WARNING: keyserver handler from a different"
1439 " version of GnuPG (%s)\n"),&ptr[8]);
1441 else if(ascii_strncasecmp(ptr,"OPTION OUTOFBAND",16)==0)
1442 outofband=1; /* Currently the only OPTION */
1445 if(!gotversion)
1447 log_error(_("keyserver did not send VERSION\n"));
1448 goto fail;
1451 if(!outofband)
1452 switch(action)
1454 case KS_GET:
1455 case KS_GETNAME:
1457 void *stats_handle;
1459 stats_handle=import_new_stats_handle();
1461 /* Slurp up all the key data. In the future, it might be
1462 nice to look for KEY foo OUTOFBAND and FAILED indicators.
1463 It's harmless to ignore them, but ignoring them does make
1464 gpg complain about "no valid OpenPGP data found". One
1465 way to do this could be to continue parsing this
1466 line-by-line and make a temp iobuf for each key. */
1468 import_keys_stream(spawn->fromchild,stats_handle,fpr,fpr_len,
1469 opt.keyserver_options.import_options);
1471 import_print_stats(stats_handle);
1472 import_release_stats_handle(stats_handle);
1474 break;
1477 /* Nothing to do here */
1478 case KS_SEND:
1479 break;
1481 case KS_SEARCH:
1482 keyserver_search_prompt(spawn->fromchild,searchstr);
1483 break;
1485 default:
1486 log_fatal(_("no keyserver action!\n"));
1487 break;
1490 fail:
1491 xfree(line);
1492 xfree(searchstr);
1495 *prog=exec_finish(spawn);
1497 return ret;
1500 static int
1501 keyserver_work(enum ks_action action,STRLIST list,KEYDB_SEARCH_DESC *desc,
1502 int count,unsigned char **fpr,size_t *fpr_len,
1503 struct keyserver_spec *keyserver)
1505 int rc=0,ret=0;
1507 if(!keyserver)
1509 log_error(_("no keyserver known (use option --keyserver)\n"));
1510 return G10ERR_BAD_URI;
1513 #ifdef DISABLE_KEYSERVER_HELPERS
1515 log_error(_("external keyserver calls are not supported in this build\n"));
1516 return G10ERR_KEYSERVER;
1518 #else
1519 /* Spawn a handler */
1521 rc=keyserver_spawn(action,list,desc,count,&ret,fpr,fpr_len,keyserver);
1522 if(ret)
1524 switch(ret)
1526 case KEYSERVER_SCHEME_NOT_FOUND:
1527 log_error(_("no handler for keyserver scheme `%s'\n"),
1528 keyserver->scheme);
1529 break;
1531 case KEYSERVER_NOT_SUPPORTED:
1532 log_error(_("action `%s' not supported with keyserver "
1533 "scheme `%s'\n"),
1534 action==KS_GET?"get":action==KS_SEND?"send":
1535 action==KS_SEARCH?"search":"unknown",
1536 keyserver->scheme);
1537 break;
1539 case KEYSERVER_VERSION_ERROR:
1540 log_error(_(GPGKEYS_PREFIX "%s does not support"
1541 " handler version %d\n"),
1542 keyserver_typemap(keyserver->scheme),
1543 KEYSERVER_PROTO_VERSION);
1544 break;
1546 case KEYSERVER_TIMEOUT:
1547 log_error(_("keyserver timed out\n"));
1548 break;
1550 case KEYSERVER_INTERNAL_ERROR:
1551 default:
1552 log_error(_("keyserver internal error\n"));
1553 break;
1556 return G10ERR_KEYSERVER;
1559 if(rc)
1561 log_error(_("keyserver communications error: %s\n"),g10_errstr(rc));
1563 return rc;
1566 return 0;
1567 #endif /* ! DISABLE_KEYSERVER_HELPERS*/
1570 int
1571 keyserver_export(STRLIST users)
1573 STRLIST sl=NULL;
1574 KEYDB_SEARCH_DESC desc;
1575 int rc=0;
1577 /* Weed out descriptors that we don't support sending */
1578 for(;users;users=users->next)
1580 classify_user_id (users->d, &desc);
1581 if(desc.mode!=KEYDB_SEARCH_MODE_SHORT_KID &&
1582 desc.mode!=KEYDB_SEARCH_MODE_LONG_KID &&
1583 desc.mode!=KEYDB_SEARCH_MODE_FPR16 &&
1584 desc.mode!=KEYDB_SEARCH_MODE_FPR20)
1586 log_error(_("\"%s\" not a key ID: skipping\n"),users->d);
1587 continue;
1589 else
1590 append_to_strlist(&sl,users->d);
1593 if(sl)
1595 rc=keyserver_work(KS_SEND,sl,NULL,0,NULL,NULL,opt.keyserver);
1596 free_strlist(sl);
1599 return rc;
1602 int
1603 keyserver_import(STRLIST users)
1605 KEYDB_SEARCH_DESC *desc;
1606 int num=100,count=0;
1607 int rc=0;
1609 /* Build a list of key ids */
1610 desc=xmalloc(sizeof(KEYDB_SEARCH_DESC)*num);
1612 for(;users;users=users->next)
1614 classify_user_id (users->d, &desc[count]);
1615 if(desc[count].mode!=KEYDB_SEARCH_MODE_SHORT_KID &&
1616 desc[count].mode!=KEYDB_SEARCH_MODE_LONG_KID &&
1617 desc[count].mode!=KEYDB_SEARCH_MODE_FPR16 &&
1618 desc[count].mode!=KEYDB_SEARCH_MODE_FPR20)
1620 log_error(_("\"%s\" not a key ID: skipping\n"),users->d);
1621 continue;
1624 count++;
1625 if(count==num)
1627 num+=100;
1628 desc=xrealloc(desc,sizeof(KEYDB_SEARCH_DESC)*num);
1632 if(count>0)
1633 rc=keyserver_work(KS_GET,NULL,desc,count,NULL,NULL,opt.keyserver);
1635 xfree(desc);
1637 return rc;
1641 keyserver_import_fprint(const byte *fprint,size_t fprint_len,
1642 struct keyserver_spec *keyserver)
1644 KEYDB_SEARCH_DESC desc;
1646 memset(&desc,0,sizeof(desc));
1648 if(fprint_len==16)
1649 desc.mode=KEYDB_SEARCH_MODE_FPR16;
1650 else if(fprint_len==20)
1651 desc.mode=KEYDB_SEARCH_MODE_FPR20;
1652 else
1653 return -1;
1655 memcpy(desc.u.fpr,fprint,fprint_len);
1657 /* TODO: Warn here if the fingerprint we got doesn't match the one
1658 we asked for? */
1659 return keyserver_work(KS_GET,NULL,&desc,1,NULL,NULL,keyserver);
1662 int
1663 keyserver_import_keyid(u32 *keyid,struct keyserver_spec *keyserver)
1665 KEYDB_SEARCH_DESC desc;
1667 memset(&desc,0,sizeof(desc));
1669 desc.mode=KEYDB_SEARCH_MODE_LONG_KID;
1670 desc.u.kid[0]=keyid[0];
1671 desc.u.kid[1]=keyid[1];
1673 return keyserver_work(KS_GET,NULL,&desc,1,NULL,NULL,keyserver);
1676 /* code mostly stolen from do_export_stream */
1677 static int
1678 keyidlist(STRLIST users,KEYDB_SEARCH_DESC **klist,int *count,int fakev3)
1680 int rc=0,ndesc,num=100;
1681 KBNODE keyblock=NULL,node;
1682 KEYDB_HANDLE kdbhd;
1683 KEYDB_SEARCH_DESC *desc;
1684 STRLIST sl;
1686 *count=0;
1688 *klist=xmalloc(sizeof(KEYDB_SEARCH_DESC)*num);
1690 kdbhd=keydb_new(0);
1692 if(!users)
1694 ndesc = 1;
1695 desc = xmalloc_clear ( ndesc * sizeof *desc);
1696 desc[0].mode = KEYDB_SEARCH_MODE_FIRST;
1698 else
1700 for (ndesc=0, sl=users; sl; sl = sl->next, ndesc++)
1702 desc = xmalloc ( ndesc * sizeof *desc);
1704 for (ndesc=0, sl=users; sl; sl = sl->next)
1706 if(classify_user_id (sl->d, desc+ndesc))
1707 ndesc++;
1708 else
1709 log_error (_("key \"%s\" not found: %s\n"),
1710 sl->d, g10_errstr (G10ERR_INV_USER_ID));
1714 while (!(rc = keydb_search (kdbhd, desc, ndesc)))
1716 if (!users)
1717 desc[0].mode = KEYDB_SEARCH_MODE_NEXT;
1719 /* read the keyblock */
1720 rc = keydb_get_keyblock (kdbhd, &keyblock );
1721 if( rc )
1723 log_error (_("error reading keyblock: %s\n"), g10_errstr(rc) );
1724 goto leave;
1727 if((node=find_kbnode(keyblock,PKT_PUBLIC_KEY)))
1729 /* This is to work around a bug in some keyservers (pksd and
1730 OKS) that calculate v4 RSA keyids as if they were v3 RSA.
1731 The answer is to refresh both the correct v4 keyid
1732 (e.g. 99242560) and the fake v3 keyid (e.g. 68FDDBC7).
1733 This only happens for key refresh using the HKP scheme
1734 and if the refresh-add-fake-v3-keyids keyserver option is
1735 set. */
1736 if(fakev3 && is_RSA(node->pkt->pkt.public_key->pubkey_algo) &&
1737 node->pkt->pkt.public_key->version>=4)
1739 (*klist)[*count].mode=KEYDB_SEARCH_MODE_LONG_KID;
1740 v3_keyid (node->pkt->pkt.public_key->pkey[0],
1741 (*klist)[*count].u.kid);
1742 (*count)++;
1744 if(*count==num)
1746 num+=100;
1747 *klist=xrealloc(*klist,sizeof(KEYDB_SEARCH_DESC)*num);
1751 /* v4 keys get full fingerprints. v3 keys get long keyids.
1752 This is because it's easy to calculate any sort of keyid
1753 from a v4 fingerprint, but not a v3 fingerprint. */
1755 if(node->pkt->pkt.public_key->version<4)
1757 (*klist)[*count].mode=KEYDB_SEARCH_MODE_LONG_KID;
1758 keyid_from_pk(node->pkt->pkt.public_key,
1759 (*klist)[*count].u.kid);
1761 else
1763 size_t dummy;
1765 (*klist)[*count].mode=KEYDB_SEARCH_MODE_FPR20;
1766 fingerprint_from_pk(node->pkt->pkt.public_key,
1767 (*klist)[*count].u.fpr,&dummy);
1770 /* This is a little hackish, using the skipfncvalue as a
1771 void* pointer to the keyserver spec, but we don't need
1772 the skipfnc here, and it saves having an additional field
1773 for this (which would be wasted space most of the
1774 time). */
1776 (*klist)[*count].skipfncvalue=NULL;
1778 /* Are we honoring preferred keyservers? */
1779 if(opt.keyserver_options.options&KEYSERVER_HONOR_KEYSERVER_URL)
1781 PKT_user_id *uid=NULL;
1782 PKT_signature *sig=NULL;
1784 merge_keys_and_selfsig(keyblock);
1786 for(node=node->next;node;node=node->next)
1788 if(node->pkt->pkttype==PKT_USER_ID
1789 && node->pkt->pkt.user_id->is_primary)
1790 uid=node->pkt->pkt.user_id;
1791 else if(node->pkt->pkttype==PKT_SIGNATURE
1792 && node->pkt->pkt.signature->
1793 flags.chosen_selfsig && uid)
1795 sig=node->pkt->pkt.signature;
1796 break;
1800 /* Try and parse the keyserver URL. If it doesn't work,
1801 then we end up writing NULL which indicates we are
1802 the same as any other key. */
1803 if(sig)
1804 (*klist)[*count].skipfncvalue=parse_preferred_keyserver(sig);
1807 (*count)++;
1809 if(*count==num)
1811 num+=100;
1812 *klist=xrealloc(*klist,sizeof(KEYDB_SEARCH_DESC)*num);
1817 if(rc==-1)
1818 rc=0;
1820 leave:
1821 if(rc)
1822 xfree(*klist);
1823 xfree(desc);
1824 keydb_release(kdbhd);
1825 release_kbnode(keyblock);
1827 return rc;
1830 /* Note this is different than the original HKP refresh. It allows
1831 usernames to refresh only part of the keyring. */
1834 keyserver_refresh(STRLIST users)
1836 int rc,count,numdesc,fakev3=0;
1837 KEYDB_SEARCH_DESC *desc;
1838 unsigned int options=opt.keyserver_options.import_options;
1840 /* We switch merge-only on during a refresh, as 'refresh' should
1841 never import new keys, even if their keyids match. */
1842 opt.keyserver_options.import_options|=IMPORT_MERGE_ONLY;
1844 /* Similarly, we switch on fast-import, since refresh may make
1845 multiple import sets (due to preferred keyserver URLs). We don't
1846 want each set to rebuild the trustdb. Instead we do it once at
1847 the end here. */
1848 opt.keyserver_options.import_options|=IMPORT_FAST;
1850 /* If refresh_add_fake_v3_keyids is on and it's a HKP or MAILTO
1851 scheme, then enable fake v3 keyid generation. */
1852 if((opt.keyserver_options.options&KEYSERVER_ADD_FAKE_V3) && opt.keyserver
1853 && (ascii_strcasecmp(opt.keyserver->scheme,"hkp")==0 ||
1854 ascii_strcasecmp(opt.keyserver->scheme,"mailto")==0))
1855 fakev3=1;
1857 rc=keyidlist(users,&desc,&numdesc,fakev3);
1858 if(rc)
1859 return rc;
1861 count=numdesc;
1862 if(count>0)
1864 int i;
1866 /* Try to handle preferred keyserver keys first */
1867 for(i=0;i<numdesc;i++)
1869 if(desc[i].skipfncvalue)
1871 struct keyserver_spec *keyserver=desc[i].skipfncvalue;
1873 /* We use the keyserver structure we parsed out before.
1874 Note that a preferred keyserver without a scheme://
1875 will be interpreted as hkp:// */
1877 rc=keyserver_work(KS_GET,NULL,&desc[i],1,NULL,NULL,keyserver);
1878 if(rc)
1879 log_info(_("WARNING: unable to refresh key %s"
1880 " via %s: %s\n"),keystr_from_desc(&desc[i]),
1881 keyserver->uri,g10_errstr(rc));
1882 else
1884 /* We got it, so mark it as NONE so we don't try and
1885 get it again from the regular keyserver. */
1887 desc[i].mode=KEYDB_SEARCH_MODE_NONE;
1888 count--;
1891 free_keyserver_spec(keyserver);
1896 if(count>0)
1898 if(opt.keyserver)
1900 if(count==1)
1901 log_info(_("refreshing 1 key from %s\n"),opt.keyserver->uri);
1902 else
1903 log_info(_("refreshing %d keys from %s\n"),
1904 count,opt.keyserver->uri);
1907 rc=keyserver_work(KS_GET,NULL,desc,numdesc,NULL,NULL,opt.keyserver);
1910 xfree(desc);
1912 opt.keyserver_options.import_options=options;
1914 /* If the original options didn't have fast import, and the trustdb
1915 is dirty, rebuild. */
1916 if(!(opt.keyserver_options.import_options&IMPORT_FAST))
1917 trustdb_check_or_update();
1919 return rc;
1923 keyserver_search(STRLIST tokens)
1925 if(tokens)
1926 return keyserver_work(KS_SEARCH,tokens,NULL,0,NULL,NULL,opt.keyserver);
1927 else
1928 return 0;
1932 keyserver_fetch(STRLIST urilist)
1934 KEYDB_SEARCH_DESC desc;
1935 STRLIST sl;
1936 unsigned int options=opt.keyserver_options.import_options;
1938 /* Switch on fast-import, since fetch can handle more than one
1939 import and we don't want each set to rebuild the trustdb.
1940 Instead we do it once at the end. */
1941 opt.keyserver_options.import_options|=IMPORT_FAST;
1943 /* A dummy desc since we're not actually fetching a particular key
1944 ID */
1945 memset(&desc,0,sizeof(desc));
1946 desc.mode=KEYDB_SEARCH_MODE_EXACT;
1948 for(sl=urilist;sl;sl=sl->next)
1950 struct keyserver_spec *spec;
1952 spec=parse_keyserver_uri(sl->d,1,NULL,0);
1953 if(spec)
1955 int rc;
1957 rc=keyserver_work(KS_GET,NULL,&desc,1,NULL,NULL,spec);
1958 if(rc)
1959 log_info (_("WARNING: unable to fetch URI %s: %s\n"),
1960 sl->d,g10_errstr(rc));
1962 free_keyserver_spec(spec);
1964 else
1965 log_info (_("WARNING: unable to parse URI %s\n"),sl->d);
1968 opt.keyserver_options.import_options=options;
1970 /* If the original options didn't have fast import, and the trustdb
1971 is dirty, rebuild. */
1972 if(!(opt.keyserver_options.import_options&IMPORT_FAST))
1973 trustdb_check_or_update();
1975 return 0;
1978 /* Import key in a CERT or pointed to by a CERT */
1980 keyserver_import_cert(const char *name,unsigned char **fpr,size_t *fpr_len)
1982 char *domain,*look,*url;
1983 IOBUF key;
1984 int type,rc=G10ERR_GENERAL;
1986 look=xstrdup(name);
1988 domain=strrchr(look,'@');
1989 if(domain)
1990 *domain='.';
1992 type=get_dns_cert(look,max_cert_size,&key,fpr,fpr_len,&url);
1993 if(type==1)
1995 int armor_status=opt.no_armor;
1997 /* CERTs are always in binary format */
1998 opt.no_armor=1;
2000 rc=import_keys_stream(key,NULL,fpr,fpr_len,
2001 opt.keyserver_options.import_options);
2003 opt.no_armor=armor_status;
2005 iobuf_close(key);
2007 else if(type==2 && *fpr)
2009 /* We only consider the IPGP type if a fingerprint was provided.
2010 This lets us select the right key regardless of what a URL
2011 points to, or get the key from a keyserver. */
2012 if(url)
2014 struct keyserver_spec *spec;
2016 spec=parse_keyserver_uri(url,1,NULL,0);
2017 if(spec)
2019 STRLIST list=NULL;
2021 add_to_strlist(&list,url);
2023 rc=keyserver_fetch(list);
2025 free_strlist(list);
2026 free_keyserver_spec(spec);
2029 else if(opt.keyserver)
2031 /* If only a fingerprint is provided, try and fetch it from
2032 our --keyserver */
2034 rc=keyserver_import_fprint(*fpr,*fpr_len,opt.keyserver);
2036 else
2037 log_info(_("no keyserver known (use option --keyserver)\n"));
2039 /* Give a better string here? "CERT fingerprint for \"%s\"
2040 found, but no keyserver" " known (use option
2041 --keyserver)\n" ? */
2043 xfree(url);
2046 xfree(look);
2048 return rc;
2051 /* Import key pointed to by a PKA record. Return the requested
2052 fingerprint in fpr. */
2054 keyserver_import_pka(const char *name,unsigned char **fpr,size_t *fpr_len)
2056 char *uri;
2057 int rc=-1;
2059 *fpr=xmalloc(20);
2060 *fpr_len=20;
2062 uri = get_pka_info (name, *fpr);
2063 if (uri)
2065 struct keyserver_spec *spec;
2066 spec = parse_keyserver_uri (uri, 1, NULL, 0);
2067 if (spec)
2069 rc=keyserver_import_fprint (*fpr, 20, spec);
2070 free_keyserver_spec (spec);
2072 xfree (uri);
2075 if(rc!=0)
2076 xfree(*fpr);
2078 return rc;
2081 /* Import all keys that match name */
2083 keyserver_import_name(const char *name,unsigned char **fpr,size_t *fpr_len,
2084 struct keyserver_spec *keyserver)
2086 STRLIST list=NULL;
2087 int rc;
2089 append_to_strlist(&list,name);
2091 rc=keyserver_work(KS_GETNAME,list,NULL,0,fpr,fpr_len,keyserver);
2093 free_strlist(list);
2095 return rc;
2098 /* Use the PGP Universal trick of asking ldap://keys.(maildomain) for
2099 the key. */
2101 keyserver_import_ldap(const char *name,unsigned char **fpr,size_t *fpr_len)
2103 char *domain;
2104 struct keyserver_spec *keyserver;
2105 STRLIST list=NULL;
2106 int rc;
2108 append_to_strlist(&list,name);
2110 /* Parse out the domain */
2111 domain=strrchr(name,'@');
2112 if(!domain)
2113 return G10ERR_GENERAL;
2115 domain++;
2117 keyserver=xmalloc_clear(sizeof(struct keyserver_spec));
2119 keyserver->scheme=xstrdup("ldap");
2120 keyserver->host=xmalloc(5+strlen(domain)+1);
2121 strcpy(keyserver->host,"keys.");
2122 strcat(keyserver->host,domain);
2123 keyserver->uri=xmalloc(strlen(keyserver->scheme)+
2124 3+strlen(keyserver->host)+1);
2125 strcpy(keyserver->uri,keyserver->scheme);
2126 strcat(keyserver->uri,"://");
2127 strcat(keyserver->uri,keyserver->host);
2129 rc=keyserver_work(KS_GETNAME,list,NULL,0,fpr,fpr_len,keyserver);
2131 free_strlist(list);
2133 free_keyserver_spec(keyserver);
2135 return rc;