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