Key generation and signing using the OpenPGP card does rudimentary work.
[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
344 \f
345 #if 0
346 /* Handle a KEYPARMS inquiry.  Note, we only send the data,
347    assuan_transact takes care of flushing and writing the end */
348 static AssuanError
349 inq_genkey_parms (void *opaque, const char *keyword)
350 {
351   struct genkey_parm_s *parm = opaque; 
352   AssuanError rc;
353
354   rc = assuan_send_data (parm->ctx, parm->sexp, parm->sexplen);
355   return rc; 
356 }
357
358
359 \f
360 /* Call the agent to generate a new key */
361 int
362 agent_genkey (KsbaConstSexp keyparms, KsbaSexp *r_pubkey)
363 {
364   int rc;
365   struct genkey_parm_s gk_parm;
366   membuf_t data;
367   size_t len;
368   char *buf;
369
370   *r_pubkey = NULL;
371   rc = start_agent ();
372   if (rc)
373     return rc;
374
375   rc = assuan_transact (agent_ctx, "RESET", NULL, NULL,
376                         NULL, NULL, NULL, NULL);
377   if (rc)
378     return map_assuan_err (rc);
379
380   init_membuf (&data, 1024);
381   gk_parm.ctx = agent_ctx;
382   gk_parm.sexp = keyparms;
383   gk_parm.sexplen = gcry_sexp_canon_len (keyparms, 0, NULL, NULL);
384   if (!gk_parm.sexplen)
385     return gpg_error (GPG_ERR_INV_VALUE);
386   rc = assuan_transact (agent_ctx, "GENKEY",
387                         membuf_data_cb, &data, 
388                         inq_genkey_parms, &gk_parm, NULL, NULL);
389   if (rc)
390     {
391       xfree (get_membuf (&data, &len));
392       return map_assuan_err (rc);
393     }
394   buf = get_membuf (&data, &len);
395   if (!buf)
396     return gpg_error (GPG_ERR_ENOMEM);
397   if (!gcry_sexp_canon_len (buf, len, NULL, NULL))
398     {
399       xfree (buf);
400       return gpg_error (GPG_ERR_INV_SEXP);
401     }
402   *r_pubkey = buf;
403   return 0;
404 }
405 #endif /*0*/
406
407
408 \f
409 /* Ask the agent whether the corresponding secret key is available for
410    the given keygrip. */
411 int
412 agent_havekey (const char *hexkeygrip)
413 {
414   int rc;
415   char line[ASSUAN_LINELENGTH];
416
417   rc = start_agent ();
418   if (rc)
419     return rc;
420
421   if (!hexkeygrip || strlen (hexkeygrip) != 40)
422     return gpg_error (GPG_ERR_INV_VALUE);
423
424   snprintf (line, DIM(line)-1, "HAVEKEY %s", hexkeygrip);
425   line[DIM(line)-1] = 0;
426
427   rc = assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
428   return map_assuan_err (rc);
429 }
430
431 \f
432 static AssuanError
433 learn_status_cb (void *opaque, const char *line)
434 {
435   struct agent_card_info_s *parm = opaque;
436   const char *keyword = line;
437   int keywordlen;
438
439   log_debug ("got status line `%s'\n", line);
440   for (keywordlen=0; *line && !spacep (line); line++, keywordlen++)
441     ;
442   while (spacep (line))
443     line++;
444
445   if (keywordlen == 9 && !memcmp (keyword, "DISP-NAME", keywordlen))
446     {
447       parm->disp_name = unescape_status_string (line);
448     }
449   else if (keywordlen == 10 && !memcmp (keyword, "PUBKEY_URL", keywordlen))
450     {
451       parm->pubkey_url = unescape_status_string (line);
452     }
453   else if (keywordlen == 7 && !memcmp (keyword, "KEY-FPR", keywordlen))
454     {
455       int no = atoi (line);
456       while (!spacep (line))
457         line++;
458       while (spacep (line))
459         line++;
460       if (no == 1)
461         parm->fpr1valid = unhexify_fpr (line, parm->fpr1);
462       else if (no == 2)
463         parm->fpr2valid = unhexify_fpr (line, parm->fpr2);
464       else if (no == 3)
465         parm->fpr3valid = unhexify_fpr (line, parm->fpr3);
466     }
467   
468   return 0;
469 }
470
471 /* Call the agent to learn about a smartcard */
472 int
473 agent_learn (struct agent_card_info_s *info)
474 {
475   int rc;
476
477   rc = start_agent ();
478   if (rc)
479     return rc;
480
481   memset (info, 0, sizeof *info);
482   rc = assuan_transact (agent_ctx, "LEARN --send",
483                         NULL, NULL, NULL, NULL,
484                         learn_status_cb, info);
485   
486   return map_assuan_err (rc);
487 }
488
489
490 \f
491 /* Send an setattr command to the SCdaemon. */
492 int
493 agent_scd_setattr (const char *name,
494                    const unsigned char *value, size_t valuelen)
495 {
496   int rc;
497   char line[ASSUAN_LINELENGTH];
498   char *p;
499
500   if (!*name || !valuelen)
501     return gpg_error (GPG_ERR_INV_VALUE);
502
503   /* We assume that NAME does not need escaping. */
504   if (12 + strlen (name) > DIM(line)-1)
505     return gpg_error (GPG_ERR_TOO_LARGE);
506       
507   p = stpcpy (stpcpy (line, "SCD SETATTR "), name); 
508   *p++ = ' ';
509   for (; valuelen; value++, valuelen--)
510     {
511       if (p >= line + DIM(line)-5 )
512         return gpg_error (GPG_ERR_TOO_LARGE);
513       if (*value < ' ' || *value == '+' || *value == '%')
514         {
515           sprintf (p, "%%%02X", *value);
516           p += 3;
517         }
518       else if (*value == ' ')
519         *p++ = '+';
520       else
521         *p++ = *value;
522     }
523   *p = 0;
524
525   rc = start_agent ();
526   if (rc)
527     return rc;
528
529   rc = assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
530   return map_assuan_err (rc);
531 }
532
533 \f
534 /* Status callback for the SCD GENKEY command. */
535 static AssuanError
536 scd_genkey_cb (void *opaque, const char *line)
537 {
538   struct agent_card_genkey_s *parm = opaque;
539   const char *keyword = line;
540   int keywordlen;
541   gpg_error_t rc;
542
543   log_debug ("got status line `%s'\n", line);
544   for (keywordlen=0; *line && !spacep (line); line++, keywordlen++)
545     ;
546   while (spacep (line))
547     line++;
548
549   if (keywordlen == 7 && !memcmp (keyword, "KEY-FPR", keywordlen))
550     {
551       parm->fprvalid = unhexify_fpr (line, parm->fpr);
552     }
553   if (keywordlen == 8 && !memcmp (keyword, "KEY-DATA", keywordlen))
554     {
555       gcry_mpi_t a;
556       const char *name = line;
557
558       while (!spacep (line))
559         line++;
560       while (spacep (line))
561         line++;
562
563       rc = gcry_mpi_scan (&a, GCRYMPI_FMT_HEX, line, 0);
564       if (rc)
565         log_error ("error parsing received key data: %s\n", gpg_strerror (rc));
566       else if (*name == 'n' && spacep (name+1))
567         parm->n = a;
568       else if (*name == 'e' && spacep (name+1))
569         parm->e = a;
570       else
571         {
572           log_info ("unknown parameter name in received key data\n");
573           gcry_mpi_release (a);
574         }
575     }
576   else if (keywordlen == 14 && !memcmp (keyword,"KEY-CREATED-AT", keywordlen))
577     {
578       parm->created_at = (u32)strtoul (line, NULL, 10);
579     }
580
581   return 0;
582 }
583
584 /* Send a GENKEY command to the SCdaemon. */
585 int
586 agent_scd_genkey (struct agent_card_genkey_s *info, int keyno, int force)
587 {
588   int rc;
589   char line[ASSUAN_LINELENGTH];
590
591   rc = start_agent ();
592   if (rc)
593     return rc;
594
595   memset (info, 0, sizeof *info);
596   snprintf (line, DIM(line)-1, "SCD GENKEY %s%d",
597             force? "--force ":"", keyno);
598   line[DIM(line)-1] = 0;
599
600   memset (info, 0, sizeof *info);
601   rc = assuan_transact (agent_ctx, line,
602                         NULL, NULL, NULL, NULL,
603                         scd_genkey_cb, info);
604   
605   return map_assuan_err (rc);
606 }
607
608 \f
609 static AssuanError
610 membuf_data_cb (void *opaque, const void *buffer, size_t length)
611 {
612   membuf_t *data = opaque;
613
614   if (buffer)
615     put_membuf (data, buffer, length);
616   return 0;
617 }
618   
619 /* Send a sign command to the scdaemon via gpg-agent's pass thru
620    mechanism. */
621 int
622 agent_scd_pksign (const char *keyid, int hashalgo,
623                   const unsigned char *indata, size_t indatalen,
624                   char **r_buf, size_t *r_buflen)
625 {
626   int rc, i;
627   char *p, line[ASSUAN_LINELENGTH];
628   membuf_t data;
629   size_t len;
630
631   /* Note, hashalgo is not yet used but hardwired to SHA1 in SCdaemon. */
632
633   *r_buf = NULL;
634   *r_buflen = 0;
635
636   rc = start_agent ();
637   if (rc)
638     return rc;
639
640   if (indatalen*2 + 50 > DIM(line))
641     return gpg_error (GPG_ERR_GENERAL);
642
643   sprintf (line, "SCD SETDATA ");
644   p = line + strlen (line);
645   for (i=0; i < indatalen ; i++, p += 2 )
646     sprintf (p, "%02X", indata[i]);
647   rc = assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
648   if (rc)
649     return rc;
650
651   init_membuf (&data, 1024);
652   snprintf (line, DIM(line)-1, "SCD PKSIGN %s", keyid);
653   line[DIM(line)-1] = 0;
654   rc = assuan_transact (agent_ctx, line, membuf_data_cb, &data,
655                         NULL, NULL, NULL, NULL);
656   if (rc)
657     {
658       xfree (get_membuf (&data, &len));
659       return rc;
660     }
661   *r_buf = get_membuf (&data, r_buflen);
662
663   return 0;
664 }
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686