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