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