* call-agent.c (learn_cb): Special treatment when the issuer
[gnupg.git] / sm / call-agent.c
1 /* call-agent.c - divert operations to the agent
2  *      Copyright (C) 2001, 2002 Free Software Foundation, Inc.
3  *
4  * This file is part of GnuPG.
5  *
6  * GnuPG is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * GnuPG is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
19  */
20
21 #include <config.h>
22 #include <stdio.h>
23 #include <stdlib.h>
24 #include <string.h>
25 #include <errno.h>
26 #include <unistd.h> 
27 #include <time.h>
28 #include <assert.h>
29 #include <gcrypt.h>
30 #ifdef HAVE_LOCALE_H
31 #include <locale.h>
32 #endif
33
34 #include "gpgsm.h"
35 #include "../assuan/assuan.h"
36 #include "i18n.h"
37 #include "keydb.h" /* fixme: Move this to import.c */
38
39 static ASSUAN_CONTEXT agent_ctx = NULL;
40 static int force_pipe_server = 0;
41
42 struct cipher_parm_s {
43   ASSUAN_CONTEXT ctx;
44   const char *ciphertext;
45   size_t ciphertextlen;
46 };
47
48 struct genkey_parm_s {
49   ASSUAN_CONTEXT ctx;
50   const char *sexp;
51   size_t sexplen;
52 };
53
54 struct learn_parm_s {
55   int error;
56   ASSUAN_CONTEXT ctx;
57   struct membuf *data;
58 };
59
60 struct membuf {
61   size_t len;
62   size_t size;
63   char *buf;
64   int out_of_core;
65 };
66
67
68 \f
69 /* A simple implemnation of a dynamic buffer.  Use init_membuf() to
70    create a buffer, put_membuf to append bytes and get_membuf to
71    release and return the buffer.  Allocation errors are detected but
72    only returned at the final get_membuf(), this helps not to clutter
73    the code with out of core checks.  */
74
75 static void
76 init_membuf (struct membuf *mb, int initiallen)
77 {
78   mb->len = 0;
79   mb->size = initiallen;
80   mb->out_of_core = 0;
81   mb->buf = xtrymalloc (initiallen);
82   if (!mb->buf)
83       mb->out_of_core = 1;
84 }
85
86 static void
87 put_membuf (struct membuf *mb, const void *buf, size_t len)
88 {
89   if (mb->out_of_core)
90     return;
91
92   if (mb->len + len >= mb->size)
93     {
94       char *p;
95       
96       mb->size += len + 1024;
97       p = xtryrealloc (mb->buf, mb->size);
98       if (!p)
99         {
100           mb->out_of_core = 1;
101           return;
102         }
103       mb->buf = p;
104     }
105   memcpy (mb->buf + mb->len, buf, len);
106   mb->len += len;
107 }
108
109 static void *
110 get_membuf (struct membuf *mb, size_t *len)
111 {
112   char *p;
113
114   if (mb->out_of_core)
115     {
116       xfree (mb->buf);
117       mb->buf = NULL;
118       return NULL;
119     }
120
121   p = mb->buf;
122   *len = mb->len;
123   mb->buf = NULL;
124   mb->out_of_core = 1; /* don't allow a reuse */
125   return p;
126 }
127
128
129 \f
130 /* Try to connect to the agent via socket or fork it off and work by
131    pipes.  Handle the server's initial greeting */
132 static int
133 start_agent (void)
134 {
135   int rc = 0;
136   char *infostr, *p;
137   ASSUAN_CONTEXT ctx;
138   char *dft_display = NULL;
139   char *dft_ttyname = NULL;
140   char *dft_ttytype = NULL;
141   char *old_lc = NULL;
142   char *dft_lc = NULL;
143
144   if (agent_ctx)
145     return 0; /* fixme: We need a context for each thread or serialize
146                  the access to the agent (which is suitable given that
147                  the agent is not MT */
148
149   infostr = force_pipe_server? NULL : getenv ("GPG_AGENT_INFO");
150   if (!infostr)
151     {
152       const char *pgmname;
153       const char *argv[3];
154       int no_close_list[3];
155       int i;
156
157       if (opt.verbose)
158         log_info (_("no running gpg-agent - starting one\n"));
159
160       if (fflush (NULL))
161         {
162           log_error ("error flushing pending output: %s\n", strerror (errno));
163           return seterr (Write_Error);
164         }
165
166       if (!opt.agent_program || !*opt.agent_program)
167         opt.agent_program = GNUPG_DEFAULT_AGENT;
168       if ( !(pgmname = strrchr (opt.agent_program, '/')))
169         pgmname = opt.agent_program;
170       else
171         pgmname++;
172
173       argv[0] = pgmname;
174       argv[1] = "--server";
175       argv[2] = NULL;
176
177       i=0;
178       if (log_get_fd () != -1)
179         no_close_list[i++] = log_get_fd ();
180       no_close_list[i++] = fileno (stderr);
181       no_close_list[i] = -1;
182
183       /* connect to the agent and perform initial handshaking */
184       rc = assuan_pipe_connect (&ctx, opt.agent_program, (char**)argv,
185                                 no_close_list);
186     }
187   else
188     {
189       int prot;
190       int pid;
191
192       infostr = xstrdup (infostr);
193       if ( !(p = strchr (infostr, ':')) || p == infostr)
194         {
195           log_error (_("malformed GPG_AGENT_INFO environment variable\n"));
196           xfree (infostr);
197           force_pipe_server = 1;
198           return start_agent ();
199         }
200       *p++ = 0;
201       pid = atoi (p);
202       while (*p && *p != ':')
203         p++;
204       prot = *p? atoi (p+1) : 0;
205       if (prot != 1)
206         {
207           log_error (_("gpg-agent protocol version %d is not supported\n"),
208                      prot);
209           xfree (infostr);
210           force_pipe_server = 1;
211           return start_agent ();
212         }
213
214       rc = assuan_socket_connect (&ctx, infostr, pid);
215       xfree (infostr);
216       if (rc == ASSUAN_Connect_Failed)
217         {
218           log_error (_("can't connect to the agent - trying fall back\n"));
219           force_pipe_server = 1;
220           return start_agent ();
221         }
222     }
223
224   if (rc)
225     {
226       log_error ("can't connect to the agent: %s\n", assuan_strerror (rc));
227       return seterr (No_Agent);
228     }
229   agent_ctx = ctx;
230
231   if (DBG_ASSUAN)
232     log_debug ("connection to agent established\n");
233
234   rc = assuan_transact (agent_ctx, "RESET", NULL, NULL, NULL, NULL, NULL, NULL);
235   if (rc)
236     return map_assuan_err (rc);
237
238   dft_display = getenv ("DISPLAY");
239   if (opt.display || dft_display)
240     {
241       char *optstr;
242       if (asprintf (&optstr, "OPTION display=%s",
243                     opt.display ? opt.display : dft_display) < 0)
244         return GNUPG_Out_Of_Core;
245       rc = assuan_transact (agent_ctx, optstr, NULL, NULL, NULL, NULL, NULL,
246                             NULL);
247       free (optstr);
248       if (rc)
249         return map_assuan_err (rc);
250     }
251   if (!opt.ttyname && ttyname (1))
252     dft_ttyname = ttyname (1);
253   if (opt.ttyname || dft_ttyname)
254     {
255       char *optstr;
256       if (asprintf (&optstr, "OPTION ttyname=%s",
257                     opt.ttyname ? opt.ttyname : dft_ttyname) < 0)
258         return GNUPG_Out_Of_Core;
259       rc = assuan_transact (agent_ctx, optstr, NULL, NULL, NULL, NULL, NULL,
260                             NULL);
261       free (optstr);
262       if (rc)
263         return map_assuan_err (rc);
264     }
265   dft_ttytype = getenv ("TERM");
266   if (opt.ttytype || (dft_ttyname && dft_ttytype))
267     {
268       char *optstr;
269       if (asprintf (&optstr, "OPTION ttytype=%s",
270                     opt.ttyname ? opt.ttytype : dft_ttytype) < 0)
271         return GNUPG_Out_Of_Core;
272       rc = assuan_transact (agent_ctx, optstr, NULL, NULL, NULL, NULL, NULL,
273                             NULL);
274       free (optstr);
275       if (rc)
276         return map_assuan_err (rc);
277     }
278 #if defined(HAVE_SETLOCALE) && defined(LC_CTYPE)
279   old_lc = setlocale (LC_CTYPE, NULL);
280   if (old_lc)
281     {
282       old_lc = strdup (old_lc);
283       if (!old_lc)
284         return GNUPG_Out_Of_Core;
285     }
286   dft_lc = setlocale (LC_CTYPE, "");
287 #endif
288   if (opt.lc_ctype || (dft_ttyname && dft_lc))
289     {
290       char *optstr;
291       if (asprintf (&optstr, "OPTION lc-ctype=%s",
292                     opt.lc_ctype ? opt.lc_ctype : dft_lc) < 0)
293         rc = GNUPG_Out_Of_Core;
294       else
295         {
296           rc = assuan_transact (agent_ctx, optstr, NULL, NULL, NULL, NULL, NULL,
297                                 NULL);
298           free (optstr);
299           if (rc)
300             rc = map_assuan_err (rc);
301         }
302     }
303 #if defined(HAVE_SETLOCALE) && defined(LC_CTYPE)
304   if (old_lc)
305     {
306       setlocale (LC_CTYPE, old_lc);
307       free (old_lc);
308     }
309 #endif
310   if (rc)
311     return rc;
312 #if defined(HAVE_SETLOCALE) && defined(LC_MESSAGES)
313   old_lc = setlocale (LC_MESSAGES, NULL);
314   if (old_lc)
315     {
316       old_lc = strdup (old_lc);
317       if (!old_lc)
318         return GNUPG_Out_Of_Core;
319     }
320   dft_lc = setlocale (LC_MESSAGES, "");
321 #endif
322   if (opt.lc_messages || (dft_ttyname && dft_lc))
323     {
324       char *optstr;
325       if (asprintf (&optstr, "OPTION lc-messages=%s",
326                     opt.lc_messages ? opt.lc_messages : dft_lc) < 0)
327         rc = GNUPG_Out_Of_Core;
328       else
329         {
330           rc = assuan_transact (agent_ctx, optstr, NULL, NULL, NULL, NULL, NULL,
331                                 NULL);
332           free (optstr);
333           if (rc)
334             rc = map_assuan_err (rc);
335         }
336     }
337 #if defined(HAVE_SETLOCALE) && defined(LC_MESSAGES)
338   if (old_lc)
339     {
340       setlocale (LC_MESSAGES, old_lc);
341       free (old_lc);
342     }
343 #endif
344
345   return rc;
346 }
347
348
349 static AssuanError
350 membuf_data_cb (void *opaque, const void *buffer, size_t length)
351 {
352   struct membuf *data = opaque;
353
354   if (buffer)
355     put_membuf (data, buffer, length);
356   return 0;
357 }
358   
359
360
361 \f
362 /* Call the agent to do a sign operation using the key identified by
363    the hex string KEYGRIP. */
364 int
365 gpgsm_agent_pksign (const char *keygrip,
366                     unsigned char *digest, size_t digestlen, int digestalgo,
367                     char **r_buf, size_t *r_buflen )
368 {
369   int rc, i;
370   char *p, line[ASSUAN_LINELENGTH];
371   struct membuf data;
372   size_t len;
373
374   *r_buf = NULL;
375   rc = start_agent ();
376   if (rc)
377     return rc;
378
379   if (digestlen*2 + 50 > DIM(line))
380     return seterr (General_Error);
381
382   rc = assuan_transact (agent_ctx, "RESET", NULL, NULL, NULL, NULL, NULL, NULL);
383   if (rc)
384     return map_assuan_err (rc);
385
386   snprintf (line, DIM(line)-1, "SIGKEY %s", keygrip);
387   line[DIM(line)-1] = 0;
388   rc = assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
389   if (rc)
390     return map_assuan_err (rc);
391
392   sprintf (line, "SETHASH %d ", digestalgo);
393   p = line + strlen (line);
394   for (i=0; i < digestlen ; i++, p += 2 )
395     sprintf (p, "%02X", digest[i]);
396   rc = assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
397   if (rc)
398     return map_assuan_err (rc);
399
400   init_membuf (&data, 1024);
401   rc = assuan_transact (agent_ctx, "PKSIGN",
402                         membuf_data_cb, &data, NULL, NULL, NULL, NULL);
403   if (rc)
404     {
405       xfree (get_membuf (&data, &len));
406       return map_assuan_err (rc);
407     }
408   *r_buf = get_membuf (&data, r_buflen);
409
410   if (!gcry_sexp_canon_len (*r_buf, *r_buflen, NULL, NULL))
411     {
412       xfree (*r_buf); *r_buf = NULL;
413       return GNUPG_Invalid_Value;
414     }
415
416   return *r_buf? 0 : GNUPG_Out_Of_Core;
417 }
418
419
420
421 \f
422 /* Handle a CIPHERTEXT inquiry.  Note, we only send the data,
423    assuan_transact talkes care of flushing and writing the end */
424 static AssuanError
425 inq_ciphertext_cb (void *opaque, const char *keyword)
426 {
427   struct cipher_parm_s *parm = opaque; 
428   AssuanError rc;
429
430   assuan_begin_confidential (parm->ctx);
431   rc = assuan_send_data (parm->ctx, parm->ciphertext, parm->ciphertextlen);
432   assuan_end_confidential (parm->ctx);
433   return rc; 
434 }
435
436
437 /* Call the agent to do a decrypt operation using the key identified by
438    the hex string KEYGRIP. */
439 int
440 gpgsm_agent_pkdecrypt (const char *keygrip,
441                        KsbaConstSexp ciphertext, 
442                        char **r_buf, size_t *r_buflen )
443 {
444   int rc;
445   char line[ASSUAN_LINELENGTH];
446   struct membuf data;
447   struct cipher_parm_s cipher_parm;
448   size_t n, len;
449   char *buf, *endp;
450   size_t ciphertextlen;
451   
452   if (!keygrip || strlen(keygrip) != 40 || !ciphertext || !r_buf || !r_buflen)
453     return GNUPG_Invalid_Value;
454   *r_buf = NULL;
455
456   ciphertextlen = gcry_sexp_canon_len (ciphertext, 0, NULL, NULL);
457   if (!ciphertextlen)
458     return GNUPG_Invalid_Value;
459
460   rc = start_agent ();
461   if (rc)
462     return rc;
463
464   rc = assuan_transact (agent_ctx, "RESET", NULL, NULL, NULL, NULL, NULL, NULL);
465   if (rc)
466     return map_assuan_err (rc);
467
468   assert ( DIM(line) >= 50 );
469   snprintf (line, DIM(line)-1, "SETKEY %s", keygrip);
470   line[DIM(line)-1] = 0;
471   rc = assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
472   if (rc)
473     return map_assuan_err (rc);
474
475   init_membuf (&data, 1024);
476   cipher_parm.ctx = agent_ctx;
477   cipher_parm.ciphertext = ciphertext;
478   cipher_parm.ciphertextlen = ciphertextlen;
479   rc = assuan_transact (agent_ctx, "PKDECRYPT",
480                         membuf_data_cb, &data,
481                         inq_ciphertext_cb, &cipher_parm, NULL, NULL);
482   if (rc)
483     {
484       xfree (get_membuf (&data, &len));
485       return map_assuan_err (rc);
486     }
487
488   put_membuf (&data, "", 1); /* make sure it is 0 terminated */
489   buf = get_membuf (&data, &len);
490   if (!buf)
491     return seterr (Out_Of_Core);
492   /* FIXME: We would better a return a full S-exp and not just a part */
493   assert (len);
494   len--; /* remove the terminating 0 */
495   n = strtoul (buf, &endp, 10);
496   if (!n || *endp != ':')
497     return seterr (Invalid_Sexp);
498   endp++;
499   if (endp-buf+n > len)
500     return seterr (Invalid_Sexp); /* oops len does not match internal len*/
501   memmove (buf, endp, n);
502   *r_buflen = n;
503   *r_buf = buf;
504   return 0;
505 }
506
507
508
509
510 \f
511 /* Handle a KEYPARMS inquiry.  Note, we only send the data,
512    assuan_transact takes care of flushing and writing the end */
513 static AssuanError
514 inq_genkey_parms (void *opaque, const char *keyword)
515 {
516   struct genkey_parm_s *parm = opaque; 
517   AssuanError rc;
518
519   rc = assuan_send_data (parm->ctx, parm->sexp, parm->sexplen);
520   return rc; 
521 }
522
523
524 \f
525 /* Call the agent to generate a newkey */
526 int
527 gpgsm_agent_genkey (KsbaConstSexp keyparms, KsbaSexp *r_pubkey)
528 {
529   int rc;
530   struct genkey_parm_s gk_parm;
531   struct membuf data;
532   size_t len;
533   char *buf;
534
535   *r_pubkey = NULL;
536   rc = start_agent ();
537   if (rc)
538     return rc;
539
540   rc = assuan_transact (agent_ctx, "RESET", NULL, NULL, NULL, NULL, NULL, NULL);
541   if (rc)
542     return map_assuan_err (rc);
543
544   init_membuf (&data, 1024);
545   gk_parm.ctx = agent_ctx;
546   gk_parm.sexp = keyparms;
547   gk_parm.sexplen = gcry_sexp_canon_len (keyparms, 0, NULL, NULL);
548   if (!gk_parm.sexplen)
549     return GNUPG_Invalid_Value;
550   rc = assuan_transact (agent_ctx, "GENKEY",
551                         membuf_data_cb, &data, 
552                         inq_genkey_parms, &gk_parm, NULL, NULL);
553   if (rc)
554     {
555       xfree (get_membuf (&data, &len));
556       return map_assuan_err (rc);
557     }
558   buf = get_membuf (&data, &len);
559   if (!buf)
560     return GNUPG_Out_Of_Core;
561   if (!gcry_sexp_canon_len (buf, len, NULL, NULL))
562     {
563       xfree (buf);
564       return GNUPG_Invalid_Sexp;
565     }
566   *r_pubkey = buf;
567   return 0;
568 }
569
570 \f
571 /* Ask the agent whether the certificate is in the list of trusted
572    keys */
573 int
574 gpgsm_agent_istrusted (KsbaCert cert)
575 {
576   int rc;
577   char *fpr;
578   char line[ASSUAN_LINELENGTH];
579
580   rc = start_agent ();
581   if (rc)
582     return rc;
583
584   fpr = gpgsm_get_fingerprint_hexstring (cert, GCRY_MD_SHA1);
585   if (!fpr)
586     {
587       log_error ("error getting the fingerprint\n");
588       return seterr (General_Error);
589     }
590
591   snprintf (line, DIM(line)-1, "ISTRUSTED %s", fpr);
592   line[DIM(line)-1] = 0;
593   xfree (fpr);
594
595   rc = assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
596   return map_assuan_err (rc);
597 }
598
599 /* Ask the agent to mark CERT as a trusted Root-CA one */
600 int
601 gpgsm_agent_marktrusted (KsbaCert cert)
602 {
603   int rc;
604   char *fpr, *dn;
605   char line[ASSUAN_LINELENGTH];
606
607   rc = start_agent ();
608   if (rc)
609     return rc;
610
611   fpr = gpgsm_get_fingerprint_hexstring (cert, GCRY_MD_SHA1);
612   if (!fpr)
613     {
614       log_error ("error getting the fingerprint\n");
615       return seterr (General_Error);
616     }
617
618   dn = ksba_cert_get_issuer (cert, 0);
619   if (!dn)
620     {
621       xfree (fpr);
622       return seterr (General_Error);
623     }
624   snprintf (line, DIM(line)-1, "MARKTRUSTED %s S %s", fpr, dn);
625   line[DIM(line)-1] = 0;
626   ksba_free (dn);
627   xfree (fpr);
628
629   rc = assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
630   return map_assuan_err (rc);
631 }
632
633
634 \f
635 /* Ask the agent whether the a corresponding secret key is available
636    for the given keygrip */
637 int
638 gpgsm_agent_havekey (const char *hexkeygrip)
639 {
640   int rc;
641   char line[ASSUAN_LINELENGTH];
642
643   rc = start_agent ();
644   if (rc)
645     return rc;
646
647   if (!hexkeygrip || strlen (hexkeygrip) != 40)
648     return GNUPG_Invalid_Value;
649
650   snprintf (line, DIM(line)-1, "HAVEKEY %s", hexkeygrip);
651   line[DIM(line)-1] = 0;
652
653   rc = assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
654   return map_assuan_err (rc);
655 }
656
657 \f
658 static AssuanError
659 learn_cb (void *opaque, const void *buffer, size_t length)
660 {
661   struct learn_parm_s *parm = opaque;
662   size_t len;
663   char *buf;
664   KsbaCert cert;
665   int rc;
666
667   if (parm->error)
668     return 0;
669
670   if (buffer)
671     {
672       put_membuf (parm->data, buffer, length);
673       return 0;
674     }
675   /* END encountered - process what we have */
676   buf = get_membuf (parm->data, &len);
677   if (!buf)
678     {
679       parm->error = GNUPG_Out_Of_Core;
680       return 0;
681     }
682
683
684   /* FIXME: this should go into import.c */
685   cert = ksba_cert_new ();
686   if (!cert)
687     {
688       parm->error = GNUPG_Out_Of_Core;
689       return 0;
690     }
691   rc = ksba_cert_init_from_mem (cert, buf, len);
692   if (rc)
693     {
694       log_error ("failed to parse a certificate: %s\n", ksba_strerror (rc));
695       ksba_cert_release (cert);
696       parm->error = map_ksba_err (rc);
697       return 0;
698     }
699
700   rc = gpgsm_basic_cert_check (cert);
701   if (rc == GNUPG_Missing_Certificate)
702     { /* For later use we store it in the ephemeral database. */
703       log_info ("issuer certificate missing - storing as ephemeral\n");
704       keydb_store_cert (cert, 1, NULL);
705     }
706   else if (rc)
707     log_error ("invalid certificate: %s\n", gnupg_strerror (rc));
708   else
709     {
710       int existed;
711
712       if (!keydb_store_cert (cert, 0, &existed))
713         {
714           if (opt.verbose > 1 && existed)
715             log_info ("certificate already in DB\n");
716           else if (opt.verbose && !existed)
717             log_info ("certificate imported\n");
718         }
719     }
720
721   ksba_cert_release (cert);
722   init_membuf (parm->data, 4096);
723   return 0;
724 }
725   
726 /* Call the agent to learn about a smartcard */
727 int
728 gpgsm_agent_learn ()
729 {
730   int rc;
731   struct learn_parm_s learn_parm;
732   struct membuf data;
733   size_t len;
734
735   rc = start_agent ();
736   if (rc)
737     return rc;
738
739   init_membuf (&data, 4096);
740   learn_parm.error = 0;
741   learn_parm.ctx = agent_ctx;
742   learn_parm.data = &data;
743   rc = assuan_transact (agent_ctx, "LEARN --send",
744                         learn_cb, &learn_parm, 
745                         NULL, NULL, NULL, NULL);
746   xfree (get_membuf (&data, &len));
747   if (rc)
748     return map_assuan_err (rc);
749   return learn_parm.error;
750 }
751