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