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