772c9c3129b5fcf7545b9ccd44b2bf1315f0848d
[gnupg.git] / sm / call-agent.c
1 /* call-agent.c - Divert GPGSM operations to the agent
2  * Copyright (C) 2001, 2002, 2003, 2005, 2007,
3  *               2008, 2009, 2010 Free Software Foundation, Inc.
4  *
5  * This file is part of GnuPG.
6  *
7  * GnuPG is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * GnuPG is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, see <https://www.gnu.org/licenses/>.
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 #ifdef HAVE_LOCALE_H
30 #include <locale.h>
31 #endif
32
33 #include "gpgsm.h"
34 #include <gcrypt.h>
35 #include <assuan.h>
36 #include "../common/i18n.h"
37 #include "../common/asshelp.h"
38 #include "keydb.h" /* fixme: Move this to import.c */
39 #include "../common/membuf.h"
40 #include "../common/shareddefs.h"
41 #include "passphrase.h"
42
43
44 static assuan_context_t agent_ctx = NULL;
45
46
47 struct cipher_parm_s
48 {
49   ctrl_t ctrl;
50   assuan_context_t ctx;
51   const unsigned char *ciphertext;
52   size_t ciphertextlen;
53 };
54
55 struct genkey_parm_s
56 {
57   ctrl_t ctrl;
58   assuan_context_t ctx;
59   const unsigned char *sexp;
60   size_t sexplen;
61 };
62
63 struct learn_parm_s
64 {
65   int error;
66   ctrl_t ctrl;
67   assuan_context_t ctx;
68   membuf_t *data;
69 };
70
71 struct import_key_parm_s
72 {
73   ctrl_t ctrl;
74   assuan_context_t ctx;
75   const void *key;
76   size_t keylen;
77 };
78
79 struct default_inq_parm_s
80 {
81   ctrl_t ctrl;
82   assuan_context_t ctx;
83 };
84
85 \f
86 /* Print a warning if the server's version number is less than our
87    version number.  Returns an error code on a connection problem.  */
88 static gpg_error_t
89 warn_version_mismatch (ctrl_t ctrl, assuan_context_t ctx,
90                        const char *servername, int mode)
91 {
92   gpg_error_t err;
93   char *serverversion;
94   const char *myversion = strusage (13);
95
96   err = get_assuan_server_version (ctx, mode, &serverversion);
97   if (err)
98     log_error (_("error getting version from '%s': %s\n"),
99                servername, gpg_strerror (err));
100   else if (compare_version_strings (serverversion, myversion) < 0)
101     {
102       char *warn;
103
104       warn = xtryasprintf (_("server '%s' is older than us (%s < %s)"),
105                            servername, serverversion, myversion);
106       if (!warn)
107         err = gpg_error_from_syserror ();
108       else
109         {
110           log_info (_("WARNING: %s\n"), warn);
111           if (!opt.quiet)
112             {
113               log_info (_("Note: Outdated servers may lack important"
114                           " security fixes.\n"));
115               log_info (_("Note: Use the command \"%s\" to restart them.\n"),
116                         "gpgconf --kill all");
117             }
118           gpgsm_status2 (ctrl, STATUS_WARNING, "server_version_mismatch 0",
119                          warn, NULL);
120           xfree (warn);
121         }
122     }
123   xfree (serverversion);
124   return err;
125 }
126
127
128 /* Try to connect to the agent via socket or fork it off and work by
129    pipes.  Handle the server's initial greeting */
130 static int
131 start_agent (ctrl_t ctrl)
132 {
133   int rc;
134
135   if (agent_ctx)
136     rc = 0;      /* fixme: We need a context for each thread or
137                     serialize the access to the agent (which is
138                     suitable given that the agent is not MT. */
139   else
140     {
141       rc = start_new_gpg_agent (&agent_ctx,
142                                 GPG_ERR_SOURCE_DEFAULT,
143                                 opt.agent_program,
144                                 opt.lc_ctype, opt.lc_messages,
145                                 opt.session_env,
146                                 opt.autostart, opt.verbose, DBG_IPC,
147                                 gpgsm_status2, ctrl);
148
149       if (!opt.autostart && gpg_err_code (rc) == GPG_ERR_NO_AGENT)
150         {
151           static int shown;
152
153           if (!shown)
154             {
155               shown = 1;
156               log_info (_("no gpg-agent running in this session\n"));
157             }
158         }
159       else if (!rc && !(rc = warn_version_mismatch (ctrl, agent_ctx,
160                                                     GPG_AGENT_NAME, 0)))
161         {
162           /* Tell the agent that we support Pinentry notifications.  No
163              error checking so that it will work also with older
164              agents.  */
165           assuan_transact (agent_ctx, "OPTION allow-pinentry-notify",
166                            NULL, NULL, NULL, NULL, NULL, NULL);
167
168           /* Pass on the pinentry mode.  */
169           if (opt.pinentry_mode)
170             {
171               char *tmp = xasprintf ("OPTION pinentry-mode=%s",
172                                      str_pinentry_mode (opt.pinentry_mode));
173               rc = assuan_transact (agent_ctx, tmp,
174                                NULL, NULL, NULL, NULL, NULL, NULL);
175               xfree (tmp);
176               if (rc)
177                 log_error ("setting pinentry mode '%s' failed: %s\n",
178                            str_pinentry_mode (opt.pinentry_mode),
179                            gpg_strerror (rc));
180             }
181
182           /* In DE_VS mode under Windows we require that the JENT RNG
183            * is active.  */
184 #ifdef HAVE_W32_SYSTEM
185           if (!rc && opt.compliance == CO_DE_VS)
186             {
187               if (assuan_transact (agent_ctx, "GETINFO jent_active",
188                                    NULL, NULL, NULL, NULL, NULL, NULL))
189                 {
190                   rc = gpg_error (GPG_ERR_FORBIDDEN);
191                   log_error (_("%s is not compliant with %s mode\n"),
192                              GPG_AGENT_NAME,
193                              gnupg_compliance_option_string (opt.compliance));
194                   gpgsm_status_with_error (ctrl, STATUS_ERROR,
195                                            "random-compliance", rc);
196                 }
197             }
198 #endif /*HAVE_W32_SYSTEM*/
199
200         }
201     }
202
203   if (!ctrl->agent_seen)
204     {
205       ctrl->agent_seen = 1;
206       audit_log_ok (ctrl->audit, AUDIT_AGENT_READY, rc);
207     }
208
209   return rc;
210 }
211
212 /* This is the default inquiry callback.  It mainly handles the
213    Pinentry notifications.  */
214 static gpg_error_t
215 default_inq_cb (void *opaque, const char *line)
216 {
217   gpg_error_t err = 0;
218   struct default_inq_parm_s *parm = opaque;
219   ctrl_t ctrl = parm->ctrl;
220
221   if (has_leading_keyword (line, "PINENTRY_LAUNCHED"))
222     {
223       err = gpgsm_proxy_pinentry_notify (ctrl, line);
224       if (err)
225         log_error (_("failed to proxy %s inquiry to client\n"),
226                    "PINENTRY_LAUNCHED");
227       /* We do not pass errors to avoid breaking other code.  */
228     }
229   else if ((has_leading_keyword (line, "PASSPHRASE")
230             || has_leading_keyword (line, "NEW_PASSPHRASE"))
231            && opt.pinentry_mode == PINENTRY_MODE_LOOPBACK
232            && have_static_passphrase ())
233     {
234       const char *s = get_static_passphrase ();
235       err = assuan_send_data (parm->ctx, s, strlen (s));
236     }
237   else
238     log_error ("ignoring gpg-agent inquiry '%s'\n", line);
239
240   return err;
241 }
242
243
244
245 \f
246 /* Call the agent to do a sign operation using the key identified by
247    the hex string KEYGRIP. */
248 int
249 gpgsm_agent_pksign (ctrl_t ctrl, const char *keygrip, const char *desc,
250                     unsigned char *digest, size_t digestlen, int digestalgo,
251                     unsigned char **r_buf, size_t *r_buflen )
252 {
253   int rc, i;
254   char *p, line[ASSUAN_LINELENGTH];
255   membuf_t data;
256   size_t len;
257   struct default_inq_parm_s inq_parm;
258
259   *r_buf = NULL;
260   rc = start_agent (ctrl);
261   if (rc)
262     return rc;
263   inq_parm.ctrl = ctrl;
264   inq_parm.ctx = agent_ctx;
265
266   if (digestlen*2 + 50 > DIM(line))
267     return gpg_error (GPG_ERR_GENERAL);
268
269   rc = assuan_transact (agent_ctx, "RESET", NULL, NULL, NULL, NULL, NULL, NULL);
270   if (rc)
271     return rc;
272
273   snprintf (line, DIM(line), "SIGKEY %s", keygrip);
274   rc = assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
275   if (rc)
276     return rc;
277
278   if (desc)
279     {
280       snprintf (line, DIM(line), "SETKEYDESC %s", desc);
281       rc = assuan_transact (agent_ctx, line,
282                             NULL, NULL, NULL, NULL, NULL, NULL);
283       if (rc)
284         return rc;
285     }
286
287   sprintf (line, "SETHASH %d ", digestalgo);
288   p = line + strlen (line);
289   for (i=0; i < digestlen ; i++, p += 2 )
290     sprintf (p, "%02X", digest[i]);
291   rc = assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
292   if (rc)
293     return rc;
294
295   init_membuf (&data, 1024);
296   rc = assuan_transact (agent_ctx, "PKSIGN",
297                         put_membuf_cb, &data, default_inq_cb, &inq_parm,
298                         NULL, NULL);
299   if (rc)
300     {
301       xfree (get_membuf (&data, &len));
302       return rc;
303     }
304   *r_buf = get_membuf (&data, r_buflen);
305
306   if (!gcry_sexp_canon_len (*r_buf, *r_buflen, NULL, NULL))
307     {
308       xfree (*r_buf); *r_buf = NULL;
309       return gpg_error (GPG_ERR_INV_VALUE);
310     }
311
312   return *r_buf? 0 : out_of_core ();
313 }
314
315
316 /* Call the scdaemon to do a sign operation using the key identified by
317    the hex string KEYID. */
318 int
319 gpgsm_scd_pksign (ctrl_t ctrl, const char *keyid, const char *desc,
320                   unsigned char *digest, size_t digestlen, int digestalgo,
321                   unsigned char **r_buf, size_t *r_buflen )
322 {
323   int rc, i;
324   char *p, line[ASSUAN_LINELENGTH];
325   membuf_t data;
326   size_t len;
327   const char *hashopt;
328   unsigned char *sigbuf;
329   size_t sigbuflen;
330   struct default_inq_parm_s inq_parm;
331
332   (void)desc;
333
334   *r_buf = NULL;
335
336   switch(digestalgo)
337     {
338     case GCRY_MD_SHA1:  hashopt = "--hash=sha1"; break;
339     case GCRY_MD_RMD160:hashopt = "--hash=rmd160"; break;
340     case GCRY_MD_MD5:   hashopt = "--hash=md5"; break;
341     case GCRY_MD_SHA256:hashopt = "--hash=sha256"; break;
342     default:
343       return gpg_error (GPG_ERR_DIGEST_ALGO);
344     }
345
346   rc = start_agent (ctrl);
347   if (rc)
348     return rc;
349   inq_parm.ctrl = ctrl;
350   inq_parm.ctx = agent_ctx;
351
352   if (digestlen*2 + 50 > DIM(line))
353     return gpg_error (GPG_ERR_GENERAL);
354
355   p = stpcpy (line, "SCD SETDATA " );
356   for (i=0; i < digestlen ; i++, p += 2 )
357     sprintf (p, "%02X", digest[i]);
358   rc = assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
359   if (rc)
360     return rc;
361
362   init_membuf (&data, 1024);
363
364   snprintf (line, DIM(line), "SCD PKSIGN %s %s", hashopt, keyid);
365   rc = assuan_transact (agent_ctx, line,
366                         put_membuf_cb, &data, default_inq_cb, &inq_parm,
367                         NULL, NULL);
368   if (rc)
369     {
370       xfree (get_membuf (&data, &len));
371       return rc;
372     }
373   sigbuf = get_membuf (&data, &sigbuflen);
374
375   /* Create an S-expression from it which is formatted like this:
376      "(7:sig-val(3:rsa(1:sSIGBUFLEN:SIGBUF)))" Fixme: If a card ever
377      creates non-RSA keys we need to change things. */
378   *r_buflen = 21 + 11 + sigbuflen + 4;
379   p = xtrymalloc (*r_buflen);
380   *r_buf = (unsigned char*)p;
381   if (!p)
382     {
383       xfree (sigbuf);
384       return 0;
385     }
386   p = stpcpy (p, "(7:sig-val(3:rsa(1:s" );
387   sprintf (p, "%u:", (unsigned int)sigbuflen);
388   p += strlen (p);
389   memcpy (p, sigbuf, sigbuflen);
390   p += sigbuflen;
391   strcpy (p, ")))");
392   xfree (sigbuf);
393
394   assert (gcry_sexp_canon_len (*r_buf, *r_buflen, NULL, NULL));
395   return  0;
396 }
397
398
399
400 \f
401 /* Handle a CIPHERTEXT inquiry.  Note, we only send the data,
402    assuan_transact takes care of flushing and writing the end */
403 static gpg_error_t
404 inq_ciphertext_cb (void *opaque, const char *line)
405 {
406   struct cipher_parm_s *parm = opaque;
407   int rc;
408
409   if (has_leading_keyword (line, "CIPHERTEXT"))
410     {
411       assuan_begin_confidential (parm->ctx);
412       rc = assuan_send_data (parm->ctx, parm->ciphertext, parm->ciphertextlen);
413       assuan_end_confidential (parm->ctx);
414     }
415   else
416     {
417       struct default_inq_parm_s inq_parm = { parm->ctrl, parm->ctx };
418       rc = default_inq_cb (&inq_parm, line);
419     }
420
421   return rc;
422 }
423
424
425 /* Call the agent to do a decrypt operation using the key identified by
426    the hex string KEYGRIP. */
427 int
428 gpgsm_agent_pkdecrypt (ctrl_t ctrl, const char *keygrip, const char *desc,
429                        ksba_const_sexp_t ciphertext,
430                        char **r_buf, size_t *r_buflen )
431 {
432   int rc;
433   char line[ASSUAN_LINELENGTH];
434    membuf_t data;
435   struct cipher_parm_s cipher_parm;
436   size_t n, len;
437   char *p, *buf, *endp;
438   size_t ciphertextlen;
439
440   if (!keygrip || strlen(keygrip) != 40 || !ciphertext || !r_buf || !r_buflen)
441     return gpg_error (GPG_ERR_INV_VALUE);
442   *r_buf = NULL;
443
444   ciphertextlen = gcry_sexp_canon_len (ciphertext, 0, NULL, NULL);
445   if (!ciphertextlen)
446     return gpg_error (GPG_ERR_INV_VALUE);
447
448   rc = start_agent (ctrl);
449   if (rc)
450     return rc;
451
452   rc = assuan_transact (agent_ctx, "RESET", NULL, NULL, NULL, NULL, NULL, NULL);
453   if (rc)
454     return rc;
455
456   assert ( DIM(line) >= 50 );
457   snprintf (line, DIM(line), "SETKEY %s", keygrip);
458   rc = assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
459   if (rc)
460     return rc;
461
462   if (desc)
463     {
464       snprintf (line, DIM(line), "SETKEYDESC %s", desc);
465       rc = assuan_transact (agent_ctx, line,
466                             NULL, NULL, NULL, NULL, NULL, NULL);
467       if (rc)
468         return rc;
469     }
470
471   init_membuf (&data, 1024);
472   cipher_parm.ctrl = ctrl;
473   cipher_parm.ctx = agent_ctx;
474   cipher_parm.ciphertext = ciphertext;
475   cipher_parm.ciphertextlen = ciphertextlen;
476   rc = assuan_transact (agent_ctx, "PKDECRYPT",
477                         put_membuf_cb, &data,
478                         inq_ciphertext_cb, &cipher_parm, NULL, NULL);
479   if (rc)
480     {
481       xfree (get_membuf (&data, &len));
482       return rc;
483     }
484
485   put_membuf (&data, "", 1); /* Make sure it is 0 terminated. */
486   buf = get_membuf (&data, &len);
487   if (!buf)
488     return gpg_error (GPG_ERR_ENOMEM);
489   assert (len); /* (we forced Nul termination.)  */
490
491   if (*buf == '(')
492     {
493       if (len < 13 || memcmp (buf, "(5:value", 8) ) /* "(5:valueN:D)\0" */
494         return gpg_error (GPG_ERR_INV_SEXP);
495       len -= 11;   /* Count only the data of the second part. */
496       p = buf + 8; /* Skip leading parenthesis and the value tag. */
497     }
498   else
499     {
500       /* For compatibility with older gpg-agents handle the old style
501          incomplete S-exps. */
502       len--;      /* Do not count the Nul. */
503       p = buf;
504     }
505
506   n = strtoul (p, &endp, 10);
507   if (!n || *endp != ':')
508     return gpg_error (GPG_ERR_INV_SEXP);
509   endp++;
510   if (endp-p+n > len)
511     return gpg_error (GPG_ERR_INV_SEXP); /* Oops: Inconsistent S-Exp. */
512
513   memmove (buf, endp, n);
514
515   *r_buflen = n;
516   *r_buf = buf;
517   return 0;
518 }
519
520
521
522
523 \f
524 /* Handle a KEYPARMS inquiry.  Note, we only send the data,
525    assuan_transact takes care of flushing and writing the end */
526 static gpg_error_t
527 inq_genkey_parms (void *opaque, const char *line)
528 {
529   struct genkey_parm_s *parm = opaque;
530   int rc;
531
532   if (has_leading_keyword (line, "KEYPARAM"))
533     {
534       rc = assuan_send_data (parm->ctx, parm->sexp, parm->sexplen);
535     }
536   else
537     {
538       struct default_inq_parm_s inq_parm = { parm->ctrl, parm->ctx };
539       rc = default_inq_cb (&inq_parm, line);
540     }
541
542   return rc;
543 }
544
545
546 \f
547 /* Call the agent to generate a newkey */
548 int
549 gpgsm_agent_genkey (ctrl_t ctrl,
550                     ksba_const_sexp_t keyparms, ksba_sexp_t *r_pubkey)
551 {
552   int rc;
553   struct genkey_parm_s gk_parm;
554   membuf_t data;
555   size_t len;
556   unsigned char *buf;
557
558   *r_pubkey = NULL;
559   rc = start_agent (ctrl);
560   if (rc)
561     return rc;
562
563   rc = assuan_transact (agent_ctx, "RESET", NULL, NULL, NULL, NULL, NULL, NULL);
564   if (rc)
565     return rc;
566
567   init_membuf (&data, 1024);
568   gk_parm.ctrl = ctrl;
569   gk_parm.ctx = agent_ctx;
570   gk_parm.sexp = keyparms;
571   gk_parm.sexplen = gcry_sexp_canon_len (keyparms, 0, NULL, NULL);
572   if (!gk_parm.sexplen)
573     return gpg_error (GPG_ERR_INV_VALUE);
574   rc = assuan_transact (agent_ctx, "GENKEY",
575                         put_membuf_cb, &data,
576                         inq_genkey_parms, &gk_parm, NULL, NULL);
577   if (rc)
578     {
579       xfree (get_membuf (&data, &len));
580       return rc;
581     }
582   buf = get_membuf (&data, &len);
583   if (!buf)
584     return gpg_error (GPG_ERR_ENOMEM);
585   if (!gcry_sexp_canon_len (buf, len, NULL, NULL))
586     {
587       xfree (buf);
588       return gpg_error (GPG_ERR_INV_SEXP);
589     }
590   *r_pubkey = buf;
591   return 0;
592 }
593
594 \f
595 /* Call the agent to read the public key part for a given keygrip.  If
596    FROMCARD is true, the key is directly read from the current
597    smartcard. In this case HEXKEYGRIP should be the keyID
598    (e.g. OPENPGP.3). */
599 int
600 gpgsm_agent_readkey (ctrl_t ctrl, int fromcard, const char *hexkeygrip,
601                      ksba_sexp_t *r_pubkey)
602 {
603   int rc;
604   membuf_t data;
605   size_t len;
606   unsigned char *buf;
607   char line[ASSUAN_LINELENGTH];
608   struct default_inq_parm_s inq_parm;
609
610   *r_pubkey = NULL;
611   rc = start_agent (ctrl);
612   if (rc)
613     return rc;
614   inq_parm.ctrl = ctrl;
615   inq_parm.ctx = agent_ctx;
616
617   rc = assuan_transact (agent_ctx, "RESET",NULL, NULL, NULL, NULL, NULL, NULL);
618   if (rc)
619     return rc;
620
621   snprintf (line, DIM(line), "%sREADKEY %s",
622             fromcard? "SCD ":"", hexkeygrip);
623
624   init_membuf (&data, 1024);
625   rc = assuan_transact (agent_ctx, line,
626                         put_membuf_cb, &data,
627                         default_inq_cb, &inq_parm, NULL, NULL);
628   if (rc)
629     {
630       xfree (get_membuf (&data, &len));
631       return rc;
632     }
633   buf = get_membuf (&data, &len);
634   if (!buf)
635     return gpg_error (GPG_ERR_ENOMEM);
636   if (!gcry_sexp_canon_len (buf, len, NULL, NULL))
637     {
638       xfree (buf);
639       return gpg_error (GPG_ERR_INV_SEXP);
640     }
641   *r_pubkey = buf;
642   return 0;
643 }
644
645
646 \f
647 /* Take the serial number from LINE and return it verbatim in a newly
648    allocated string.  We make sure that only hex characters are
649    returned. */
650 static char *
651 store_serialno (const char *line)
652 {
653   const char *s;
654   char *p;
655
656   for (s=line; hexdigitp (s); s++)
657     ;
658   p = xtrymalloc (s + 1 - line);
659   if (p)
660     {
661       memcpy (p, line, s-line);
662       p[s-line] = 0;
663     }
664   return p;
665 }
666
667
668 /* Callback for the gpgsm_agent_serialno function.  */
669 static gpg_error_t
670 scd_serialno_status_cb (void *opaque, const char *line)
671 {
672   char **r_serialno = opaque;
673   const char *keyword = line;
674   int keywordlen;
675
676   for (keywordlen=0; *line && !spacep (line); line++, keywordlen++)
677     ;
678   while (spacep (line))
679     line++;
680
681   if (keywordlen == 8 && !memcmp (keyword, "SERIALNO", keywordlen))
682     {
683       xfree (*r_serialno);
684       *r_serialno = store_serialno (line);
685     }
686
687   return 0;
688 }
689
690
691 /* Call the agent to read the serial number of the current card.  */
692 int
693 gpgsm_agent_scd_serialno (ctrl_t ctrl, char **r_serialno)
694 {
695   int rc;
696   char *serialno = NULL;
697   struct default_inq_parm_s inq_parm;
698
699   *r_serialno = NULL;
700   rc = start_agent (ctrl);
701   if (rc)
702     return rc;
703   inq_parm.ctrl = ctrl;
704   inq_parm.ctx = agent_ctx;
705
706   rc = assuan_transact (agent_ctx, "SCD SERIALNO",
707                         NULL, NULL,
708                         default_inq_cb, &inq_parm,
709                         scd_serialno_status_cb, &serialno);
710   if (!rc && !serialno)
711     rc = gpg_error (GPG_ERR_INTERNAL);
712   if (rc)
713     {
714       xfree (serialno);
715       return rc;
716     }
717   *r_serialno = serialno;
718   return 0;
719 }
720
721
722 \f
723 /* Callback for the gpgsm_agent_serialno function.  */
724 static gpg_error_t
725 scd_keypairinfo_status_cb (void *opaque, const char *line)
726 {
727   strlist_t *listaddr = opaque;
728   const char *keyword = line;
729   int keywordlen;
730   strlist_t sl;
731   char *p;
732
733   for (keywordlen=0; *line && !spacep (line); line++, keywordlen++)
734     ;
735   while (spacep (line))
736     line++;
737
738   if (keywordlen == 11 && !memcmp (keyword, "KEYPAIRINFO", keywordlen))
739     {
740       sl = append_to_strlist (listaddr, line);
741       p = sl->d;
742       /* Make sure that we only have two tokes so that future
743          extensions of the format won't change the format expected by
744          the caller.  */
745       while (*p && !spacep (p))
746         p++;
747       if (*p)
748         {
749           while (spacep (p))
750             p++;
751           while (*p && !spacep (p))
752             p++;
753           *p = 0;
754         }
755     }
756
757   return 0;
758 }
759
760
761 /* Call the agent to read the keypairinfo lines of the current card.
762    The list is returned as a string made up of the keygrip, a space
763    and the keyid.  */
764 int
765 gpgsm_agent_scd_keypairinfo (ctrl_t ctrl, strlist_t *r_list)
766 {
767   int rc;
768   strlist_t list = NULL;
769   struct default_inq_parm_s inq_parm;
770
771   *r_list = NULL;
772   rc = start_agent (ctrl);
773   if (rc)
774     return rc;
775   inq_parm.ctrl = ctrl;
776   inq_parm.ctx = agent_ctx;
777
778   rc = assuan_transact (agent_ctx, "SCD LEARN --force",
779                         NULL, NULL,
780                         default_inq_cb, &inq_parm,
781                         scd_keypairinfo_status_cb, &list);
782   if (!rc && !list)
783     rc = gpg_error (GPG_ERR_NO_DATA);
784   if (rc)
785     {
786       free_strlist (list);
787       return rc;
788     }
789   *r_list = list;
790   return 0;
791 }
792
793
794 \f
795 static gpg_error_t
796 istrusted_status_cb (void *opaque, const char *line)
797 {
798   struct rootca_flags_s *flags = opaque;
799   const char *s;
800
801   if ((s = has_leading_keyword (line, "TRUSTLISTFLAG")))
802     {
803       line = s;
804       if (has_leading_keyword (line, "relax"))
805         flags->relax = 1;
806       else if (has_leading_keyword (line, "cm"))
807         flags->chain_model = 1;
808     }
809   return 0;
810 }
811
812
813
814 /* Ask the agent whether the certificate is in the list of trusted
815    keys.  The certificate is either specified by the CERT object or by
816    the fingerprint HEXFPR.  ROOTCA_FLAGS is guaranteed to be cleared
817    on error. */
818 int
819 gpgsm_agent_istrusted (ctrl_t ctrl, ksba_cert_t cert, const char *hexfpr,
820                        struct rootca_flags_s *rootca_flags)
821 {
822   int rc;
823   char line[ASSUAN_LINELENGTH];
824
825   memset (rootca_flags, 0, sizeof *rootca_flags);
826
827   if (cert && hexfpr)
828     return gpg_error (GPG_ERR_INV_ARG);
829
830   rc = start_agent (ctrl);
831   if (rc)
832     return rc;
833
834   if (hexfpr)
835     {
836       snprintf (line, DIM(line), "ISTRUSTED %s", hexfpr);
837     }
838   else
839     {
840       char *fpr;
841
842       fpr = gpgsm_get_fingerprint_hexstring (cert, GCRY_MD_SHA1);
843       if (!fpr)
844         {
845           log_error ("error getting the fingerprint\n");
846           return gpg_error (GPG_ERR_GENERAL);
847         }
848
849       snprintf (line, DIM(line), "ISTRUSTED %s", fpr);
850       xfree (fpr);
851     }
852
853   rc = assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL,
854                         istrusted_status_cb, rootca_flags);
855   if (!rc)
856     rootca_flags->valid = 1;
857   return rc;
858 }
859
860 /* Ask the agent to mark CERT as a trusted Root-CA one */
861 int
862 gpgsm_agent_marktrusted (ctrl_t ctrl, ksba_cert_t cert)
863 {
864   int rc;
865   char *fpr, *dn, *dnfmt;
866   char line[ASSUAN_LINELENGTH];
867   struct default_inq_parm_s inq_parm;
868
869   rc = start_agent (ctrl);
870   if (rc)
871     return rc;
872   inq_parm.ctrl = ctrl;
873   inq_parm.ctx = agent_ctx;
874
875   fpr = gpgsm_get_fingerprint_hexstring (cert, GCRY_MD_SHA1);
876   if (!fpr)
877     {
878       log_error ("error getting the fingerprint\n");
879       return gpg_error (GPG_ERR_GENERAL);
880     }
881
882   dn = ksba_cert_get_issuer (cert, 0);
883   if (!dn)
884     {
885       xfree (fpr);
886       return gpg_error (GPG_ERR_GENERAL);
887     }
888   dnfmt = gpgsm_format_name2 (dn, 0);
889   xfree (dn);
890   if (!dnfmt)
891     return gpg_error_from_syserror ();
892   snprintf (line, DIM(line), "MARKTRUSTED %s S %s", fpr, dnfmt);
893   ksba_free (dnfmt);
894   xfree (fpr);
895
896   rc = assuan_transact (agent_ctx, line, NULL, NULL,
897                         default_inq_cb, &inq_parm, NULL, NULL);
898   return rc;
899 }
900
901
902 \f
903 /* Ask the agent whether the a corresponding secret key is available
904    for the given keygrip */
905 int
906 gpgsm_agent_havekey (ctrl_t ctrl, const char *hexkeygrip)
907 {
908   int rc;
909   char line[ASSUAN_LINELENGTH];
910
911   rc = start_agent (ctrl);
912   if (rc)
913     return rc;
914
915   if (!hexkeygrip || strlen (hexkeygrip) != 40)
916     return gpg_error (GPG_ERR_INV_VALUE);
917
918   snprintf (line, DIM(line), "HAVEKEY %s", hexkeygrip);
919
920   rc = assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
921   return rc;
922 }
923
924 \f
925 static gpg_error_t
926 learn_status_cb (void *opaque, const char *line)
927 {
928   struct learn_parm_s *parm = opaque;
929   const char *s;
930
931   /* Pass progress data to the caller.  */
932   if ((s = has_leading_keyword (line, "PROGRESS")))
933     {
934       line = s;
935       if (parm->ctrl)
936         {
937           if (gpgsm_status (parm->ctrl, STATUS_PROGRESS, line))
938             return gpg_error (GPG_ERR_ASS_CANCELED);
939         }
940     }
941   return 0;
942 }
943
944 static gpg_error_t
945 learn_cb (void *opaque, const void *buffer, size_t length)
946 {
947   struct learn_parm_s *parm = opaque;
948   size_t len;
949   char *buf;
950   ksba_cert_t cert;
951   int rc;
952
953   if (parm->error)
954     return 0;
955
956   if (buffer)
957     {
958       put_membuf (parm->data, buffer, length);
959       return 0;
960     }
961   /* END encountered - process what we have */
962   buf = get_membuf (parm->data, &len);
963   if (!buf)
964     {
965       parm->error = gpg_error (GPG_ERR_ENOMEM);
966       return 0;
967     }
968
969   if (gpgsm_status (parm->ctrl, STATUS_PROGRESS, "learncard C 0 0"))
970     return gpg_error (GPG_ERR_ASS_CANCELED);
971
972   /* FIXME: this should go into import.c */
973   rc = ksba_cert_new (&cert);
974   if (rc)
975     {
976       parm->error = rc;
977       return 0;
978     }
979   rc = ksba_cert_init_from_mem (cert, buf, len);
980   if (rc)
981     {
982       log_error ("failed to parse a certificate: %s\n", gpg_strerror (rc));
983       ksba_cert_release (cert);
984       parm->error = rc;
985       return 0;
986     }
987
988   /* We do not store a certifciate with missing issuers as ephemeral
989      because we can assume that the --learn-card command has been used
990      on purpose.  */
991   rc = gpgsm_basic_cert_check (parm->ctrl, cert);
992   if (rc && gpg_err_code (rc) != GPG_ERR_MISSING_CERT
993       && gpg_err_code (rc) != GPG_ERR_MISSING_ISSUER_CERT)
994     log_error ("invalid certificate: %s\n", gpg_strerror (rc));
995   else
996     {
997       int existed;
998
999       if (!keydb_store_cert (parm->ctrl, cert, 0, &existed))
1000         {
1001           if (opt.verbose > 1 && existed)
1002             log_info ("certificate already in DB\n");
1003           else if (opt.verbose && !existed)
1004             log_info ("certificate imported\n");
1005         }
1006     }
1007
1008   ksba_cert_release (cert);
1009   init_membuf (parm->data, 4096);
1010   return 0;
1011 }
1012
1013 /* Call the agent to learn about a smartcard */
1014 int
1015 gpgsm_agent_learn (ctrl_t ctrl)
1016 {
1017   int rc;
1018   struct learn_parm_s learn_parm;
1019   membuf_t data;
1020   size_t len;
1021
1022   rc = start_agent (ctrl);
1023   if (rc)
1024     return rc;
1025
1026   rc = warn_version_mismatch (ctrl, agent_ctx, SCDAEMON_NAME, 2);
1027   if (rc)
1028     return rc;
1029
1030   init_membuf (&data, 4096);
1031   learn_parm.error = 0;
1032   learn_parm.ctrl = ctrl;
1033   learn_parm.ctx = agent_ctx;
1034   learn_parm.data = &data;
1035   rc = assuan_transact (agent_ctx, "LEARN --send",
1036                         learn_cb, &learn_parm,
1037                         NULL, NULL,
1038                         learn_status_cb, &learn_parm);
1039   xfree (get_membuf (&data, &len));
1040   if (rc)
1041     return rc;
1042   return learn_parm.error;
1043 }
1044
1045 \f
1046 /* Ask the agent to change the passphrase of the key identified by
1047    HEXKEYGRIP. If DESC is not NULL, display instead of the default
1048    description message. */
1049 int
1050 gpgsm_agent_passwd (ctrl_t ctrl, const char *hexkeygrip, const char *desc)
1051 {
1052   int rc;
1053   char line[ASSUAN_LINELENGTH];
1054   struct default_inq_parm_s inq_parm;
1055
1056   rc = start_agent (ctrl);
1057   if (rc)
1058     return rc;
1059   inq_parm.ctrl = ctrl;
1060   inq_parm.ctx = agent_ctx;
1061
1062   if (!hexkeygrip || strlen (hexkeygrip) != 40)
1063     return gpg_error (GPG_ERR_INV_VALUE);
1064
1065   if (desc)
1066     {
1067       snprintf (line, DIM(line), "SETKEYDESC %s", desc);
1068       rc = assuan_transact (agent_ctx, line,
1069                             NULL, NULL, NULL, NULL, NULL, NULL);
1070       if (rc)
1071         return rc;
1072     }
1073
1074   snprintf (line, DIM(line), "PASSWD %s", hexkeygrip);
1075
1076   rc = assuan_transact (agent_ctx, line, NULL, NULL,
1077                         default_inq_cb, &inq_parm, NULL, NULL);
1078   return rc;
1079 }
1080
1081
1082 \f
1083 /* Ask the agent to pop up a confirmation dialog with the text DESC
1084    and an okay and cancel button.  */
1085 gpg_error_t
1086 gpgsm_agent_get_confirmation (ctrl_t ctrl, const char *desc)
1087 {
1088   int rc;
1089   char line[ASSUAN_LINELENGTH];
1090   struct default_inq_parm_s inq_parm;
1091
1092   rc = start_agent (ctrl);
1093   if (rc)
1094     return rc;
1095   inq_parm.ctrl = ctrl;
1096   inq_parm.ctx = agent_ctx;
1097
1098   snprintf (line, DIM(line), "GET_CONFIRMATION %s", desc);
1099
1100   rc = assuan_transact (agent_ctx, line, NULL, NULL,
1101                         default_inq_cb, &inq_parm, NULL, NULL);
1102   return rc;
1103 }
1104
1105
1106 \f
1107 /* Return 0 if the agent is alive.  This is useful to make sure that
1108    an agent has been started. */
1109 gpg_error_t
1110 gpgsm_agent_send_nop (ctrl_t ctrl)
1111 {
1112   int rc;
1113
1114   rc = start_agent (ctrl);
1115   if (!rc)
1116     rc = assuan_transact (agent_ctx, "NOP",
1117                           NULL, NULL, NULL, NULL, NULL, NULL);
1118   return rc;
1119 }
1120
1121
1122 \f
1123 static gpg_error_t
1124 keyinfo_status_cb (void *opaque, const char *line)
1125 {
1126   char **serialno = opaque;
1127   const char *s, *s2;
1128
1129   if ((s = has_leading_keyword (line, "KEYINFO")) && !*serialno)
1130     {
1131       s = strchr (s, ' ');
1132       if (s && s[1] == 'T' && s[2] == ' ' && s[3])
1133         {
1134           s += 3;
1135           s2 = strchr (s, ' ');
1136           if ( s2 > s )
1137             {
1138               *serialno = xtrymalloc ((s2 - s)+1);
1139               if (*serialno)
1140                 {
1141                   memcpy (*serialno, s, s2 - s);
1142                   (*serialno)[s2 - s] = 0;
1143                 }
1144             }
1145         }
1146     }
1147   return 0;
1148 }
1149
1150 /* Return the serial number for a secret key.  If the returned serial
1151    number is NULL, the key is not stored on a smartcard.  Caller needs
1152    to free R_SERIALNO.  */
1153 gpg_error_t
1154 gpgsm_agent_keyinfo (ctrl_t ctrl, const char *hexkeygrip, char **r_serialno)
1155 {
1156   gpg_error_t err;
1157   char line[ASSUAN_LINELENGTH];
1158   char *serialno = NULL;
1159
1160   *r_serialno = NULL;
1161
1162   err = start_agent (ctrl);
1163   if (err)
1164     return err;
1165
1166   if (!hexkeygrip || strlen (hexkeygrip) != 40)
1167     return gpg_error (GPG_ERR_INV_VALUE);
1168
1169   snprintf (line, DIM(line), "KEYINFO %s", hexkeygrip);
1170
1171   err = assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL,
1172                          keyinfo_status_cb, &serialno);
1173   if (!err && serialno)
1174     {
1175       /* Sanity check for bad characters.  */
1176       if (strpbrk (serialno, ":\n\r"))
1177         err = GPG_ERR_INV_VALUE;
1178     }
1179   if (err)
1180     xfree (serialno);
1181   else
1182     *r_serialno = serialno;
1183   return err;
1184 }
1185
1186
1187 \f
1188 /* Ask for the passphrase (this is used for pkcs#12 import/export.  On
1189    success the caller needs to free the string stored at R_PASSPHRASE.
1190    On error NULL will be stored at R_PASSPHRASE and an appropriate
1191    error code returned.  If REPEAT is true the agent tries to get a
1192    new passphrase (i.e. asks the user to confirm it).  */
1193 gpg_error_t
1194 gpgsm_agent_ask_passphrase (ctrl_t ctrl, const char *desc_msg, int repeat,
1195                             char **r_passphrase)
1196 {
1197   gpg_error_t err;
1198   char line[ASSUAN_LINELENGTH];
1199   char *arg4 = NULL;
1200   membuf_t data;
1201   struct default_inq_parm_s inq_parm;
1202
1203   *r_passphrase = NULL;
1204
1205   err = start_agent (ctrl);
1206   if (err)
1207     return err;
1208   inq_parm.ctrl = ctrl;
1209   inq_parm.ctx = agent_ctx;
1210
1211   if (desc_msg && *desc_msg && !(arg4 = percent_plus_escape (desc_msg)))
1212     return gpg_error_from_syserror ();
1213
1214   snprintf (line, DIM(line), "GET_PASSPHRASE --data%s -- X X X %s",
1215             repeat? " --repeat=1 --check --qualitybar":"",
1216             arg4);
1217   xfree (arg4);
1218
1219   init_membuf_secure (&data, 64);
1220   err = assuan_transact (agent_ctx, line,
1221                          put_membuf_cb, &data,
1222                          default_inq_cb, &inq_parm, NULL, NULL);
1223
1224   if (err)
1225     xfree (get_membuf (&data, NULL));
1226   else
1227     {
1228       put_membuf (&data, "", 1);
1229       *r_passphrase = get_membuf (&data, NULL);
1230       if (!*r_passphrase)
1231         err = gpg_error_from_syserror ();
1232     }
1233   return err;
1234 }
1235
1236
1237 \f
1238 /* Retrieve a key encryption key from the agent.  With FOREXPORT true
1239    the key shall be use for export, with false for import.  On success
1240    the new key is stored at R_KEY and its length at R_KEKLEN.  */
1241 gpg_error_t
1242 gpgsm_agent_keywrap_key (ctrl_t ctrl, int forexport,
1243                          void **r_kek, size_t *r_keklen)
1244 {
1245   gpg_error_t err;
1246   membuf_t data;
1247   size_t len;
1248   unsigned char *buf;
1249   char line[ASSUAN_LINELENGTH];
1250   struct default_inq_parm_s inq_parm;
1251
1252   *r_kek = NULL;
1253   err = start_agent (ctrl);
1254   if (err)
1255     return err;
1256   inq_parm.ctrl = ctrl;
1257   inq_parm.ctx = agent_ctx;
1258
1259   snprintf (line, DIM(line), "KEYWRAP_KEY %s",
1260             forexport? "--export":"--import");
1261
1262   init_membuf_secure (&data, 64);
1263   err = assuan_transact (agent_ctx, line,
1264                          put_membuf_cb, &data,
1265                          default_inq_cb, &inq_parm, NULL, NULL);
1266   if (err)
1267     {
1268       xfree (get_membuf (&data, &len));
1269       return err;
1270     }
1271   buf = get_membuf (&data, &len);
1272   if (!buf)
1273     return gpg_error_from_syserror ();
1274   *r_kek = buf;
1275   *r_keklen = len;
1276   return 0;
1277 }
1278
1279
1280
1281 \f
1282 /* Handle the inquiry for an IMPORT_KEY command.  */
1283 static gpg_error_t
1284 inq_import_key_parms (void *opaque, const char *line)
1285 {
1286   struct import_key_parm_s *parm = opaque;
1287   gpg_error_t err;
1288
1289   if (has_leading_keyword (line, "KEYDATA"))
1290     {
1291       assuan_begin_confidential (parm->ctx);
1292       err = assuan_send_data (parm->ctx, parm->key, parm->keylen);
1293       assuan_end_confidential (parm->ctx);
1294     }
1295   else
1296     {
1297       struct default_inq_parm_s inq_parm = { parm->ctrl, parm->ctx };
1298       err = default_inq_cb (&inq_parm, line);
1299     }
1300
1301   return err;
1302 }
1303
1304
1305 /* Call the agent to import a key into the agent.  */
1306 gpg_error_t
1307 gpgsm_agent_import_key (ctrl_t ctrl, const void *key, size_t keylen)
1308 {
1309   gpg_error_t err;
1310   struct import_key_parm_s parm;
1311
1312   err = start_agent (ctrl);
1313   if (err)
1314     return err;
1315
1316   parm.ctrl   = ctrl;
1317   parm.ctx    = agent_ctx;
1318   parm.key    = key;
1319   parm.keylen = keylen;
1320
1321   err = assuan_transact (agent_ctx, "IMPORT_KEY",
1322                          NULL, NULL, inq_import_key_parms, &parm, NULL, NULL);
1323   return err;
1324 }
1325
1326
1327 \f
1328 /* Receive a secret key from the agent.  KEYGRIP is the hexified
1329    keygrip, DESC a prompt to be displayed with the agent's passphrase
1330    question (needs to be plus+percent escaped).  On success the key is
1331    stored as a canonical S-expression at R_RESULT and R_RESULTLEN. */
1332 gpg_error_t
1333 gpgsm_agent_export_key (ctrl_t ctrl, const char *keygrip, const char *desc,
1334                         unsigned char **r_result, size_t *r_resultlen)
1335 {
1336   gpg_error_t err;
1337   membuf_t data;
1338   size_t len;
1339   unsigned char *buf;
1340   char line[ASSUAN_LINELENGTH];
1341   struct default_inq_parm_s inq_parm;
1342
1343   *r_result = NULL;
1344
1345   err = start_agent (ctrl);
1346   if (err)
1347     return err;
1348   inq_parm.ctrl = ctrl;
1349   inq_parm.ctx = agent_ctx;
1350
1351   if (desc)
1352     {
1353       snprintf (line, DIM(line), "SETKEYDESC %s", desc);
1354       err = assuan_transact (agent_ctx, line,
1355                              NULL, NULL, NULL, NULL, NULL, NULL);
1356       if (err)
1357         return err;
1358     }
1359
1360   snprintf (line, DIM(line), "EXPORT_KEY %s", keygrip);
1361
1362   init_membuf_secure (&data, 1024);
1363   err = assuan_transact (agent_ctx, line,
1364                          put_membuf_cb, &data,
1365                          default_inq_cb, &inq_parm, NULL, NULL);
1366   if (err)
1367     {
1368       xfree (get_membuf (&data, &len));
1369       return err;
1370     }
1371   buf = get_membuf (&data, &len);
1372   if (!buf)
1373     return gpg_error_from_syserror ();
1374   *r_result = buf;
1375   *r_resultlen = len;
1376   return 0;
1377 }