* options.h (DBG_CIPHER): Reintroduced it.
[gnupg.git] / g10 / call-agent.c
1 /* call-agent.c - divert operations to the agent
2  *      Copyright (C) 2001, 2002, 2003 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 #if 0  /* lety Emacs display a red warning */
22 #error fixme: this shares a lof of code with the file in ../sm
23 #endif
24
25 #include <config.h>
26 #include <stdio.h>
27 #include <stdlib.h>
28 #include <string.h>
29 #include <errno.h>
30 #include <unistd.h> 
31 #include <time.h>
32 #include <assert.h>
33 #ifdef HAVE_LOCALE_H
34 #include <locale.h>
35 #endif
36 #include <assuan.h>
37
38 #include "gpg.h"
39 #include "util.h"
40 #include "membuf.h"
41 #include "options.h"
42 #include "i18n.h"
43 #include "call-agent.h"
44
45 #ifndef DBG_ASSUAN
46 # define DBG_ASSUAN 1
47 #endif
48
49 static ASSUAN_CONTEXT agent_ctx = NULL;
50 static int force_pipe_server = 1; /* FIXME: set this back to 0. */
51
52 struct cipher_parm_s {
53   ASSUAN_CONTEXT ctx;
54   const char *ciphertext;
55   size_t ciphertextlen;
56 };
57
58 struct genkey_parm_s {
59   ASSUAN_CONTEXT ctx;
60   const char *sexp;
61   size_t sexplen;
62 };
63
64
65 \f
66 /* Try to connect to the agent via socket or fork it off and work by
67    pipes.  Handle the server's initial greeting */
68 static int
69 start_agent (void)
70 {
71   int rc = 0;
72   char *infostr, *p;
73   ASSUAN_CONTEXT ctx;
74   char *dft_display = NULL;
75   char *dft_ttyname = NULL;
76   char *dft_ttytype = NULL;
77   char *old_lc = NULL;
78   char *dft_lc = NULL;
79
80   if (agent_ctx)
81     return 0; /* fixme: We need a context for each thread or serialize
82                  the access to the agent. */
83
84   infostr = force_pipe_server? NULL : getenv ("GPG_AGENT_INFO");
85   if (!infostr)
86     {
87       const char *pgmname;
88       const char *argv[3];
89       int no_close_list[3];
90       int i;
91
92       if (opt.verbose)
93         log_info (_("no running gpg-agent - starting one\n"));
94
95       if (fflush (NULL))
96         {
97           gpg_error_t tmperr = gpg_error_from_errno (errno);
98           log_error ("error flushing pending output: %s\n", strerror (errno));
99           return tmperr;
100         }
101
102       if (!opt.agent_program || !*opt.agent_program)
103         opt.agent_program = GNUPG_DEFAULT_AGENT;
104       if ( !(pgmname = strrchr (opt.agent_program, '/')))
105         pgmname = opt.agent_program;
106       else
107         pgmname++;
108
109       argv[0] = pgmname;
110       argv[1] = "--server";
111       argv[2] = NULL;
112
113       i=0;
114       if (log_get_fd () != -1)
115         no_close_list[i++] = log_get_fd ();
116       no_close_list[i++] = fileno (stderr);
117       no_close_list[i] = -1;
118
119       /* connect to the agent and perform initial handshaking */
120       rc = assuan_pipe_connect (&ctx, opt.agent_program, (char**)argv,
121                                 no_close_list);
122     }
123   else
124     {
125       int prot;
126       int pid;
127
128       infostr = xstrdup (infostr);
129       if ( !(p = strchr (infostr, ':')) || p == infostr)
130         {
131           log_error (_("malformed GPG_AGENT_INFO environment variable\n"));
132           xfree (infostr);
133           force_pipe_server = 1;
134           return start_agent ();
135         }
136       *p++ = 0;
137       pid = atoi (p);
138       while (*p && *p != ':')
139         p++;
140       prot = *p? atoi (p+1) : 0;
141       if (prot != 1)
142         {
143           log_error (_("gpg-agent protocol version %d is not supported\n"),
144                      prot);
145           xfree (infostr);
146           force_pipe_server = 1;
147           return start_agent ();
148         }
149
150       rc = assuan_socket_connect (&ctx, infostr, pid);
151       xfree (infostr);
152       if (rc == ASSUAN_Connect_Failed)
153         {
154           log_error (_("can't connect to the agent - trying fall back\n"));
155           force_pipe_server = 1;
156           return start_agent ();
157         }
158     }
159
160   if (rc)
161     {
162       log_error ("can't connect to the agent: %s\n", assuan_strerror (rc));
163       return gpg_error (GPG_ERR_NO_AGENT);
164     }
165   agent_ctx = ctx;
166
167   if (DBG_ASSUAN)
168     log_debug ("connection to agent established\n");
169
170   rc = assuan_transact (agent_ctx, "RESET", NULL, NULL, NULL, NULL, NULL, NULL);
171   if (rc)
172     return map_assuan_err (rc);
173
174   dft_display = getenv ("DISPLAY");
175   if (opt.display || dft_display)
176     {
177       char *optstr;
178       if (asprintf (&optstr, "OPTION display=%s",
179                     opt.display ? opt.display : dft_display) < 0)
180         return gpg_error_from_errno (errno);
181       rc = assuan_transact (agent_ctx, optstr, NULL, NULL, NULL, NULL, NULL,
182                             NULL);
183       free (optstr);
184       if (rc)
185         return map_assuan_err (rc);
186     }
187   if (!opt.ttyname)
188     {
189       dft_ttyname = getenv ("GPG_TTY");
190       if ((!dft_ttyname || !*dft_ttyname) && ttyname (0))
191         dft_ttyname = ttyname (0);
192     }
193   if (opt.ttyname || dft_ttyname)
194     {
195       char *optstr;
196       if (asprintf (&optstr, "OPTION ttyname=%s",
197                     opt.ttyname ? opt.ttyname : dft_ttyname) < 0)
198         return gpg_error_from_errno (errno);
199       rc = assuan_transact (agent_ctx, optstr, NULL, NULL, NULL, NULL, NULL,
200                             NULL);
201       free (optstr);
202       if (rc)
203         return map_assuan_err (rc);
204     }
205   dft_ttytype = getenv ("TERM");
206   if (opt.ttytype || (dft_ttyname && dft_ttytype))
207     {
208       char *optstr;
209       if (asprintf (&optstr, "OPTION ttytype=%s",
210                     opt.ttyname ? opt.ttytype : dft_ttytype) < 0)
211         return gpg_error_from_errno (errno);
212       rc = assuan_transact (agent_ctx, optstr, NULL, NULL, NULL, NULL, NULL,
213                             NULL);
214       free (optstr);
215       if (rc)
216         return map_assuan_err (rc);
217     }
218 #if defined(HAVE_SETLOCALE) && defined(LC_CTYPE)
219   old_lc = setlocale (LC_CTYPE, NULL);
220   if (old_lc)
221     {
222       old_lc = strdup (old_lc);
223       if (!old_lc)
224         return gpg_error_from_errno (errno);
225
226     }
227   dft_lc = setlocale (LC_CTYPE, "");
228 #endif
229   if (opt.lc_ctype || (dft_ttyname && dft_lc))
230     {
231       char *optstr;
232       if (asprintf (&optstr, "OPTION lc-ctype=%s",
233                     opt.lc_ctype ? opt.lc_ctype : dft_lc) < 0)
234         rc = gpg_error_from_errno (errno);
235       else
236         {
237           rc = assuan_transact (agent_ctx, optstr, NULL, NULL, NULL, NULL, NULL,
238                                 NULL);
239           free (optstr);
240           if (rc)
241             rc = map_assuan_err (rc);
242         }
243     }
244 #if defined(HAVE_SETLOCALE) && defined(LC_CTYPE)
245   if (old_lc)
246     {
247       setlocale (LC_CTYPE, old_lc);
248       free (old_lc);
249     }
250 #endif
251   if (rc)
252     return rc;
253 #if defined(HAVE_SETLOCALE) && defined(LC_MESSAGES)
254   old_lc = setlocale (LC_MESSAGES, NULL);
255   if (old_lc)
256     {
257       old_lc = strdup (old_lc);
258       if (!old_lc)
259         return gpg_error_from_errno (errno);
260     }
261   dft_lc = setlocale (LC_MESSAGES, "");
262 #endif
263   if (opt.lc_messages || (dft_ttyname && dft_lc))
264     {
265       char *optstr;
266       if (asprintf (&optstr, "OPTION lc-messages=%s",
267                     opt.lc_messages ? opt.lc_messages : dft_lc) < 0)
268         rc = gpg_error_from_errno (errno);
269       else
270         {
271           rc = assuan_transact (agent_ctx, optstr, NULL, NULL, NULL, NULL, NULL,
272                                 NULL);
273           free (optstr);
274           if (rc)
275             rc = map_assuan_err (rc);
276         }
277     }
278 #if defined(HAVE_SETLOCALE) && defined(LC_MESSAGES)
279   if (old_lc)
280     {
281       setlocale (LC_MESSAGES, old_lc);
282       free (old_lc);
283     }
284 #endif
285
286   return rc;
287 }
288
289
290 /* Return a new malloced string by unescaping the string S.  Escaping
291    is percent escaping and '+'/space mapping.  A binary nul will
292    silently be replaced by a 0xFF.  Function returns NULL to indicate
293    an out of memory status. */
294 static char *
295 unescape_status_string (const unsigned char *s)
296 {
297   char *buffer, *d;
298
299   buffer = d = xtrymalloc (strlen (s)+1);
300   if (!buffer)
301     return NULL;
302   while (*s)
303     {
304       if (*s == '%' && s[1] && s[2])
305         { 
306           s++;
307           *d = xtoi_2 (s);
308           if (!*d)
309             *d = '\xff';
310           d++;
311           s += 2;
312         }
313       else if (*s == '+')
314         {
315           *d++ = ' ';
316           s++;
317         }
318       else
319         *d++ = *s++;
320     }
321   *d = 0; 
322   return buffer;
323 }
324
325 /* Take a 20 byte hexencoded string and put it into the the provided
326    20 byte buffer FPR in binary format. */
327 static int
328 unhexify_fpr (const char *hexstr, unsigned char *fpr)
329 {
330   const char *s;
331   int n;
332
333   for (s=hexstr, n=0; hexdigitp (s); s++, n++)
334     ;
335   if (*s || (n != 40))
336     return 0; /* no fingerprint (invalid or wrong length). */
337   n /= 2;
338   for (s=hexstr, n=0; *s; s += 2, n++)
339     fpr[n] = xtoi_2 (s);
340   return 1; /* okay */
341 }
342
343 /* Take the serial number from LINE and return it verbatim in a newly
344    allocated string.  We make sure that only hex characters are
345    returned. */
346 static char *
347 store_serialno (const char *line)
348 {
349   const char *s;
350   char *p;
351
352   for (s=line; hexdigitp (s); s++)
353     ;
354   p = xtrymalloc (s + 1 - line);
355   if (p)
356     {
357       memcpy (p, line, s-line);
358       p[s-line] = 0;
359     }
360   return p;
361 }
362
363
364 \f
365 #if 0
366 /* Handle a KEYPARMS inquiry.  Note, we only send the data,
367    assuan_transact takes care of flushing and writing the end */
368 static AssuanError
369 inq_genkey_parms (void *opaque, const char *keyword)
370 {
371   struct genkey_parm_s *parm = opaque; 
372   AssuanError rc;
373
374   rc = assuan_send_data (parm->ctx, parm->sexp, parm->sexplen);
375   return rc; 
376 }
377
378
379 \f
380 /* Call the agent to generate a new key */
381 int
382 agent_genkey (KsbaConstSexp keyparms, KsbaSexp *r_pubkey)
383 {
384   int rc;
385   struct genkey_parm_s gk_parm;
386   membuf_t data;
387   size_t len;
388   char *buf;
389
390   *r_pubkey = NULL;
391   rc = start_agent ();
392   if (rc)
393     return rc;
394
395   rc = assuan_transact (agent_ctx, "RESET", NULL, NULL,
396                         NULL, NULL, NULL, NULL);
397   if (rc)
398     return map_assuan_err (rc);
399
400   init_membuf (&data, 1024);
401   gk_parm.ctx = agent_ctx;
402   gk_parm.sexp = keyparms;
403   gk_parm.sexplen = gcry_sexp_canon_len (keyparms, 0, NULL, NULL);
404   if (!gk_parm.sexplen)
405     return gpg_error (GPG_ERR_INV_VALUE);
406   rc = assuan_transact (agent_ctx, "GENKEY",
407                         membuf_data_cb, &data, 
408                         inq_genkey_parms, &gk_parm, NULL, NULL);
409   if (rc)
410     {
411       xfree (get_membuf (&data, &len));
412       return map_assuan_err (rc);
413     }
414   buf = get_membuf (&data, &len);
415   if (!buf)
416     return gpg_error (GPG_ERR_ENOMEM);
417   if (!gcry_sexp_canon_len (buf, len, NULL, NULL))
418     {
419       xfree (buf);
420       return gpg_error (GPG_ERR_INV_SEXP);
421     }
422   *r_pubkey = buf;
423   return 0;
424 }
425 #endif /*0*/
426
427
428 \f
429 /* Ask the agent whether the corresponding secret key is available for
430    the given keygrip. */
431 int
432 agent_havekey (const char *hexkeygrip)
433 {
434   int rc;
435   char line[ASSUAN_LINELENGTH];
436
437   rc = start_agent ();
438   if (rc)
439     return rc;
440
441   if (!hexkeygrip || strlen (hexkeygrip) != 40)
442     return gpg_error (GPG_ERR_INV_VALUE);
443
444   snprintf (line, DIM(line)-1, "HAVEKEY %s", hexkeygrip);
445   line[DIM(line)-1] = 0;
446
447   rc = assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
448   return map_assuan_err (rc);
449 }
450
451 \f
452 static AssuanError
453 learn_status_cb (void *opaque, const char *line)
454 {
455   struct agent_card_info_s *parm = opaque;
456   const char *keyword = line;
457   int keywordlen;
458
459   for (keywordlen=0; *line && !spacep (line); line++, keywordlen++)
460     ;
461   while (spacep (line))
462     line++;
463
464   if (keywordlen == 8 && !memcmp (keyword, "SERIALNO", keywordlen))
465     {
466       parm->serialno = store_serialno (line);
467     }
468   else if (keywordlen == 9 && !memcmp (keyword, "DISP-NAME", keywordlen))
469     {
470       parm->disp_name = unescape_status_string (line);
471     }
472   else if (keywordlen == 10 && !memcmp (keyword, "PUBKEY-URL", keywordlen))
473     {
474       parm->pubkey_url = unescape_status_string (line);
475     }
476   else if (keywordlen == 7 && !memcmp (keyword, "KEY-FPR", keywordlen))
477     {
478       int no = atoi (line);
479       while (!spacep (line))
480         line++;
481       while (spacep (line))
482         line++;
483       if (no == 1)
484         parm->fpr1valid = unhexify_fpr (line, parm->fpr1);
485       else if (no == 2)
486         parm->fpr2valid = unhexify_fpr (line, parm->fpr2);
487       else if (no == 3)
488         parm->fpr3valid = unhexify_fpr (line, parm->fpr3);
489     }
490   
491   return 0;
492 }
493
494 /* Call the agent to learn about a smartcard */
495 int
496 agent_learn (struct agent_card_info_s *info)
497 {
498   int rc;
499
500   rc = start_agent ();
501   if (rc)
502     return rc;
503
504   memset (info, 0, sizeof *info);
505   rc = assuan_transact (agent_ctx, "LEARN --send",
506                         NULL, NULL, NULL, NULL,
507                         learn_status_cb, info);
508   
509   return map_assuan_err (rc);
510 }
511
512
513 \f
514 /* Send an setattr command to the SCdaemon. */
515 int
516 agent_scd_setattr (const char *name,
517                    const unsigned char *value, size_t valuelen)
518 {
519   int rc;
520   char line[ASSUAN_LINELENGTH];
521   char *p;
522
523   if (!*name || !valuelen)
524     return gpg_error (GPG_ERR_INV_VALUE);
525
526   /* We assume that NAME does not need escaping. */
527   if (12 + strlen (name) > DIM(line)-1)
528     return gpg_error (GPG_ERR_TOO_LARGE);
529       
530   p = stpcpy (stpcpy (line, "SCD SETATTR "), name); 
531   *p++ = ' ';
532   for (; valuelen; value++, valuelen--)
533     {
534       if (p >= line + DIM(line)-5 )
535         return gpg_error (GPG_ERR_TOO_LARGE);
536       if (*value < ' ' || *value == '+' || *value == '%')
537         {
538           sprintf (p, "%%%02X", *value);
539           p += 3;
540         }
541       else if (*value == ' ')
542         *p++ = '+';
543       else
544         *p++ = *value;
545     }
546   *p = 0;
547
548   rc = start_agent ();
549   if (rc)
550     return rc;
551
552   rc = assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
553   return map_assuan_err (rc);
554 }
555
556 \f
557 /* Status callback for the SCD GENKEY command. */
558 static AssuanError
559 scd_genkey_cb (void *opaque, const char *line)
560 {
561   struct agent_card_genkey_s *parm = opaque;
562   const char *keyword = line;
563   int keywordlen;
564   gpg_error_t rc;
565
566   log_debug ("got status line `%s'\n", line);
567   for (keywordlen=0; *line && !spacep (line); line++, keywordlen++)
568     ;
569   while (spacep (line))
570     line++;
571
572   if (keywordlen == 7 && !memcmp (keyword, "KEY-FPR", keywordlen))
573     {
574       parm->fprvalid = unhexify_fpr (line, parm->fpr);
575     }
576   if (keywordlen == 8 && !memcmp (keyword, "KEY-DATA", keywordlen))
577     {
578       gcry_mpi_t a;
579       const char *name = line;
580
581       while (!spacep (line))
582         line++;
583       while (spacep (line))
584         line++;
585
586       rc = gcry_mpi_scan (&a, GCRYMPI_FMT_HEX, line, 0);
587       if (rc)
588         log_error ("error parsing received key data: %s\n", gpg_strerror (rc));
589       else if (*name == 'n' && spacep (name+1))
590         parm->n = a;
591       else if (*name == 'e' && spacep (name+1))
592         parm->e = a;
593       else
594         {
595           log_info ("unknown parameter name in received key data\n");
596           gcry_mpi_release (a);
597         }
598     }
599   else if (keywordlen == 14 && !memcmp (keyword,"KEY-CREATED-AT", keywordlen))
600     {
601       parm->created_at = (u32)strtoul (line, NULL, 10);
602     }
603
604   return 0;
605 }
606
607 /* Send a GENKEY command to the SCdaemon. */
608 int
609 agent_scd_genkey (struct agent_card_genkey_s *info, int keyno, int force)
610 {
611   int rc;
612   char line[ASSUAN_LINELENGTH];
613
614   rc = start_agent ();
615   if (rc)
616     return rc;
617
618   memset (info, 0, sizeof *info);
619   snprintf (line, DIM(line)-1, "SCD GENKEY %s%d",
620             force? "--force ":"", keyno);
621   line[DIM(line)-1] = 0;
622
623   memset (info, 0, sizeof *info);
624   rc = assuan_transact (agent_ctx, line,
625                         NULL, NULL, NULL, NULL,
626                         scd_genkey_cb, info);
627   
628   return map_assuan_err (rc);
629 }
630
631 \f
632 static AssuanError
633 membuf_data_cb (void *opaque, const void *buffer, size_t length)
634 {
635   membuf_t *data = opaque;
636
637   if (buffer)
638     put_membuf (data, buffer, length);
639   return 0;
640 }
641   
642 /* Send a sign command to the scdaemon via gpg-agent's pass thru
643    mechanism. */
644 int
645 agent_scd_pksign (const char *serialno, int hashalgo,
646                   const unsigned char *indata, size_t indatalen,
647                   char **r_buf, size_t *r_buflen)
648 {
649   int rc, i;
650   char *p, line[ASSUAN_LINELENGTH];
651   membuf_t data;
652   size_t len;
653
654   /* Note, hashalgo is not yet used but hardwired to SHA1 in SCdaemon. */
655
656   *r_buf = NULL;
657   *r_buflen = 0;
658
659   rc = start_agent ();
660   if (rc)
661     return rc;
662
663   if (indatalen*2 + 50 > DIM(line))
664     return gpg_error (GPG_ERR_GENERAL);
665
666   sprintf (line, "SCD SETDATA ");
667   p = line + strlen (line);
668   for (i=0; i < indatalen ; i++, p += 2 )
669     sprintf (p, "%02X", indata[i]);
670   rc = assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
671   if (rc)
672     return map_assuan_err (rc);
673
674   init_membuf (&data, 1024);
675   snprintf (line, DIM(line)-1, "SCD PKSIGN %s", serialno);
676   line[DIM(line)-1] = 0;
677   rc = assuan_transact (agent_ctx, line, membuf_data_cb, &data,
678                         NULL, NULL, NULL, NULL);
679   if (rc)
680     {
681       xfree (get_membuf (&data, &len));
682       return map_assuan_err (rc);
683     }
684   *r_buf = get_membuf (&data, r_buflen);
685
686   return 0;
687 }
688
689
690 /* Decrypt INDATA of length INDATALEN using the card identified by
691    SERIALNO.  Return the plaintext in a nwly allocated buffer stored
692    at the address of R_BUF. 
693
694    Note, we currently support only RSA or more exactly algorithms
695    taking one input data element. */
696 int
697 agent_scd_pkdecrypt (const char *serialno,
698                      const unsigned char *indata, size_t indatalen,
699                      char **r_buf, size_t *r_buflen)
700 {
701   int rc, i;
702   char *p, line[ASSUAN_LINELENGTH];
703   membuf_t data;
704   size_t len;
705
706   *r_buf = NULL;
707   rc = start_agent ();
708   if (rc)
709     return rc;
710
711   /* FIXME: use secure memory where appropriate */
712   if (indatalen*2 + 50 > DIM(line))
713     return gpg_error (GPG_ERR_GENERAL);
714
715   sprintf (line, "SCD SETDATA ");
716   p = line + strlen (line);
717   for (i=0; i < indatalen ; i++, p += 2 )
718     sprintf (p, "%02X", indata[i]);
719   rc = assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
720   if (rc)
721     return map_assuan_err (rc);
722
723   init_membuf (&data, 1024);
724   snprintf (line, DIM(line)-1, "SCD PKDECRYPT %s", serialno);
725   line[DIM(line)-1] = 0;
726   rc = assuan_transact (agent_ctx, line,
727                         membuf_data_cb, &data,
728                         NULL, NULL, NULL, NULL);
729   if (rc)
730     {
731       xfree (get_membuf (&data, &len));
732       return map_assuan_err (rc);
733     }
734   *r_buf = get_membuf (&data, r_buflen);
735   if (!*r_buf)
736     return gpg_error (GPG_ERR_ENOMEM);
737
738   return 0;
739 }
740