2002-04-25 Marcus Brinkmann <marcus@g10code.de>
[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       log_info (_("no running gpg-agent - starting one\n"));
155
156       if (fflush (NULL))
157         {
158           log_error ("error flushing pending output: %s\n", strerror (errno));
159           return seterr (Write_Error);
160         }
161
162       if (!opt.agent_program || !*opt.agent_program)
163         opt.agent_program = "../agent/gpg-agent";
164       if ( !(pgmname = strrchr (opt.agent_program, '/')))
165         pgmname = opt.agent_program;
166       else
167         pgmname++;
168
169       argv[0] = pgmname;
170       argv[1] = "--server";
171       argv[2] = NULL;
172
173       /* connect to the agent and perform initial handshaking */
174       rc = assuan_pipe_connect (&ctx, opt.agent_program, (char**)argv, 0);
175     }
176   else
177     {
178       int prot;
179       int pid;
180
181       infostr = xstrdup (infostr);
182       if ( !(p = strchr (infostr, ':')) || p == infostr)
183         {
184           log_error (_("malformed GPG_AGENT_INFO environment variable\n"));
185           xfree (infostr);
186           force_pipe_server = 1;
187           return start_agent ();
188         }
189       *p++ = 0;
190       pid = atoi (p);
191       while (*p && *p != ':')
192         p++;
193       prot = *p? atoi (p+1) : 0;
194       if (prot != 1)
195         {
196           log_error (_("gpg-agent protocol version %d is not supported\n"),
197                      prot);
198           xfree (infostr);
199           force_pipe_server = 1;
200           return start_agent ();
201         }
202
203       rc = assuan_socket_connect (&ctx, infostr, pid);
204       xfree (infostr);
205       if (rc == ASSUAN_Connect_Failed)
206         {
207           log_error (_("can't connect to the agent - trying fall back\n"));
208           force_pipe_server = 1;
209           return start_agent ();
210         }
211     }
212
213   if (rc)
214     {
215       log_error ("can't connect to the agent: %s\n", assuan_strerror (rc));
216       return seterr (No_Agent);
217     }
218   agent_ctx = ctx;
219
220   if (DBG_AGENT)
221     log_debug ("connection to agent established\n");
222
223   rc = assuan_transact (agent_ctx, "RESET", NULL, NULL, NULL, NULL, NULL, NULL);
224   if (rc)
225     return map_assuan_err (rc);
226
227   dft_display = getenv ("DISPLAY");
228   if (opt.display || dft_display)
229     {
230       char *optstr;
231       if (asprintf (&optstr, "OPTION display=%s",
232                     opt.display ? opt.display : dft_display) < 0)
233         return GNUPG_Out_Of_Core;
234       rc = assuan_transact (agent_ctx, optstr, NULL, NULL, NULL, NULL, NULL,
235                             NULL);
236       free (optstr);
237       if (rc)
238         return map_assuan_err (rc);
239     }
240   if (!opt.ttyname && ttyname (1))
241     dft_ttyname = ttyname (1);
242   if (opt.ttyname || dft_ttyname)
243     {
244       char *optstr;
245       if (asprintf (&optstr, "OPTION ttyname=%s",
246                     opt.ttyname ? opt.ttyname : dft_ttyname) < 0)
247         return GNUPG_Out_Of_Core;
248       rc = assuan_transact (agent_ctx, optstr, NULL, NULL, NULL, NULL, NULL,
249                             NULL);
250       free (optstr);
251       if (rc)
252         return map_assuan_err (rc);
253     }
254   dft_ttytype = getenv ("TERM");
255   if (opt.ttytype || (dft_ttyname && dft_ttytype))
256     {
257       char *optstr;
258       if (asprintf (&optstr, "OPTION ttytype=%s",
259                     opt.ttyname ? opt.ttytype : dft_ttytype) < 0)
260         return GNUPG_Out_Of_Core;
261       rc = assuan_transact (agent_ctx, optstr, NULL, NULL, NULL, NULL, NULL,
262                             NULL);
263       free (optstr);
264       if (rc)
265         return map_assuan_err (rc);
266     }
267 #ifdef LC_CTYPE
268   old_lc = setlocale (LC_CTYPE, NULL);
269   dft_lc = setlocale (LC_CTYPE, "");
270 #endif
271   if (opt.lc_ctype || (dft_ttyname && dft_lc))
272     {
273       char *optstr;
274       if (asprintf (&optstr, "OPTION lc-ctype=%s",
275                     opt.lc_ctype ? opt.lc_ctype : dft_lc) < 0)
276         rc = GNUPG_Out_Of_Core;
277       else
278         {
279           rc = assuan_transact (agent_ctx, optstr, NULL, NULL, NULL, NULL, NULL,
280                                 NULL);
281           free (optstr);
282           if (rc)
283             rc = map_assuan_err (rc);
284         }
285     }
286 #ifdef LC_CTYPE
287   if (old_lc)
288     setlocale (LC_CTYPE, old_lc);
289 #endif
290   if (rc)
291     return rc;
292 #ifdef LC_MESSAGES
293   old_lc = setlocale (LC_MESSAGES, NULL);
294   dft_lc = setlocale (LC_MESSAGES, "");
295 #endif
296   if (opt.lc_messages || (dft_ttyname && dft_lc))
297     {
298       char *optstr;
299       if (asprintf (&optstr, "OPTION lc-messages=%s",
300                     opt.lc_messages ? opt.lc_messages : dft_lc) < 0)
301         rc = GNUPG_Out_Of_Core;
302       else
303         {
304           rc = assuan_transact (agent_ctx, optstr, NULL, NULL, NULL, NULL, NULL,
305                                 NULL);
306           free (optstr);
307           if (rc)
308             rc = map_assuan_err (rc);
309         }
310     }
311 #ifdef LC_MESSAGES
312   if (old_lc)
313     setlocale (LC_MESSAGES, old_lc);
314 #endif
315
316   return rc;
317 }
318
319
320 static AssuanError
321 membuf_data_cb (void *opaque, const void *buffer, size_t length)
322 {
323   struct membuf *data = opaque;
324
325   if (buffer)
326     put_membuf (data, buffer, length);
327   return 0;
328 }
329   
330
331
332 \f
333 /* Call the agent to do a sign operation using the key identified by
334    the hex string KEYGRIP. */
335 int
336 gpgsm_agent_pksign (const char *keygrip,
337                     unsigned char *digest, size_t digestlen, int digestalgo,
338                     char **r_buf, size_t *r_buflen )
339 {
340   int rc, i;
341   char *p, line[ASSUAN_LINELENGTH];
342   struct membuf data;
343   size_t len;
344
345   *r_buf = NULL;
346   rc = start_agent ();
347   if (rc)
348     return rc;
349
350   if (digestlen*2 + 50 > DIM(line))
351     return seterr (General_Error);
352
353   rc = assuan_transact (agent_ctx, "RESET", NULL, NULL, NULL, NULL, NULL, NULL);
354   if (rc)
355     return map_assuan_err (rc);
356
357   snprintf (line, DIM(line)-1, "SIGKEY %s", keygrip);
358   line[DIM(line)-1] = 0;
359   rc = assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
360   if (rc)
361     return map_assuan_err (rc);
362
363   sprintf (line, "SETHASH %d ", digestalgo);
364   p = line + strlen (line);
365   for (i=0; i < digestlen ; i++, p += 2 )
366     sprintf (p, "%02X", digest[i]);
367   rc = assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
368   if (rc)
369     return map_assuan_err (rc);
370
371   init_membuf (&data, 1024);
372   rc = assuan_transact (agent_ctx, "PKSIGN",
373                         membuf_data_cb, &data, NULL, NULL, NULL, NULL);
374   if (rc)
375     {
376       xfree (get_membuf (&data, &len));
377       return map_assuan_err (rc);
378     }
379   *r_buf = get_membuf (&data, r_buflen);
380
381   if (!gcry_sexp_canon_len (*r_buf, *r_buflen, NULL, NULL))
382     {
383       xfree (*r_buf); *r_buf = NULL;
384       return GNUPG_Invalid_Value;
385     }
386
387   return *r_buf? 0 : GNUPG_Out_Of_Core;
388 }
389
390
391
392 \f
393 /* Handle a CIPHERTEXT inquiry.  Note, we only send the data,
394    assuan_transact talkes care of flushing and writing the end */
395 static AssuanError
396 inq_ciphertext_cb (void *opaque, const char *keyword)
397 {
398   struct cipher_parm_s *parm = opaque; 
399   AssuanError rc;
400
401   assuan_begin_confidential (parm->ctx);
402   rc = assuan_send_data (parm->ctx, parm->ciphertext, parm->ciphertextlen);
403   assuan_end_confidential (parm->ctx);
404   return rc; 
405 }
406
407
408 /* Call the agent to do a decrypt operation using the key identified by
409    the hex string KEYGRIP. */
410 int
411 gpgsm_agent_pkdecrypt (const char *keygrip,
412                        KsbaConstSexp ciphertext, 
413                        char **r_buf, size_t *r_buflen )
414 {
415   int rc;
416   char line[ASSUAN_LINELENGTH];
417   struct membuf data;
418   struct cipher_parm_s cipher_parm;
419   size_t n, len;
420   char *buf, *endp;
421   size_t ciphertextlen;
422   
423   if (!keygrip || strlen(keygrip) != 40 || !ciphertext || !r_buf || !r_buflen)
424     return GNUPG_Invalid_Value;
425   *r_buf = NULL;
426
427   ciphertextlen = gcry_sexp_canon_len (ciphertext, 0, NULL, NULL);
428   if (!ciphertextlen)
429     return GNUPG_Invalid_Value;
430
431   rc = start_agent ();
432   if (rc)
433     return rc;
434
435   rc = assuan_transact (agent_ctx, "RESET", NULL, NULL, NULL, NULL, NULL, NULL);
436   if (rc)
437     return map_assuan_err (rc);
438
439   assert ( DIM(line) >= 50 );
440   snprintf (line, DIM(line)-1, "SETKEY %s", keygrip);
441   line[DIM(line)-1] = 0;
442   rc = assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
443   if (rc)
444     return map_assuan_err (rc);
445
446   init_membuf (&data, 1024);
447   cipher_parm.ctx = agent_ctx;
448   cipher_parm.ciphertext = ciphertext;
449   cipher_parm.ciphertextlen = ciphertextlen;
450   rc = assuan_transact (agent_ctx, "PKDECRYPT",
451                         membuf_data_cb, &data,
452                         inq_ciphertext_cb, &cipher_parm, NULL, NULL);
453   if (rc)
454     {
455       xfree (get_membuf (&data, &len));
456       return map_assuan_err (rc);
457     }
458
459   put_membuf (&data, "", 1); /* make sure it is 0 terminated */
460   buf = get_membuf (&data, &len);
461   if (!buf)
462     return seterr (Out_Of_Core);
463   /* FIXME: We would better a return a full S-exp and not just a part */
464   assert (len);
465   len--; /* remove the terminating 0 */
466   n = strtoul (buf, &endp, 10);
467   if (!n || *endp != ':')
468     return seterr (Invalid_Sexp);
469   endp++;
470   if (endp-buf+n > len)
471     return seterr (Invalid_Sexp); /* oops len does not match internal len*/
472   memmove (buf, endp, n);
473   *r_buflen = n;
474   *r_buf = buf;
475   return 0;
476 }
477
478
479
480
481 \f
482 /* Handle a KEYPARMS inquiry.  Note, we only send the data,
483    assuan_transact takes care of flushing and writing the end */
484 static AssuanError
485 inq_genkey_parms (void *opaque, const char *keyword)
486 {
487   struct genkey_parm_s *parm = opaque; 
488   AssuanError rc;
489
490   rc = assuan_send_data (parm->ctx, parm->sexp, parm->sexplen);
491   return rc; 
492 }
493
494
495 \f
496 /* Call the agent to generate a newkey */
497 int
498 gpgsm_agent_genkey (KsbaConstSexp keyparms, KsbaSexp *r_pubkey)
499 {
500   int rc;
501   struct genkey_parm_s gk_parm;
502   struct membuf data;
503   size_t len;
504   char *buf;
505
506   *r_pubkey = NULL;
507   rc = start_agent ();
508   if (rc)
509     return rc;
510
511   rc = assuan_transact (agent_ctx, "RESET", NULL, NULL, NULL, NULL, NULL, NULL);
512   if (rc)
513     return map_assuan_err (rc);
514
515   init_membuf (&data, 1024);
516   gk_parm.ctx = agent_ctx;
517   gk_parm.sexp = keyparms;
518   gk_parm.sexplen = gcry_sexp_canon_len (keyparms, 0, NULL, NULL);
519   if (!gk_parm.sexplen)
520     return GNUPG_Invalid_Value;
521   rc = assuan_transact (agent_ctx, "GENKEY",
522                         membuf_data_cb, &data, 
523                         inq_genkey_parms, &gk_parm, NULL, NULL);
524   if (rc)
525     {
526       xfree (get_membuf (&data, &len));
527       return map_assuan_err (rc);
528     }
529   buf = get_membuf (&data, &len);
530   if (!buf)
531     return GNUPG_Out_Of_Core;
532   if (!gcry_sexp_canon_len (buf, len, NULL, NULL))
533     {
534       xfree (buf);
535       return GNUPG_Invalid_Sexp;
536     }
537   *r_pubkey = buf;
538   return 0;
539 }
540
541 \f
542 /* Ask the agent whether the certificate is in the list of trusted
543    keys */
544 int
545 gpgsm_agent_istrusted (KsbaCert cert)
546 {
547   int rc;
548   char *fpr;
549   char line[ASSUAN_LINELENGTH];
550
551   rc = start_agent ();
552   if (rc)
553     return rc;
554
555   fpr = gpgsm_get_fingerprint_hexstring (cert, GCRY_MD_SHA1);
556   if (!fpr)
557     {
558       log_error ("error getting the fingerprint\n");
559       return seterr (General_Error);
560     }
561
562   snprintf (line, DIM(line)-1, "ISTRUSTED %s", fpr);
563   line[DIM(line)-1] = 0;
564   xfree (fpr);
565
566   rc = assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
567   return map_assuan_err (rc);
568 }
569
570 /* Ask the agent to mark CERT as a trusted Root-CA one */
571 int
572 gpgsm_agent_marktrusted (KsbaCert cert)
573 {
574   int rc;
575   char *fpr, *dn;
576   char line[ASSUAN_LINELENGTH];
577
578   rc = start_agent ();
579   if (rc)
580     return rc;
581
582   fpr = gpgsm_get_fingerprint_hexstring (cert, GCRY_MD_SHA1);
583   if (!fpr)
584     {
585       log_error ("error getting the fingerprint\n");
586       return seterr (General_Error);
587     }
588
589   dn = ksba_cert_get_issuer (cert, 0);
590   if (!dn)
591     {
592       xfree (fpr);
593       return seterr (General_Error);
594     }
595   snprintf (line, DIM(line)-1, "MARKTRUSTED %s S %s", fpr, dn);
596   line[DIM(line)-1] = 0;
597   ksba_free (dn);
598   xfree (fpr);
599
600   rc = assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
601   return map_assuan_err (rc);
602 }
603
604
605 \f
606 /* Ask the agent whether the a corresponding secret key is available
607    for the given keygrip */
608 int
609 gpgsm_agent_havekey (const char *hexkeygrip)
610 {
611   int rc;
612   char line[ASSUAN_LINELENGTH];
613
614   rc = start_agent ();
615   if (rc)
616     return rc;
617
618   if (!hexkeygrip || strlen (hexkeygrip) != 40)
619     return GNUPG_Invalid_Value;
620
621   snprintf (line, DIM(line)-1, "HAVEKEY %s", hexkeygrip);
622   line[DIM(line)-1] = 0;
623
624   rc = assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
625   return map_assuan_err (rc);
626 }
627
628 \f
629 static AssuanError
630 learn_cb (void *opaque, const void *buffer, size_t length)
631 {
632   struct learn_parm_s *parm = opaque;
633   size_t len;
634   char *buf;
635   KsbaCert cert;
636   int rc;
637
638   if (parm->error)
639     return 0;
640
641   if (buffer)
642     {
643       put_membuf (parm->data, buffer, length);
644       return 0;
645     }
646   /* END encountered - process what we have */
647   buf = get_membuf (parm->data, &len);
648   if (!buf)
649     {
650       parm->error = GNUPG_Out_Of_Core;
651       return 0;
652     }
653
654
655   /* FIXME: this should go into import.c */
656   cert = ksba_cert_new ();
657   if (!cert)
658     {
659       parm->error = GNUPG_Out_Of_Core;
660       return 0;
661     }
662   rc = ksba_cert_init_from_mem (cert, buf, len);
663   if (rc)
664     {
665       log_error ("failed to parse a certificate: %s\n", ksba_strerror (rc));
666       ksba_cert_release (cert);
667       parm->error = map_ksba_err (rc);
668       return 0;
669     }
670
671   rc = gpgsm_basic_cert_check (cert);
672   if (rc)
673     log_error ("invalid certificate: %s\n", gnupg_strerror (rc));
674   else
675     {
676       if (!keydb_store_cert (cert))
677         log_error ("certificate imported\n");
678     }
679
680   ksba_cert_release (cert);
681   init_membuf (parm->data, 4096);
682   return 0;
683 }
684   
685 /* Call the agent to learn about a smartcard */
686 int
687 gpgsm_agent_learn ()
688 {
689   int rc;
690   struct learn_parm_s learn_parm;
691   struct membuf data;
692   size_t len;
693
694   rc = start_agent ();
695   if (rc)
696     return rc;
697
698   init_membuf (&data, 4096);
699   learn_parm.error = 0;
700   learn_parm.ctx = agent_ctx;
701   learn_parm.data = &data;
702   rc = assuan_transact (agent_ctx, "LEARN --send",
703                         learn_cb, &learn_parm, 
704                         NULL, NULL, NULL, NULL);
705   xfree (get_membuf (&data, &len));
706   if (rc)
707     return map_assuan_err (rc);
708   return learn_parm.error;
709 }
710