* call-agent.c (start_agent): Make copies of old locales and check
[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 #if defined(HAVE_SETLOCALE) && defined(LC_CTYPE)
268   old_lc = setlocale (LC_CTYPE, NULL);
269   if (old_lc)
270     {
271       old_lc = strdup (old_lc);
272       if (!old_lc)
273         return GNUPG_Out_Of_Core;
274     }
275   dft_lc = setlocale (LC_CTYPE, "");
276 #endif
277   if (opt.lc_ctype || (dft_ttyname && dft_lc))
278     {
279       char *optstr;
280       if (asprintf (&optstr, "OPTION lc-ctype=%s",
281                     opt.lc_ctype ? opt.lc_ctype : dft_lc) < 0)
282         rc = GNUPG_Out_Of_Core;
283       else
284         {
285           rc = assuan_transact (agent_ctx, optstr, NULL, NULL, NULL, NULL, NULL,
286                                 NULL);
287           free (optstr);
288           if (rc)
289             rc = map_assuan_err (rc);
290         }
291     }
292 #if defined(HAVE_SETLOCALE) && defined(LC_CTYPE)
293   if (old_lc)
294     {
295       setlocale (LC_CTYPE, old_lc);
296       free (old_lc);
297     }
298 #endif
299   if (rc)
300     return rc;
301 #if defined(HAVE_SETLOCALE) && defined(LC_MESSAGES)
302   old_lc = setlocale (LC_MESSAGES, NULL);
303   if (old_lc)
304     {
305       old_lc = strdup (old_lc);
306       if (!old_lc)
307         return GNUPG_Out_Of_Core;
308     }
309   dft_lc = setlocale (LC_MESSAGES, "");
310 #endif
311   if (opt.lc_messages || (dft_ttyname && dft_lc))
312     {
313       char *optstr;
314       if (asprintf (&optstr, "OPTION lc-messages=%s",
315                     opt.lc_messages ? opt.lc_messages : dft_lc) < 0)
316         rc = GNUPG_Out_Of_Core;
317       else
318         {
319           rc = assuan_transact (agent_ctx, optstr, NULL, NULL, NULL, NULL, NULL,
320                                 NULL);
321           free (optstr);
322           if (rc)
323             rc = map_assuan_err (rc);
324         }
325     }
326 #if defined(HAVE_SETLOCALE) && defined(LC_MESSAGES)
327   if (old_lc)
328     {
329       setlocale (LC_MESSAGES, old_lc);
330       free (old_lc);
331     }
332 #endif
333
334   return rc;
335 }
336
337
338 static AssuanError
339 membuf_data_cb (void *opaque, const void *buffer, size_t length)
340 {
341   struct membuf *data = opaque;
342
343   if (buffer)
344     put_membuf (data, buffer, length);
345   return 0;
346 }
347   
348
349
350 \f
351 /* Call the agent to do a sign operation using the key identified by
352    the hex string KEYGRIP. */
353 int
354 gpgsm_agent_pksign (const char *keygrip,
355                     unsigned char *digest, size_t digestlen, int digestalgo,
356                     char **r_buf, size_t *r_buflen )
357 {
358   int rc, i;
359   char *p, line[ASSUAN_LINELENGTH];
360   struct membuf data;
361   size_t len;
362
363   *r_buf = NULL;
364   rc = start_agent ();
365   if (rc)
366     return rc;
367
368   if (digestlen*2 + 50 > DIM(line))
369     return seterr (General_Error);
370
371   rc = assuan_transact (agent_ctx, "RESET", NULL, NULL, NULL, NULL, NULL, NULL);
372   if (rc)
373     return map_assuan_err (rc);
374
375   snprintf (line, DIM(line)-1, "SIGKEY %s", keygrip);
376   line[DIM(line)-1] = 0;
377   rc = assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
378   if (rc)
379     return map_assuan_err (rc);
380
381   sprintf (line, "SETHASH %d ", digestalgo);
382   p = line + strlen (line);
383   for (i=0; i < digestlen ; i++, p += 2 )
384     sprintf (p, "%02X", digest[i]);
385   rc = assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
386   if (rc)
387     return map_assuan_err (rc);
388
389   init_membuf (&data, 1024);
390   rc = assuan_transact (agent_ctx, "PKSIGN",
391                         membuf_data_cb, &data, NULL, NULL, NULL, NULL);
392   if (rc)
393     {
394       xfree (get_membuf (&data, &len));
395       return map_assuan_err (rc);
396     }
397   *r_buf = get_membuf (&data, r_buflen);
398
399   if (!gcry_sexp_canon_len (*r_buf, *r_buflen, NULL, NULL))
400     {
401       xfree (*r_buf); *r_buf = NULL;
402       return GNUPG_Invalid_Value;
403     }
404
405   return *r_buf? 0 : GNUPG_Out_Of_Core;
406 }
407
408
409
410 \f
411 /* Handle a CIPHERTEXT inquiry.  Note, we only send the data,
412    assuan_transact talkes care of flushing and writing the end */
413 static AssuanError
414 inq_ciphertext_cb (void *opaque, const char *keyword)
415 {
416   struct cipher_parm_s *parm = opaque; 
417   AssuanError rc;
418
419   assuan_begin_confidential (parm->ctx);
420   rc = assuan_send_data (parm->ctx, parm->ciphertext, parm->ciphertextlen);
421   assuan_end_confidential (parm->ctx);
422   return rc; 
423 }
424
425
426 /* Call the agent to do a decrypt operation using the key identified by
427    the hex string KEYGRIP. */
428 int
429 gpgsm_agent_pkdecrypt (const char *keygrip,
430                        KsbaConstSexp ciphertext, 
431                        char **r_buf, size_t *r_buflen )
432 {
433   int rc;
434   char line[ASSUAN_LINELENGTH];
435   struct membuf data;
436   struct cipher_parm_s cipher_parm;
437   size_t n, len;
438   char *buf, *endp;
439   size_t ciphertextlen;
440   
441   if (!keygrip || strlen(keygrip) != 40 || !ciphertext || !r_buf || !r_buflen)
442     return GNUPG_Invalid_Value;
443   *r_buf = NULL;
444
445   ciphertextlen = gcry_sexp_canon_len (ciphertext, 0, NULL, NULL);
446   if (!ciphertextlen)
447     return GNUPG_Invalid_Value;
448
449   rc = start_agent ();
450   if (rc)
451     return rc;
452
453   rc = assuan_transact (agent_ctx, "RESET", NULL, NULL, NULL, NULL, NULL, NULL);
454   if (rc)
455     return map_assuan_err (rc);
456
457   assert ( DIM(line) >= 50 );
458   snprintf (line, DIM(line)-1, "SETKEY %s", keygrip);
459   line[DIM(line)-1] = 0;
460   rc = assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
461   if (rc)
462     return map_assuan_err (rc);
463
464   init_membuf (&data, 1024);
465   cipher_parm.ctx = agent_ctx;
466   cipher_parm.ciphertext = ciphertext;
467   cipher_parm.ciphertextlen = ciphertextlen;
468   rc = assuan_transact (agent_ctx, "PKDECRYPT",
469                         membuf_data_cb, &data,
470                         inq_ciphertext_cb, &cipher_parm, NULL, NULL);
471   if (rc)
472     {
473       xfree (get_membuf (&data, &len));
474       return map_assuan_err (rc);
475     }
476
477   put_membuf (&data, "", 1); /* make sure it is 0 terminated */
478   buf = get_membuf (&data, &len);
479   if (!buf)
480     return seterr (Out_Of_Core);
481   /* FIXME: We would better a return a full S-exp and not just a part */
482   assert (len);
483   len--; /* remove the terminating 0 */
484   n = strtoul (buf, &endp, 10);
485   if (!n || *endp != ':')
486     return seterr (Invalid_Sexp);
487   endp++;
488   if (endp-buf+n > len)
489     return seterr (Invalid_Sexp); /* oops len does not match internal len*/
490   memmove (buf, endp, n);
491   *r_buflen = n;
492   *r_buf = buf;
493   return 0;
494 }
495
496
497
498
499 \f
500 /* Handle a KEYPARMS inquiry.  Note, we only send the data,
501    assuan_transact takes care of flushing and writing the end */
502 static AssuanError
503 inq_genkey_parms (void *opaque, const char *keyword)
504 {
505   struct genkey_parm_s *parm = opaque; 
506   AssuanError rc;
507
508   rc = assuan_send_data (parm->ctx, parm->sexp, parm->sexplen);
509   return rc; 
510 }
511
512
513 \f
514 /* Call the agent to generate a newkey */
515 int
516 gpgsm_agent_genkey (KsbaConstSexp keyparms, KsbaSexp *r_pubkey)
517 {
518   int rc;
519   struct genkey_parm_s gk_parm;
520   struct membuf data;
521   size_t len;
522   char *buf;
523
524   *r_pubkey = NULL;
525   rc = start_agent ();
526   if (rc)
527     return rc;
528
529   rc = assuan_transact (agent_ctx, "RESET", NULL, NULL, NULL, NULL, NULL, NULL);
530   if (rc)
531     return map_assuan_err (rc);
532
533   init_membuf (&data, 1024);
534   gk_parm.ctx = agent_ctx;
535   gk_parm.sexp = keyparms;
536   gk_parm.sexplen = gcry_sexp_canon_len (keyparms, 0, NULL, NULL);
537   if (!gk_parm.sexplen)
538     return GNUPG_Invalid_Value;
539   rc = assuan_transact (agent_ctx, "GENKEY",
540                         membuf_data_cb, &data, 
541                         inq_genkey_parms, &gk_parm, NULL, NULL);
542   if (rc)
543     {
544       xfree (get_membuf (&data, &len));
545       return map_assuan_err (rc);
546     }
547   buf = get_membuf (&data, &len);
548   if (!buf)
549     return GNUPG_Out_Of_Core;
550   if (!gcry_sexp_canon_len (buf, len, NULL, NULL))
551     {
552       xfree (buf);
553       return GNUPG_Invalid_Sexp;
554     }
555   *r_pubkey = buf;
556   return 0;
557 }
558
559 \f
560 /* Ask the agent whether the certificate is in the list of trusted
561    keys */
562 int
563 gpgsm_agent_istrusted (KsbaCert cert)
564 {
565   int rc;
566   char *fpr;
567   char line[ASSUAN_LINELENGTH];
568
569   rc = start_agent ();
570   if (rc)
571     return rc;
572
573   fpr = gpgsm_get_fingerprint_hexstring (cert, GCRY_MD_SHA1);
574   if (!fpr)
575     {
576       log_error ("error getting the fingerprint\n");
577       return seterr (General_Error);
578     }
579
580   snprintf (line, DIM(line)-1, "ISTRUSTED %s", fpr);
581   line[DIM(line)-1] = 0;
582   xfree (fpr);
583
584   rc = assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
585   return map_assuan_err (rc);
586 }
587
588 /* Ask the agent to mark CERT as a trusted Root-CA one */
589 int
590 gpgsm_agent_marktrusted (KsbaCert cert)
591 {
592   int rc;
593   char *fpr, *dn;
594   char line[ASSUAN_LINELENGTH];
595
596   rc = start_agent ();
597   if (rc)
598     return rc;
599
600   fpr = gpgsm_get_fingerprint_hexstring (cert, GCRY_MD_SHA1);
601   if (!fpr)
602     {
603       log_error ("error getting the fingerprint\n");
604       return seterr (General_Error);
605     }
606
607   dn = ksba_cert_get_issuer (cert, 0);
608   if (!dn)
609     {
610       xfree (fpr);
611       return seterr (General_Error);
612     }
613   snprintf (line, DIM(line)-1, "MARKTRUSTED %s S %s", fpr, dn);
614   line[DIM(line)-1] = 0;
615   ksba_free (dn);
616   xfree (fpr);
617
618   rc = assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
619   return map_assuan_err (rc);
620 }
621
622
623 \f
624 /* Ask the agent whether the a corresponding secret key is available
625    for the given keygrip */
626 int
627 gpgsm_agent_havekey (const char *hexkeygrip)
628 {
629   int rc;
630   char line[ASSUAN_LINELENGTH];
631
632   rc = start_agent ();
633   if (rc)
634     return rc;
635
636   if (!hexkeygrip || strlen (hexkeygrip) != 40)
637     return GNUPG_Invalid_Value;
638
639   snprintf (line, DIM(line)-1, "HAVEKEY %s", hexkeygrip);
640   line[DIM(line)-1] = 0;
641
642   rc = assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
643   return map_assuan_err (rc);
644 }
645
646 \f
647 static AssuanError
648 learn_cb (void *opaque, const void *buffer, size_t length)
649 {
650   struct learn_parm_s *parm = opaque;
651   size_t len;
652   char *buf;
653   KsbaCert cert;
654   int rc;
655
656   if (parm->error)
657     return 0;
658
659   if (buffer)
660     {
661       put_membuf (parm->data, buffer, length);
662       return 0;
663     }
664   /* END encountered - process what we have */
665   buf = get_membuf (parm->data, &len);
666   if (!buf)
667     {
668       parm->error = GNUPG_Out_Of_Core;
669       return 0;
670     }
671
672
673   /* FIXME: this should go into import.c */
674   cert = ksba_cert_new ();
675   if (!cert)
676     {
677       parm->error = GNUPG_Out_Of_Core;
678       return 0;
679     }
680   rc = ksba_cert_init_from_mem (cert, buf, len);
681   if (rc)
682     {
683       log_error ("failed to parse a certificate: %s\n", ksba_strerror (rc));
684       ksba_cert_release (cert);
685       parm->error = map_ksba_err (rc);
686       return 0;
687     }
688
689   rc = gpgsm_basic_cert_check (cert);
690   if (rc)
691     log_error ("invalid certificate: %s\n", gnupg_strerror (rc));
692   else
693     {
694       if (!keydb_store_cert (cert))
695         log_error ("certificate imported\n");
696     }
697
698   ksba_cert_release (cert);
699   init_membuf (parm->data, 4096);
700   return 0;
701 }
702   
703 /* Call the agent to learn about a smartcard */
704 int
705 gpgsm_agent_learn ()
706 {
707   int rc;
708   struct learn_parm_s learn_parm;
709   struct membuf data;
710   size_t len;
711
712   rc = start_agent ();
713   if (rc)
714     return rc;
715
716   init_membuf (&data, 4096);
717   learn_parm.error = 0;
718   learn_parm.ctx = agent_ctx;
719   learn_parm.data = &data;
720   rc = assuan_transact (agent_ctx, "LEARN --send",
721                         learn_cb, &learn_parm, 
722                         NULL, NULL, NULL, NULL);
723   xfree (get_membuf (&data, &len));
724   if (rc)
725     return map_assuan_err (rc);
726   return learn_parm.error;
727 }
728