30b46fa9966d1f69188ef9c2c05ccaf2b8ab0451
[gnupg.git] / g10 / call-agent.c
1 /* call-agent.c - divert operations to the agent
2  * Copyright (C) 2001, 2002, 2003, 2006 Free Software Foundation, Inc.
3  *
4  * This file is part of GnuPG.
5  *
6  * GnuPG is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * GnuPG is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
19  * USA.
20  */
21
22 #if 0  /* let Emacs display a red warning */
23 #error fixme: this shares a lot of code with the file in ../sm
24 #endif
25
26 #include <config.h>
27 #include <stdio.h>
28 #include <stdlib.h>
29 #include <string.h>
30 #include <errno.h>
31 #include <unistd.h> 
32 #include <time.h>
33 #include <assert.h>
34 #ifdef HAVE_LOCALE_H
35 #include <locale.h>
36 #endif
37 #include <assuan.h>
38
39 #include "gpg.h"
40 #include "util.h"
41 #include "membuf.h"
42 #include "options.h"
43 #include "i18n.h"
44 #include "asshelp.h"
45 #include "call-agent.h"
46
47 #ifndef DBG_ASSUAN
48 # define DBG_ASSUAN 1
49 #endif
50
51 static assuan_context_t agent_ctx = NULL;
52 static int force_pipe_server; 
53
54 struct cipher_parm_s 
55 {
56   assuan_context_t ctx;
57   const char *ciphertext;
58   size_t ciphertextlen;
59 };
60
61 struct writekey_parm_s
62 {
63   assuan_context_t ctx;
64   const unsigned char *keydata;
65   size_t keydatalen;
66 };
67
68 struct genkey_parm_s 
69 {
70   assuan_context_t ctx;
71   const char *sexp;
72   size_t sexplen;
73 };
74
75
76 \f
77 /* Try to connect to the agent via socket or fork it off and work by
78    pipes.  Handle the server's initial greeting */
79 static int
80 start_agent (void)
81 {
82   int rc = 0;
83   char *infostr, *p;
84   assuan_context_t ctx;
85
86   if (agent_ctx)
87     return 0; /* fixme: We need a context for each thread or serialize
88                  the access to the agent. */
89
90   infostr = force_pipe_server? NULL : getenv ("GPG_AGENT_INFO");
91   if (!infostr || !*infostr)
92     {
93       const char *pgmname;
94       const char *argv[3];
95       int no_close_list[3];
96       int i;
97
98       if (opt.verbose)
99         log_info (_("no running gpg-agent - starting one\n"));
100
101       if (fflush (NULL))
102         {
103           gpg_error_t tmperr = gpg_error_from_syserror ();
104           log_error ("error flushing pending output: %s\n", strerror (errno));
105           return tmperr;
106         }
107
108       if (!opt.agent_program || !*opt.agent_program)
109         opt.agent_program = GNUPG_DEFAULT_AGENT;
110       if ( !(pgmname = strrchr (opt.agent_program, '/')))
111         pgmname = opt.agent_program;
112       else
113         pgmname++;
114
115       argv[0] = pgmname;
116       argv[1] = "--server";
117       argv[2] = NULL;
118
119       i=0;
120       if (log_get_fd () != -1)
121         no_close_list[i++] = log_get_fd ();
122       no_close_list[i++] = fileno (stderr);
123       no_close_list[i] = -1;
124
125       /* connect to the agent and perform initial handshaking */
126       rc = assuan_pipe_connect (&ctx, opt.agent_program, argv,
127                                 no_close_list);
128     }
129   else
130     {
131       int prot;
132       int pid;
133
134       infostr = xstrdup (infostr);
135       if ( !(p = strchr (infostr, ':')) || p == infostr)
136         {
137           log_error (_("malformed GPG_AGENT_INFO environment variable\n"));
138           xfree (infostr);
139           force_pipe_server = 1;
140           return start_agent ();
141         }
142       *p++ = 0;
143       pid = atoi (p);
144       while (*p && *p != ':')
145         p++;
146       prot = *p? atoi (p+1) : 0;
147       if (prot != 1)
148         {
149           log_error (_("gpg-agent protocol version %d is not supported\n"),
150                      prot);
151           xfree (infostr);
152           force_pipe_server = 1;
153           return start_agent ();
154         }
155
156       rc = assuan_socket_connect (&ctx, infostr, pid);
157       xfree (infostr);
158       if (gpg_err_code (rc) == GPG_ERR_ASS_CONNECT_FAILED)
159         {
160           log_error (_("can't connect to the agent - trying fall back\n"));
161           force_pipe_server = 1;
162           return start_agent ();
163         }
164     }
165
166   if (rc)
167     {
168       log_error ("can't connect to the agent: %s\n", gpg_strerror (rc));
169       return gpg_error (GPG_ERR_NO_AGENT);
170     }
171   agent_ctx = ctx;
172
173   if (DBG_ASSUAN)
174     log_debug ("connection to agent established\n");
175
176   rc = assuan_transact (agent_ctx, "RESET", NULL, NULL, NULL, NULL, NULL,NULL);
177   if (rc)
178     return rc;
179
180   return send_pinentry_environment (agent_ctx, GPG_ERR_SOURCE_DEFAULT,
181                                     opt.display, opt.ttyname, opt.ttytype,
182                                     opt.lc_ctype, opt.lc_messages);
183 }
184
185
186 /* Return a new malloced string by unescaping the string S.  Escaping
187    is percent escaping and '+'/space mapping.  A binary nul will
188    silently be replaced by a 0xFF.  Function returns NULL to indicate
189    an out of memory status. */
190 static char *
191 unescape_status_string (const unsigned char *s)
192 {
193   char *buffer, *d;
194
195   buffer = d = xtrymalloc (strlen (s)+1);
196   if (!buffer)
197     return NULL;
198   while (*s)
199     {
200       if (*s == '%' && s[1] && s[2])
201         { 
202           s++;
203           *d = xtoi_2 (s);
204           if (!*d)
205             *d = '\xff';
206           d++;
207           s += 2;
208         }
209       else if (*s == '+')
210         {
211           *d++ = ' ';
212           s++;
213         }
214       else
215         *d++ = *s++;
216     }
217   *d = 0; 
218   return buffer;
219 }
220
221 /* Copy the text ATEXT into the buffer P and do plus '+' and percent
222    escaping.  Note that the provided buffer needs to be 3 times the
223    size of ATEXT plus 1.  Returns a pointer to the leading Nul in P. */
224 static char *
225 percent_plus_escape (char *p, const char *atext)
226 {
227   const unsigned char *s;
228
229   for (s=atext; *s; s++)
230     {
231       if (*s < ' ' || *s == '+')
232         {
233           sprintf (p, "%%%02X", *s);
234           p += 3;
235         }
236       else if (*s == ' ')
237         *p++ = '+';
238       else
239         *p++ = *s;
240     }
241   *p = 0;
242   return p;
243 }
244
245 /* Take a 20 byte hexencoded string and put it into the the provided
246    20 byte buffer FPR in binary format. */
247 static int
248 unhexify_fpr (const char *hexstr, unsigned char *fpr)
249 {
250   const char *s;
251   int n;
252
253   for (s=hexstr, n=0; hexdigitp (s); s++, n++)
254     ;
255   if (*s || (n != 40))
256     return 0; /* no fingerprint (invalid or wrong length). */
257   n /= 2;
258   for (s=hexstr, n=0; *s; s += 2, n++)
259     fpr[n] = xtoi_2 (s);
260   return 1; /* okay */
261 }
262
263 /* Take the serial number from LINE and return it verbatim in a newly
264    allocated string.  We make sure that only hex characters are
265    returned. */
266 static char *
267 store_serialno (const char *line)
268 {
269   const char *s;
270   char *p;
271
272   for (s=line; hexdigitp (s); s++)
273     ;
274   p = xtrymalloc (s + 1 - line);
275   if (p)
276     {
277       memcpy (p, line, s-line);
278       p[s-line] = 0;
279     }
280   return p;
281 }
282
283
284 \f
285 /* Release the card info structure INFO. */
286 void
287 agent_release_card_info (struct agent_card_info_s *info)
288 {
289   if (!info)
290     return;
291
292   xfree (info->serialno); info->serialno = NULL;
293   xfree (info->disp_name); info->disp_name = NULL;
294   xfree (info->disp_lang); info->disp_lang = NULL;
295   xfree (info->pubkey_url); info->pubkey_url = NULL;
296   xfree (info->login_data); info->login_data = NULL;
297   info->cafpr1valid = info->cafpr2valid = info->cafpr3valid = 0;
298   info->fpr1valid = info->fpr2valid = info->fpr3valid = 0;
299 }
300
301 static int
302 learn_status_cb (void *opaque, const char *line)
303 {
304   struct agent_card_info_s *parm = opaque;
305   const char *keyword = line;
306   int keywordlen;
307   int i;
308
309   for (keywordlen=0; *line && !spacep (line); line++, keywordlen++)
310     ;
311   while (spacep (line))
312     line++;
313
314   if (keywordlen == 8 && !memcmp (keyword, "SERIALNO", keywordlen))
315     {
316       xfree (parm->serialno);
317       parm->serialno = store_serialno (line);
318     }
319   else if (keywordlen == 9 && !memcmp (keyword, "DISP-NAME", keywordlen))
320     {
321       xfree (parm->disp_name);
322       parm->disp_name = unescape_status_string (line);
323     }
324   else if (keywordlen == 9 && !memcmp (keyword, "DISP-LANG", keywordlen))
325     {
326       xfree (parm->disp_lang);
327       parm->disp_lang = unescape_status_string (line);
328     }
329   else if (keywordlen == 8 && !memcmp (keyword, "DISP-SEX", keywordlen))
330     {
331       parm->disp_sex = *line == '1'? 1 : *line == '2' ? 2: 0;
332     }
333   else if (keywordlen == 10 && !memcmp (keyword, "PUBKEY-URL", keywordlen))
334     {
335       xfree (parm->pubkey_url);
336       parm->pubkey_url = unescape_status_string (line);
337     }
338   else if (keywordlen == 10 && !memcmp (keyword, "LOGIN-DATA", keywordlen))
339     {
340       xfree (parm->login_data);
341       parm->login_data = unescape_status_string (line);
342     }
343   else if (keywordlen == 11 && !memcmp (keyword, "SIG-COUNTER", keywordlen))
344     {
345       parm->sig_counter = strtoul (line, NULL, 0);
346     }
347   else if (keywordlen == 10 && !memcmp (keyword, "CHV-STATUS", keywordlen))
348     {
349       char *p, *buf;
350
351       buf = p = unescape_status_string (line);
352       if (buf)
353         {
354           while (spacep (p))
355             p++;
356           parm->chv1_cached = atoi (p);
357           while (*p && !spacep (p))
358             p++;
359           while (spacep (p))
360             p++;
361           for (i=0; *p && i < 3; i++)
362             {
363               parm->chvmaxlen[i] = atoi (p);
364               while (*p && !spacep (p))
365                 p++;
366               while (spacep (p))
367                 p++;
368             }
369           for (i=0; *p && i < 3; i++)
370             {
371               parm->chvretry[i] = atoi (p);
372               while (*p && !spacep (p))
373                 p++;
374               while (spacep (p))
375                 p++;
376             }
377           xfree (buf);
378         }
379     }
380   else if (keywordlen == 7 && !memcmp (keyword, "KEY-FPR", keywordlen))
381     {
382       int no = atoi (line);
383       while (*line && !spacep (line))
384         line++;
385       while (spacep (line))
386         line++;
387       if (no == 1)
388         parm->fpr1valid = unhexify_fpr (line, parm->fpr1);
389       else if (no == 2)
390         parm->fpr2valid = unhexify_fpr (line, parm->fpr2);
391       else if (no == 3)
392         parm->fpr3valid = unhexify_fpr (line, parm->fpr3);
393     }
394   else if (keywordlen == 6 && !memcmp (keyword, "CA-FPR", keywordlen))
395     {
396       int no = atoi (line);
397       while (*line && !spacep (line))
398         line++;
399       while (spacep (line))
400         line++;
401       if (no == 1)
402         parm->cafpr1valid = unhexify_fpr (line, parm->cafpr1);
403       else if (no == 2)
404         parm->cafpr2valid = unhexify_fpr (line, parm->cafpr2);
405       else if (no == 3)
406         parm->cafpr3valid = unhexify_fpr (line, parm->cafpr3);
407     }
408   
409   return 0;
410 }
411
412 /* Call the agent to learn about a smartcard */
413 int
414 agent_learn (struct agent_card_info_s *info)
415 {
416   int rc;
417
418   rc = start_agent ();
419   if (rc)
420     return rc;
421
422   memset (info, 0, sizeof *info);
423   rc = assuan_transact (agent_ctx, "LEARN --send",
424                         NULL, NULL, NULL, NULL,
425                         learn_status_cb, info);
426   
427   return rc;
428 }
429
430 /* Call the agent to retrieve a data object.  This function returns
431    the data in the same structure as used by the learn command.  It is
432    allowed to update such a structure using this commmand. */
433 int
434 agent_scd_getattr (const char *name, struct agent_card_info_s *info)
435 {
436   int rc;
437   char line[ASSUAN_LINELENGTH];
438
439   if (!*name)
440     return gpg_error (GPG_ERR_INV_VALUE);
441
442   /* We assume that NAME does not need escaping. */
443   if (12 + strlen (name) > DIM(line)-1)
444     return gpg_error (GPG_ERR_TOO_LARGE);
445   stpcpy (stpcpy (line, "SCD GETATTR "), name); 
446
447   rc = start_agent ();
448   if (rc)
449     return rc;
450
451   rc = assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL,
452                         learn_status_cb, info);
453   
454   return rc;
455 }
456
457 \f
458 /* Send an setattr command to the SCdaemon.  SERIALNO is not actually
459    used here but required by gpg 1.4's implementation of this code in
460    cardglue.c. */
461 int
462 agent_scd_setattr (const char *name,
463                    const unsigned char *value, size_t valuelen,
464                    const char *serialno)
465 {
466   int rc;
467   char line[ASSUAN_LINELENGTH];
468   char *p;
469
470   if (!*name || !valuelen)
471     return gpg_error (GPG_ERR_INV_VALUE);
472
473   /* We assume that NAME does not need escaping. */
474   if (12 + strlen (name) > DIM(line)-1)
475     return gpg_error (GPG_ERR_TOO_LARGE);
476       
477   p = stpcpy (stpcpy (line, "SCD SETATTR "), name); 
478   *p++ = ' ';
479   for (; valuelen; value++, valuelen--)
480     {
481       if (p >= line + DIM(line)-5 )
482         return gpg_error (GPG_ERR_TOO_LARGE);
483       if (*value < ' ' || *value == '+' || *value == '%')
484         {
485           sprintf (p, "%%%02X", *value);
486           p += 3;
487         }
488       else if (*value == ' ')
489         *p++ = '+';
490       else
491         *p++ = *value;
492     }
493   *p = 0;
494
495   rc = start_agent ();
496   if (rc)
497     return rc;
498
499   rc = assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
500   return rc;
501 }
502
503
504 \f
505 /* Handle a KEYDATA inquiry.  Note, we only send the data,
506    assuan_transact takes care of flushing and writing the end */
507 static assuan_error_t
508 inq_writekey_parms (void *opaque, const char *keyword)
509 {
510   struct writekey_parm_s *parm = opaque; 
511
512   return assuan_send_data (parm->ctx, parm->keydata, parm->keydatalen);
513 }
514
515
516 /* Send a WRITEKEY command to the SCdaemon. */
517 int 
518 agent_scd_writekey (int keyno, const char *serialno,
519                     const unsigned char *keydata, size_t keydatalen)
520 {
521   int rc;
522   char line[ASSUAN_LINELENGTH];
523   struct writekey_parm_s parms;
524
525   rc = start_agent ();
526   if (rc)
527     return rc;
528
529   memset (&parms, 0, sizeof parms);
530
531   snprintf (line, DIM(line)-1, "SCD WRITEKEY --force OPENPGP.%d", keyno);
532   line[DIM(line)-1] = 0;
533   parms.ctx = agent_ctx;
534   parms.keydata = keydata;
535   parms.keydatalen = keydatalen;
536   
537   rc = assuan_transact (agent_ctx, line, NULL, NULL,
538                         inq_writekey_parms, &parms, NULL, NULL);
539
540   return rc;
541 }
542
543
544
545 \f
546 /* Status callback for the SCD GENKEY command. */
547 static int
548 scd_genkey_cb (void *opaque, const char *line)
549 {
550   struct agent_card_genkey_s *parm = opaque;
551   const char *keyword = line;
552   int keywordlen;
553   gpg_error_t rc;
554
555   log_debug ("got status line `%s'\n", line);
556   for (keywordlen=0; *line && !spacep (line); line++, keywordlen++)
557     ;
558   while (spacep (line))
559     line++;
560
561   if (keywordlen == 7 && !memcmp (keyword, "KEY-FPR", keywordlen))
562     {
563       parm->fprvalid = unhexify_fpr (line, parm->fpr);
564     }
565   if (keywordlen == 8 && !memcmp (keyword, "KEY-DATA", keywordlen))
566     {
567       gcry_mpi_t a;
568       const char *name = line;
569
570       while (*line && !spacep (line))
571         line++;
572       while (spacep (line))
573         line++;
574
575       rc = gcry_mpi_scan (&a, GCRYMPI_FMT_HEX, line, 0, NULL);
576       if (rc)
577         log_error ("error parsing received key data: %s\n", gpg_strerror (rc));
578       else if (*name == 'n' && spacep (name+1))
579         parm->n = a;
580       else if (*name == 'e' && spacep (name+1))
581         parm->e = a;
582       else
583         {
584           log_info ("unknown parameter name in received key data\n");
585           gcry_mpi_release (a);
586         }
587     }
588   else if (keywordlen == 14 && !memcmp (keyword,"KEY-CREATED-AT", keywordlen))
589     {
590       parm->created_at = (u32)strtoul (line, NULL, 10);
591     }
592
593   return 0;
594 }
595
596 /* Send a GENKEY command to the SCdaemon.  SERIALNO is not used in
597    this implementation. */
598 int
599 agent_scd_genkey (struct agent_card_genkey_s *info, int keyno, int force,
600                   const char *serialno)
601 {
602   int rc;
603   char line[ASSUAN_LINELENGTH];
604
605   rc = start_agent ();
606   if (rc)
607     return rc;
608
609   memset (info, 0, sizeof *info);
610   snprintf (line, DIM(line)-1, "SCD GENKEY %s%d",
611             force? "--force ":"", keyno);
612   line[DIM(line)-1] = 0;
613
614   memset (info, 0, sizeof *info);
615   rc = assuan_transact (agent_ctx, line,
616                         NULL, NULL, NULL, NULL,
617                         scd_genkey_cb, info);
618   
619   return rc;
620 }
621
622 \f
623 static int
624 membuf_data_cb (void *opaque, const void *buffer, size_t length)
625 {
626   membuf_t *data = opaque;
627
628   if (buffer)
629     put_membuf (data, buffer, length);
630   return 0;
631 }
632   
633 /* Send a sign command to the scdaemon via gpg-agent's pass thru
634    mechanism. */
635 int
636 agent_scd_pksign (const char *serialno, int hashalgo,
637                   const unsigned char *indata, size_t indatalen,
638                   unsigned char **r_buf, size_t *r_buflen)
639 {
640   int rc, i;
641   char *p, line[ASSUAN_LINELENGTH];
642   membuf_t data;
643   size_t len;
644
645   /* Note, hashalgo is not yet used but hardwired to SHA1 in SCdaemon. */
646
647   *r_buf = NULL;
648   *r_buflen = 0;
649
650   rc = start_agent ();
651   if (rc)
652     return rc;
653
654   if (indatalen*2 + 50 > DIM(line))
655     return gpg_error (GPG_ERR_GENERAL);
656
657   sprintf (line, "SCD SETDATA ");
658   p = line + strlen (line);
659   for (i=0; i < indatalen ; i++, p += 2 )
660     sprintf (p, "%02X", indata[i]);
661   rc = assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
662   if (rc)
663     return rc;
664
665   init_membuf (&data, 1024);
666 #if 0
667   if (!hashalgo) /* Temporary test hack. */
668     snprintf (line, DIM(line)-1, "SCD PKAUTH %s", serialno);
669   else
670 #endif
671    snprintf (line, DIM(line)-1, "SCD PKSIGN %s", serialno);
672   line[DIM(line)-1] = 0;
673   rc = assuan_transact (agent_ctx, line, membuf_data_cb, &data,
674                         NULL, NULL, NULL, NULL);
675   if (rc)
676     {
677       xfree (get_membuf (&data, &len));
678       return rc;
679     }
680   *r_buf = get_membuf (&data, r_buflen);
681
682   return 0;
683 }
684
685
686 /* Decrypt INDATA of length INDATALEN using the card identified by
687    SERIALNO.  Return the plaintext in a nwly allocated buffer stored
688    at the address of R_BUF. 
689
690    Note, we currently support only RSA or more exactly algorithms
691    taking one input data element. */
692 int
693 agent_scd_pkdecrypt (const char *serialno,
694                      const unsigned char *indata, size_t indatalen,
695                      unsigned char **r_buf, size_t *r_buflen)
696 {
697   int rc, i;
698   char *p, line[ASSUAN_LINELENGTH];
699   membuf_t data;
700   size_t len;
701
702   *r_buf = NULL;
703   rc = start_agent ();
704   if (rc)
705     return rc;
706
707   /* FIXME: use secure memory where appropriate */
708   if (indatalen*2 + 50 > DIM(line))
709     return gpg_error (GPG_ERR_GENERAL);
710
711   sprintf (line, "SCD SETDATA ");
712   p = line + strlen (line);
713   for (i=0; i < indatalen ; i++, p += 2 )
714     sprintf (p, "%02X", indata[i]);
715   rc = assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
716   if (rc)
717     return rc;
718
719   init_membuf (&data, 1024);
720   snprintf (line, DIM(line)-1, "SCD PKDECRYPT %s", serialno);
721   line[DIM(line)-1] = 0;
722   rc = assuan_transact (agent_ctx, line,
723                         membuf_data_cb, &data,
724                         NULL, NULL, NULL, NULL);
725   if (rc)
726     {
727       xfree (get_membuf (&data, &len));
728       return rc;
729     }
730   *r_buf = get_membuf (&data, r_buflen);
731   if (!*r_buf)
732     return gpg_error (GPG_ERR_ENOMEM);
733
734   return 0;
735 }
736
737
738 /* Change the PIN of an OpenPGP card or reset the retry counter.
739    CHVNO 1: Change the PIN
740          2: Same as 1
741          3: Change the admin PIN
742        101: Set a new PIN and reset the retry counter
743        102: Same as 101
744    SERIALNO is not used.
745  */
746 int
747 agent_scd_change_pin (int chvno, const char *serialno)
748 {
749   int rc;
750   char line[ASSUAN_LINELENGTH];
751   const char *reset = "";
752
753   if (chvno >= 100)
754     reset = "--reset";
755   chvno %= 100;
756
757   rc = start_agent ();
758   if (rc)
759     return rc;
760
761   snprintf (line, DIM(line)-1, "SCD PASSWD %s %d", reset, chvno);
762   line[DIM(line)-1] = 0;
763   rc = assuan_transact (agent_ctx, line, NULL, NULL,
764                         NULL, NULL, NULL, NULL);
765   return rc;
766 }
767
768
769 /* Perform a CHECKPIN operation.  SERIALNO should be the serial
770    number of the card - optionally followed by the fingerprint;
771    however the fingerprint is ignored here. */
772 int
773 agent_scd_checkpin  (const char *serialno)
774 {
775   int rc;
776   char line[ASSUAN_LINELENGTH];
777
778   rc = start_agent ();
779   if (rc)
780     return rc;
781
782   snprintf (line, DIM(line)-1, "SCD CHECKPIN %s", serialno);
783   line[DIM(line)-1] = 0;
784   return assuan_transact (agent_ctx, line,
785                           NULL, NULL,
786                           NULL, NULL, NULL, NULL);
787 }
788
789
790 /* Dummy function, only used by the gpg 1.4 implementation. */
791 void
792 agent_clear_pin_cache (const char *sn)
793 {
794
795 }
796
797
798
799 \f
800 /* Note: All strings shall be UTF-8. On success the caler needs to
801    free the string stored at R_PASSPHRASE. On error NULL will be
802    stored at R_PASSPHRASE and an appropriate fpf error code
803    returned. */
804 gpg_error_t
805 agent_get_passphrase (const char *cache_id,
806                       const char *err_msg,
807                       const char *prompt,
808                       const char *desc_msg,
809                       char **r_passphrase)
810 {
811   int rc;
812   char *line, *p;
813   char cmd[] = "GET_PASSPHRASE --data -- ";
814   membuf_t data;
815
816   *r_passphrase = NULL;
817
818   rc = start_agent ();
819   if (rc)
820     return rc;
821
822   /* We allocate 3 times the needed space for the texts so that
823      there is enough space for escaping. */
824   line = xtrymalloc ( strlen (cmd) + 1
825                       + (cache_id? 3*strlen (cache_id): 1) + 1
826                       + (err_msg?  3*strlen (err_msg): 1) + 1
827                       + (prompt?   3*strlen (prompt): 1) + 1
828                       + (desc_msg? 3*strlen (desc_msg): 1) + 1
829                       + 1);
830   if (!line)
831     return gpg_error_from_syserror ();
832
833   p = stpcpy (line, cmd);
834   if (cache_id && *cache_id)
835     p = percent_plus_escape (p, cache_id);
836   else
837     *p++ = 'X';
838   *p++ = ' ';
839
840   if (err_msg && *err_msg)
841     p = percent_plus_escape (p, err_msg);
842   else
843     *p++ = 'X';
844   *p++ = ' ';
845
846   if (prompt && *prompt)
847     p = percent_plus_escape (p, prompt);
848   else
849     *p++ = 'X'; 
850   *p++ = ' ';
851
852   if (desc_msg && *desc_msg)
853     p = percent_plus_escape (p, desc_msg);
854   else
855     *p++ = 'X';
856   *p = 0;
857
858   init_membuf_secure (&data, 64);
859   rc = assuan_transact (agent_ctx, line, 
860                         membuf_data_cb, &data, NULL, NULL, NULL, NULL);
861
862   if (rc)
863     xfree (get_membuf (&data, NULL));
864   else 
865     {
866       put_membuf (&data, "", 1);
867       *r_passphrase = get_membuf (&data, NULL);
868       if (!*r_passphrase)
869         rc = gpg_error_from_syserror ();
870     }
871   xfree (line);
872   return rc;
873 }
874
875
876 gpg_error_t
877 agent_clear_passphrase (const char *cache_id)
878 {
879   int rc;
880   char line[ASSUAN_LINELENGTH];
881
882   if (!cache_id || !*cache_id)
883     return 0;
884
885   rc = start_agent ();
886   if (rc)
887     return rc;
888
889   snprintf (line, DIM(line)-1, "CLEAR_PASSPHRASE %s", cache_id);
890   line[DIM(line)-1] = 0;
891   return assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
892 }