Add comment to last patch.
[gnupg.git] / agent / command.c
1 /* command.c - gpg-agent command handler
2  * Copyright (C) 2001, 2002, 2003, 2004, 2005,
3  *               2006, 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 /* FIXME: we should not use the default assuan buffering but setup
22    some buffering in secure mempory to protect session keys etc. */
23
24 #include <config.h>
25
26 #include <errno.h>
27 #include <stdio.h>
28 #include <stdlib.h>
29 #include <string.h>
30 #include <ctype.h>
31 #include <unistd.h>
32 #include <assert.h>
33 #include <sys/types.h>
34 #include <sys/stat.h>
35 #include <dirent.h>
36
37 #include "agent.h"
38 #include <assuan.h>
39 #include "i18n.h"
40 #include "cvt-openpgp.h"
41
42
43 /* Maximum allowed size of the inquired ciphertext.  */
44 #define MAXLEN_CIPHERTEXT 4096
45 /* Maximum allowed size of the key parameters.  */
46 #define MAXLEN_KEYPARAM 1024
47 /* Maximum allowed size of key data as used in inquiries (bytes). */
48 #define MAXLEN_KEYDATA 4096
49 /* The size of the import/export KEK key (in bytes).  */
50 #define KEYWRAP_KEYSIZE (128/8)
51
52 #define set_error(e,t) assuan_set_error (ctx, gpg_error (e), (t))
53
54
55 #if MAX_DIGEST_LEN < 20
56 #error MAX_DIGEST_LEN shorter than keygrip
57 #endif
58
59 /* Data used to associate an Assuan context with local server data */
60 struct server_local_s
61 {
62   assuan_context_t assuan_ctx;
63   int message_fd;
64   int use_cache_for_signing;
65   char *keydesc;  /* Allocated description for the next key
66                      operation. */
67   int pause_io_logging; /* Used to suppress I/O logging during a command */
68   int stopme;    /* If set to true the agent will be terminated after
69                     the end of this session.  */
70   int allow_pinentry_notify; /* Set if pinentry notifications should
71                                 be done. */
72   void *import_key;  /* Malloced KEK for the import_key command.  */
73   void *export_key;  /* Malloced KEK for the export_key command.  */
74   int allow_fully_canceled; /* Client is aware of GPG_ERR_FULLY_CANCELED.  */
75   char *last_cache_nonce;   /* Last CACHE_NOCNE sent as status (malloced).  */
76   char *last_passwd_nonce;  /* Last PASSWD_NOCNE sent as status (malloced). */
77 };
78
79
80 /* An entry for the getval/putval commands. */
81 struct putval_item_s
82 {
83   struct putval_item_s *next;
84   size_t off;  /* Offset to the value into DATA.  */
85   size_t len;  /* Length of the value.  */
86   char d[1];   /* Key | Nul | value.  */
87 };
88
89
90 /* A list of key value pairs fpr the getval/putval commands.  */
91 static struct putval_item_s *putval_list;
92
93
94 \f
95 /* To help polling clients, we keep track of the number of certain
96    events.  This structure keeps those counters.  The counters are
97    integers and there should be no problem if they are overflowing as
98    callers need to check only whether a counter changed.  The actual
99    values are not meaningful. */
100 struct
101 {
102   /* Incremented if any of the other counters below changed. */
103   unsigned int any;
104
105   /* Incremented if a key is added or removed from the internal privat
106      key database. */
107   unsigned int key;
108
109   /* Incremented if a change of the card readers stati has been
110      detected. */
111   unsigned int card;
112
113 } eventcounter;
114
115
116 \f
117 /*  Local prototypes.  */
118 static int command_has_option (const char *cmd, const char *cmdopt);
119
120
121
122 \f
123 /* Release the memory buffer MB but first wipe out the used memory. */
124 static void
125 clear_outbuf (membuf_t *mb)
126 {
127   void *p;
128   size_t n;
129
130   p = get_membuf (mb, &n);
131   if (p)
132     {
133       memset (p, 0, n);
134       xfree (p);
135     }
136 }
137
138
139 /* Write the content of memory buffer MB as assuan data to CTX and
140    wipe the buffer out afterwards. */
141 static gpg_error_t
142 write_and_clear_outbuf (assuan_context_t ctx, membuf_t *mb)
143 {
144   gpg_error_t ae;
145   void *p;
146   size_t n;
147
148   p = get_membuf (mb, &n);
149   if (!p)
150     return out_of_core ();
151   ae = assuan_send_data (ctx, p, n);
152   memset (p, 0, n);
153   xfree (p);
154   return ae;
155 }
156
157
158 static void
159 clear_nonce_cache (ctrl_t ctrl)
160 {
161   if (ctrl->server_local->last_cache_nonce)
162     {
163       agent_put_cache (ctrl->server_local->last_cache_nonce,
164                        CACHE_MODE_NONCE, NULL, 0);
165       xfree (ctrl->server_local->last_cache_nonce);
166       ctrl->server_local->last_cache_nonce = NULL;
167     }
168   if (ctrl->server_local->last_passwd_nonce)
169     {
170       agent_put_cache (ctrl->server_local->last_passwd_nonce,
171                        CACHE_MODE_NONCE, NULL, 0);
172       xfree (ctrl->server_local->last_passwd_nonce);
173       ctrl->server_local->last_passwd_nonce = NULL;
174     }
175 }
176
177
178 static gpg_error_t
179 reset_notify (assuan_context_t ctx, char *line)
180 {
181   ctrl_t ctrl = assuan_get_pointer (ctx);
182
183   (void) line;
184
185   memset (ctrl->keygrip, 0, 20);
186   ctrl->have_keygrip = 0;
187   ctrl->digest.valuelen = 0;
188
189   xfree (ctrl->server_local->keydesc);
190   ctrl->server_local->keydesc = NULL;
191
192   clear_nonce_cache (ctrl);
193
194   return 0;
195 }
196
197
198 /* Skip over options.
199    Blanks after the options are also removed. */
200 static char *
201 skip_options (const char *line)
202 {
203   while (spacep (line))
204     line++;
205   while ( *line == '-' && line[1] == '-' )
206     {
207       while (*line && !spacep (line))
208         line++;
209       while (spacep (line))
210         line++;
211     }
212   return (char*)line;
213 }
214
215 /* Check whether the option NAME appears in LINE */
216 static int
217 has_option (const char *line, const char *name)
218 {
219   const char *s;
220   int n = strlen (name);
221
222   s = strstr (line, name);
223   if (s && s >= skip_options (line))
224     return 0;
225   return (s && (s == line || spacep (s-1)) && (!s[n] || spacep (s+n)));
226 }
227
228 /* Same as has_option but does only test for the name of the option
229    and ignores an argument, i.e. with NAME being "--hash" it would
230    return true for "--hash" as well as for "--hash=foo". */
231 static int
232 has_option_name (const char *line, const char *name)
233 {
234   const char *s;
235   int n = strlen (name);
236
237   s = strstr (line, name);
238   if (s && s >= skip_options (line))
239     return 0;
240   return (s && (s == line || spacep (s-1))
241           && (!s[n] || spacep (s+n) || s[n] == '='));
242 }
243
244 /* Return a pointer to the argument of the option with NAME.  If such
245    an option is not given, it returns NULL. */
246 static char *
247 option_value (const char *line, const char *name)
248 {
249   char *s;
250   int n = strlen (name);
251
252   s = strstr (line, name);
253   if (s && s >= skip_options (line))
254     return NULL;
255   if (s && (s == line || spacep (s-1))
256       && s[n] && (spacep (s+n) || s[n] == '='))
257     {
258       s += n + 1;
259       s += strspn (s, " ");
260       if (*s && !spacep(s))
261         return s;
262     }
263   return NULL;
264 }
265
266
267 /* Replace all '+' by a blank. */
268 static void
269 plus_to_blank (char *s)
270 {
271   for (; *s; s++)
272     {
273       if (*s == '+')
274         *s = ' ';
275     }
276 }
277
278
279 /* Parse a hex string.  Return an Assuan error code or 0 on success and the
280    length of the parsed string in LEN. */
281 static int
282 parse_hexstring (assuan_context_t ctx, const char *string, size_t *len)
283 {
284   const char *p;
285   size_t n;
286
287   /* parse the hash value */
288   for (p=string, n=0; hexdigitp (p); p++, n++)
289     ;
290   if (*p != ' ' && *p != '\t' && *p)
291     return set_error (GPG_ERR_ASS_PARAMETER, "invalid hexstring");
292   if ((n&1))
293     return set_error (GPG_ERR_ASS_PARAMETER, "odd number of digits");
294   *len = n;
295   return 0;
296 }
297
298 /* Parse the keygrip in STRING into the provided buffer BUF.  BUF must
299    provide space for 20 bytes. BUF is not changed if the function
300    returns an error. */
301 static int
302 parse_keygrip (assuan_context_t ctx, const char *string, unsigned char *buf)
303 {
304   int rc;
305   size_t n = 0;
306
307   rc = parse_hexstring (ctx, string, &n);
308   if (rc)
309     return rc;
310   n /= 2;
311   if (n != 20)
312     return set_error (GPG_ERR_ASS_PARAMETER, "invalid length of keygrip");
313
314   if (hex2bin (string, buf, 20) < 0)
315     return set_error (GPG_ERR_BUG, "hex2bin");
316
317   return 0;
318 }
319
320
321 /* Write an assuan status line. */
322 gpg_error_t
323 agent_write_status (ctrl_t ctrl, const char *keyword, ...)
324 {
325   gpg_error_t err = 0;
326   va_list arg_ptr;
327   const char *text;
328   assuan_context_t ctx = ctrl->server_local->assuan_ctx;
329   char buf[950], *p;
330   size_t n;
331
332   va_start (arg_ptr, keyword);
333
334   p = buf;
335   n = 0;
336   while ( (text = va_arg (arg_ptr, const char *)) )
337     {
338       if (n)
339         {
340           *p++ = ' ';
341           n++;
342         }
343       for ( ; *text && n < DIM (buf)-3; n++, text++)
344         {
345           if (*text == '\n')
346             {
347               *p++ = '\\';
348               *p++ = 'n';
349             }
350           else if (*text == '\r')
351             {
352               *p++ = '\\';
353               *p++ = 'r';
354             }
355           else
356             *p++ = *text;
357         }
358     }
359   *p = 0;
360   err = assuan_write_status (ctx, keyword, buf);
361
362   va_end (arg_ptr);
363   return err;
364 }
365
366
367 /* Helper to notify the client about a launched Pinentry.  Because
368    that might disturb some older clients, this is only done if enabled
369    via an option.  Returns an gpg error code. */
370 gpg_error_t
371 agent_inq_pinentry_launched (ctrl_t ctrl, unsigned long pid)
372 {
373   char line[100];
374
375   if (!ctrl || !ctrl->server_local
376       || !ctrl->server_local->allow_pinentry_notify)
377     return 0;
378   snprintf (line, DIM(line)-1, "PINENTRY_LAUNCHED %lu", pid);
379   return assuan_inquire (ctrl->server_local->assuan_ctx, line, NULL, NULL, 0);
380 }
381
382
383 /* Helper to print a message while leaving a command.  */
384 static gpg_error_t
385 leave_cmd (assuan_context_t ctx, gpg_error_t err)
386 {
387   if (err)
388     {
389       const char *name = assuan_get_command_name (ctx);
390       if (!name)
391         name = "?";
392
393       /* Not all users of gpg-agent know about the fully canceled
394          error code; map it back if needed.  */
395       if (gpg_err_code (err) == GPG_ERR_FULLY_CANCELED)
396         {
397           ctrl_t ctrl = assuan_get_pointer (ctx);
398
399           if (!ctrl->server_local->allow_fully_canceled)
400             err = gpg_err_make (gpg_err_source (err), GPG_ERR_CANCELED);
401         }
402
403       /* Most code from common/ does not know the error source, thus
404          we fix this here.  */
405       if (gpg_err_source (err) == GPG_ERR_SOURCE_UNKNOWN)
406         err = gpg_err_make (GPG_ERR_SOURCE_DEFAULT, gpg_err_code (err));
407
408       if (gpg_err_source (err) == GPG_ERR_SOURCE_DEFAULT)
409         log_error ("command '%s' failed: %s\n", name,
410                    gpg_strerror (err));
411       else
412         log_error ("command '%s' failed: %s <%s>\n", name,
413                    gpg_strerror (err), gpg_strsource (err));
414     }
415   return err;
416 }
417
418
419 \f
420 static const char hlp_geteventcounter[] =
421   "GETEVENTCOUNTER\n"
422   "\n"
423   "Return a a status line named EVENTCOUNTER with the current values\n"
424   "of all event counters.  The values are decimal numbers in the range\n"
425   "0 to UINT_MAX and wrapping around to 0.  The actual values should\n"
426   "not be relied upon, they shall only be used to detect a change.\n"
427   "\n"
428   "The currently defined counters are:\n"
429   "\n"
430   "ANY  - Incremented with any change of any of the other counters.\n"
431   "KEY  - Incremented for added or removed private keys.\n"
432   "CARD - Incremented for changes of the card readers stati.";
433 static gpg_error_t
434 cmd_geteventcounter (assuan_context_t ctx, char *line)
435 {
436   ctrl_t ctrl = assuan_get_pointer (ctx);
437   char any_counter[25];
438   char key_counter[25];
439   char card_counter[25];
440
441   (void)line;
442
443   snprintf (any_counter, sizeof any_counter, "%u", eventcounter.any);
444   snprintf (key_counter, sizeof key_counter, "%u", eventcounter.key);
445   snprintf (card_counter, sizeof card_counter, "%u", eventcounter.card);
446
447   return agent_write_status (ctrl, "EVENTCOUNTER",
448                              any_counter,
449                              key_counter,
450                              card_counter,
451                              NULL);
452 }
453
454
455 /* This function should be called once for all key removals or
456    additions.  This function is assured not to do any context
457    switches. */
458 void
459 bump_key_eventcounter (void)
460 {
461   eventcounter.key++;
462   eventcounter.any++;
463 }
464
465 /* This function should be called for all card reader status
466    changes.  This function is assured not to do any context
467    switches. */
468 void
469 bump_card_eventcounter (void)
470 {
471   eventcounter.card++;
472   eventcounter.any++;
473 }
474
475
476
477 \f
478 static const char hlp_istrusted[] =
479   "ISTRUSTED <hexstring_with_fingerprint>\n"
480   "\n"
481   "Return OK when we have an entry with this fingerprint in our\n"
482   "trustlist";
483 static gpg_error_t
484 cmd_istrusted (assuan_context_t ctx, char *line)
485 {
486   ctrl_t ctrl = assuan_get_pointer (ctx);
487   int rc, n, i;
488   char *p;
489   char fpr[41];
490
491   /* Parse the fingerprint value. */
492   for (p=line,n=0; hexdigitp (p); p++, n++)
493     ;
494   if (*p || !(n == 40 || n == 32))
495     return set_error (GPG_ERR_ASS_PARAMETER, "invalid fingerprint");
496   i = 0;
497   if (n==32)
498     {
499       strcpy (fpr, "00000000");
500       i += 8;
501     }
502   for (p=line; i < 40; p++, i++)
503     fpr[i] = *p >= 'a'? (*p & 0xdf): *p;
504   fpr[i] = 0;
505   rc = agent_istrusted (ctrl, fpr, NULL);
506   if (!rc || gpg_err_code (rc) == GPG_ERR_NOT_TRUSTED)
507     return rc;
508   else if (rc == -1 || gpg_err_code (rc) == GPG_ERR_EOF )
509     return gpg_error (GPG_ERR_NOT_TRUSTED);
510   else
511     return leave_cmd (ctx, rc);
512 }
513
514
515 static const char hlp_listtrusted[] =
516   "LISTTRUSTED\n"
517   "\n"
518   "List all entries from the trustlist.";
519 static gpg_error_t
520 cmd_listtrusted (assuan_context_t ctx, char *line)
521 {
522   int rc;
523
524   (void)line;
525
526   rc = agent_listtrusted (ctx);
527   return leave_cmd (ctx, rc);
528 }
529
530
531 static const char hlp_martrusted[] =
532   "MARKTRUSTED <hexstring_with_fingerprint> <flag> <display_name>\n"
533   "\n"
534   "Store a new key in into the trustlist.";
535 static gpg_error_t
536 cmd_marktrusted (assuan_context_t ctx, char *line)
537 {
538   ctrl_t ctrl = assuan_get_pointer (ctx);
539   int rc, n, i;
540   char *p;
541   char fpr[41];
542   int flag;
543
544   /* parse the fingerprint value */
545   for (p=line,n=0; hexdigitp (p); p++, n++)
546     ;
547   if (!spacep (p) || !(n == 40 || n == 32))
548     return set_error (GPG_ERR_ASS_PARAMETER, "invalid fingerprint");
549   i = 0;
550   if (n==32)
551     {
552       strcpy (fpr, "00000000");
553       i += 8;
554     }
555   for (p=line; i < 40; p++, i++)
556     fpr[i] = *p >= 'a'? (*p & 0xdf): *p;
557   fpr[i] = 0;
558
559   while (spacep (p))
560     p++;
561   flag = *p++;
562   if ( (flag != 'S' && flag != 'P') || !spacep (p) )
563     return set_error (GPG_ERR_ASS_PARAMETER, "invalid flag - must be P or S");
564   while (spacep (p))
565     p++;
566
567   rc = agent_marktrusted (ctrl, p, fpr, flag);
568   return leave_cmd (ctx, rc);
569 }
570
571
572
573 \f
574 static const char hlp_havekey[] =
575   "HAVEKEY <hexstrings_with_keygrips>\n"
576   "\n"
577   "Return success if at least one of the secret keys with the given\n"
578   "keygrips is available.";
579 static gpg_error_t
580 cmd_havekey (assuan_context_t ctx, char *line)
581 {
582   gpg_error_t err;
583   unsigned char buf[20];
584
585   do
586     {
587       err = parse_keygrip (ctx, line, buf);
588       if (err)
589         return err;
590
591       if (!agent_key_available (buf))
592         return 0; /* Found.  */
593
594       while (*line && *line != ' ' && *line != '\t')
595         line++;
596       while (*line == ' ' || *line == '\t')
597         line++;
598     }
599   while (*line);
600
601   /* No leave_cmd() here because errors are expected and would clutter
602      the log.  */
603   return gpg_error (GPG_ERR_NO_SECKEY);
604 }
605
606
607 static const char hlp_sigkey[] =
608   "SIGKEY <hexstring_with_keygrip>\n"
609   "SETKEY <hexstring_with_keygrip>\n"
610   "\n"
611   "Set the  key used for a sign or decrypt operation.";
612 static gpg_error_t
613 cmd_sigkey (assuan_context_t ctx, char *line)
614 {
615   int rc;
616   ctrl_t ctrl = assuan_get_pointer (ctx);
617
618   rc = parse_keygrip (ctx, line, ctrl->keygrip);
619   if (rc)
620     return rc;
621   ctrl->have_keygrip = 1;
622   return 0;
623 }
624
625
626 static const char hlp_setkeydesc[] =
627   "SETKEYDESC plus_percent_escaped_string\n"
628   "\n"
629   "Set a description to be used for the next PKSIGN, PKDECRYPT, IMPORT_KEY\n"
630   "or EXPORT_KEY operation if this operation requires a passphrase.  If\n"
631   "this command is not used a default text will be used.  Note, that\n"
632   "this description implictly selects the label used for the entry\n"
633   "box; if the string contains the string PIN (which in general will\n"
634   "not be translated), \"PIN\" is used, otherwise the translation of\n"
635   "\"passphrase\" is used.  The description string should not contain\n"
636   "blanks unless they are percent or '+' escaped.\n"
637   "\n"
638   "The description is only valid for the next PKSIGN, PKDECRYPT,\n"
639   "IMPORT_KEY or EXPORT_KEY operation.";
640 static gpg_error_t
641 cmd_setkeydesc (assuan_context_t ctx, char *line)
642 {
643   ctrl_t ctrl = assuan_get_pointer (ctx);
644   char *desc, *p;
645
646   for (p=line; *p == ' '; p++)
647     ;
648   desc = p;
649   p = strchr (desc, ' ');
650   if (p)
651     *p = 0; /* We ignore any garbage; we might late use it for other args. */
652
653   if (!desc || !*desc)
654     return set_error (GPG_ERR_ASS_PARAMETER, "no description given");
655
656   /* Note, that we only need to replace the + characters and should
657      leave the other escaping in place because the escaped string is
658      send verbatim to the pinentry which does the unescaping (but not
659      the + replacing) */
660   plus_to_blank (desc);
661
662   xfree (ctrl->server_local->keydesc);
663   ctrl->server_local->keydesc = xtrystrdup (desc);
664   if (!ctrl->server_local->keydesc)
665     return out_of_core ();
666   return 0;
667 }
668
669
670 static const char hlp_sethash[] =
671   "SETHASH (--hash=<name>)|(<algonumber>) <hexstring>\n"
672   "\n"
673   "The client can use this command to tell the server about the data\n"
674   "(which usually is a hash) to be signed.";
675 static gpg_error_t
676 cmd_sethash (assuan_context_t ctx, char *line)
677 {
678   int rc;
679   size_t n;
680   char *p;
681   ctrl_t ctrl = assuan_get_pointer (ctx);
682   unsigned char *buf;
683   char *endp;
684   int algo;
685
686   /* Parse the alternative hash options which may be used instead of
687      the algo number.  */
688   if (has_option_name (line, "--hash"))
689     {
690       if (has_option (line, "--hash=sha1"))
691         algo = GCRY_MD_SHA1;
692       else if (has_option (line, "--hash=sha224"))
693         algo = GCRY_MD_SHA224;
694       else if (has_option (line, "--hash=sha256"))
695         algo = GCRY_MD_SHA256;
696       else if (has_option (line, "--hash=sha384"))
697         algo = GCRY_MD_SHA384;
698       else if (has_option (line, "--hash=sha512"))
699         algo = GCRY_MD_SHA512;
700       else if (has_option (line, "--hash=rmd160"))
701         algo = GCRY_MD_RMD160;
702       else if (has_option (line, "--hash=md5"))
703         algo = GCRY_MD_MD5;
704       else if (has_option (line, "--hash=tls-md5sha1"))
705         algo = MD_USER_TLS_MD5SHA1;
706       else
707         return set_error (GPG_ERR_ASS_PARAMETER, "invalid hash algorithm");
708     }
709   else
710     algo = 0;
711
712   line = skip_options (line);
713
714   if (!algo)
715     {
716       /* No hash option has been given: require an algo number instead  */
717       algo = (int)strtoul (line, &endp, 10);
718       for (line = endp; *line == ' ' || *line == '\t'; line++)
719         ;
720       if (!algo || gcry_md_test_algo (algo))
721         return set_error (GPG_ERR_UNSUPPORTED_ALGORITHM, NULL);
722     }
723   ctrl->digest.algo = algo;
724   ctrl->digest.raw_value = 0;
725
726   /* Parse the hash value. */
727   n = 0;
728   rc = parse_hexstring (ctx, line, &n);
729   if (rc)
730     return rc;
731   n /= 2;
732   if (algo == MD_USER_TLS_MD5SHA1 && n == 36)
733     ;
734   else if (n != 16 && n != 20 && n != 24
735            && n != 28 && n != 32 && n != 48 && n != 64)
736     return set_error (GPG_ERR_ASS_PARAMETER, "unsupported length of hash");
737
738   if (n > MAX_DIGEST_LEN)
739     return set_error (GPG_ERR_ASS_PARAMETER, "hash value to long");
740
741   buf = ctrl->digest.value;
742   ctrl->digest.valuelen = n;
743   for (p=line, n=0; n < ctrl->digest.valuelen; p += 2, n++)
744     buf[n] = xtoi_2 (p);
745   for (; n < ctrl->digest.valuelen; n++)
746     buf[n] = 0;
747   return 0;
748 }
749
750
751 static const char hlp_pksign[] =
752   "PKSIGN [<options>] [<cache_nonce>]\n"
753   "\n"
754   "Perform the actual sign operation.  Neither input nor output are\n"
755   "sensitive to eavesdropping.";
756 static gpg_error_t
757 cmd_pksign (assuan_context_t ctx, char *line)
758 {
759   int rc;
760   cache_mode_t cache_mode = CACHE_MODE_NORMAL;
761   ctrl_t ctrl = assuan_get_pointer (ctx);
762   membuf_t outbuf;
763   char *cache_nonce = NULL;
764   char *p;
765
766   line = skip_options (line);
767
768   p = line;
769   for (p=line; *p && *p != ' ' && *p != '\t'; p++)
770     ;
771   *p = '\0';
772   if (*line)
773     cache_nonce = xtrystrdup (line);
774
775   if (opt.ignore_cache_for_signing)
776     cache_mode = CACHE_MODE_IGNORE;
777   else if (!ctrl->server_local->use_cache_for_signing)
778     cache_mode = CACHE_MODE_IGNORE;
779
780   init_membuf (&outbuf, 512);
781
782   rc = agent_pksign (ctrl, cache_nonce, ctrl->server_local->keydesc,
783                      &outbuf, cache_mode);
784   if (rc)
785     clear_outbuf (&outbuf);
786   else
787     rc = write_and_clear_outbuf (ctx, &outbuf);
788
789   xfree (cache_nonce);
790   xfree (ctrl->server_local->keydesc);
791   ctrl->server_local->keydesc = NULL;
792   return leave_cmd (ctx, rc);
793 }
794
795
796 static const char hlp_pkdecrypt[] =
797   "PKDECRYPT [<options>]\n"
798   "\n"
799   "Perform the actual decrypt operation.  Input is not\n"
800   "sensitive to eavesdropping.";
801 static gpg_error_t
802 cmd_pkdecrypt (assuan_context_t ctx, char *line)
803 {
804   int rc;
805   ctrl_t ctrl = assuan_get_pointer (ctx);
806   unsigned char *value;
807   size_t valuelen;
808   membuf_t outbuf;
809
810   (void)line;
811
812   /* First inquire the data to decrypt */
813   rc = assuan_inquire (ctx, "CIPHERTEXT",
814                        &value, &valuelen, MAXLEN_CIPHERTEXT);
815   if (rc)
816     return rc;
817
818   init_membuf (&outbuf, 512);
819
820   rc = agent_pkdecrypt (ctrl, ctrl->server_local->keydesc,
821                         value, valuelen, &outbuf);
822   xfree (value);
823   if (rc)
824     clear_outbuf (&outbuf);
825   else
826     rc = write_and_clear_outbuf (ctx, &outbuf);
827   xfree (ctrl->server_local->keydesc);
828   ctrl->server_local->keydesc = NULL;
829   return leave_cmd (ctx, rc);
830 }
831
832
833 static const char hlp_genkey[] =
834   "GENKEY [--no-protection] [<cache_nonce>]\n"
835   "\n"
836   "Generate a new key, store the secret part and return the public\n"
837   "part.  Here is an example transaction:\n"
838   "\n"
839   "  C: GENKEY\n"
840   "  S: INQUIRE KEYPARAM\n"
841   "  C: D (genkey (rsa (nbits  1024)))\n"
842   "  C: END\n"
843   "  S: D (public-key\n"
844   "  S: D   (rsa (n 326487324683264) (e 10001)))\n"
845   "  S: OK key created\n"
846   "\n";
847 static gpg_error_t
848 cmd_genkey (assuan_context_t ctx, char *line)
849 {
850   ctrl_t ctrl = assuan_get_pointer (ctx);
851   int rc;
852   int no_protection;
853   unsigned char *value;
854   size_t valuelen;
855   membuf_t outbuf;
856   char *cache_nonce = NULL;
857   char *p;
858
859   no_protection = has_option (line, "--no-protection");
860   line = skip_options (line);
861
862   p = line;
863   for (p=line; *p && *p != ' ' && *p != '\t'; p++)
864     ;
865   *p = '\0';
866   if (*line)
867     cache_nonce = xtrystrdup (line);
868
869   /* First inquire the parameters */
870   rc = assuan_inquire (ctx, "KEYPARAM", &value, &valuelen, MAXLEN_KEYPARAM);
871   if (rc)
872     return rc;
873
874   init_membuf (&outbuf, 512);
875
876   rc = agent_genkey (ctrl, cache_nonce, (char*)value, valuelen, no_protection,
877                      &outbuf);
878   xfree (value);
879   if (rc)
880     clear_outbuf (&outbuf);
881   else
882     rc = write_and_clear_outbuf (ctx, &outbuf);
883   xfree (cache_nonce);
884   return leave_cmd (ctx, rc);
885 }
886
887
888
889 \f
890 static const char hlp_readkey[] =
891   "READKEY <hexstring_with_keygrip>\n"
892   "\n"
893   "Return the public key for the given keygrip.";
894 static gpg_error_t
895 cmd_readkey (assuan_context_t ctx, char *line)
896 {
897   ctrl_t ctrl = assuan_get_pointer (ctx);
898   int rc;
899   unsigned char grip[20];
900   gcry_sexp_t s_pkey = NULL;
901
902   rc = parse_keygrip (ctx, line, grip);
903   if (rc)
904     return rc; /* Return immediately as this is already an Assuan error code.*/
905
906   rc = agent_public_key_from_file (ctrl, grip, &s_pkey);
907   if (!rc)
908     {
909       size_t len;
910       unsigned char *buf;
911
912       len = gcry_sexp_sprint (s_pkey, GCRYSEXP_FMT_CANON, NULL, 0);
913       assert (len);
914       buf = xtrymalloc (len);
915       if (!buf)
916         rc = gpg_error_from_syserror ();
917       else
918         {
919           len = gcry_sexp_sprint (s_pkey, GCRYSEXP_FMT_CANON, buf, len);
920           assert (len);
921           rc = assuan_send_data (ctx, buf, len);
922           xfree (buf);
923         }
924       gcry_sexp_release (s_pkey);
925     }
926
927   return leave_cmd (ctx, rc);
928 }
929
930
931 \f
932 static const char hlp_keyinfo[] =
933   "KEYINFO [--list] [--data] <keygrip>\n"
934   "\n"
935   "Return information about the key specified by the KEYGRIP.  If the\n"
936   "key is not available GPG_ERR_NOT_FOUND is returned.  If the option\n"
937   "--list is given the keygrip is ignored and information about all\n"
938   "available keys are returned.  The information is returned as a\n"
939   "status line unless --data was specified, with this format:\n"
940   "\n"
941   "  KEYINFO <keygrip> <type> <serialno> <idstr> <cached>\n"
942   "\n"
943   "KEYGRIP is the keygrip.\n"
944   "\n"
945   "TYPE is describes the type of the key:\n"
946   "    'D' - Regular key stored on disk,\n"
947   "    'T' - Key is stored on a smartcard (token),\n"
948   "    '-' - Unknown type.\n"
949   "\n"
950   "SERIALNO is an ASCII string with the serial number of the\n"
951   "         smartcard.  If the serial number is not known a single\n"
952   "         dash '-' is used instead.\n"
953   "\n"
954   "IDSTR is the IDSTR used to distinguish keys on a smartcard.  If it\n"
955   "      is not known a dash is used instead.\n"
956   "\n"
957   "CACHED is 1 if the passphrase for the key was found in the key cache.\n"
958   "       If not, a '-' is used instead.\n"
959   "\n"
960   "More information may be added in the future.";
961 static gpg_error_t
962 do_one_keyinfo (ctrl_t ctrl, const unsigned char *grip, assuan_context_t ctx,
963                 int data)
964 {
965   gpg_error_t err;
966   char hexgrip[40+1];
967   int keytype;
968   unsigned char *shadow_info = NULL;
969   char *serialno = NULL;
970   char *idstr = NULL;
971   const char *keytypestr;
972   const char *cached;
973   char *pw;
974
975   err = agent_key_info_from_file (ctrl, grip, &keytype, &shadow_info);
976   if (err)
977     goto leave;
978
979   /* Reformat the grip so that we use uppercase as good style. */
980   bin2hex (grip, 20, hexgrip);
981
982   if (keytype == PRIVATE_KEY_CLEAR
983       || keytype == PRIVATE_KEY_PROTECTED)
984     keytypestr = "D";
985   else if (keytype == PRIVATE_KEY_SHADOWED)
986     keytypestr = "T";
987   else
988     keytypestr = "-";
989
990   /* Here we have a little race by doing the cache check separately
991      from the retrieval function.  Given that the cache flag is only a
992      hint, it should not really matter.  */
993   pw = agent_get_cache (hexgrip, CACHE_MODE_NORMAL);
994   cached = pw ? "1" : "-";
995   xfree (pw);
996
997   if (shadow_info)
998     {
999       err = parse_shadow_info (shadow_info, &serialno, &idstr);
1000       if (err)
1001         goto leave;
1002     }
1003
1004   if (!data)
1005     err = agent_write_status (ctrl, "KEYINFO",
1006                               hexgrip,
1007                               keytypestr,
1008                               serialno? serialno : "-",
1009                               idstr? idstr : "-",
1010                               cached,
1011                               NULL);
1012   else
1013     {
1014       char *string;
1015
1016       string = xtryasprintf ("%s %s %s %s %s\n",
1017                              hexgrip, keytypestr,
1018                              serialno? serialno : "-",
1019                              idstr? idstr : "-", cached);
1020       if (!string)
1021         err = gpg_error_from_syserror ();
1022       else
1023         err = assuan_send_data (ctx, string, strlen(string));
1024       xfree (string);
1025     }
1026
1027  leave:
1028   xfree (shadow_info);
1029   xfree (serialno);
1030   xfree (idstr);
1031   return err;
1032 }
1033
1034
1035 static gpg_error_t
1036 cmd_keyinfo (assuan_context_t ctx, char *line)
1037 {
1038   ctrl_t ctrl = assuan_get_pointer (ctx);
1039   int err;
1040   unsigned char grip[20];
1041   DIR *dir = NULL;
1042   int list_mode;
1043   int opt_data;
1044
1045   list_mode = has_option (line, "--list");
1046   opt_data = has_option (line, "--data");
1047   line = skip_options (line);
1048
1049   if (list_mode)
1050     {
1051       char *dirname;
1052       struct dirent *dir_entry;
1053       char hexgrip[41];
1054
1055       dirname = make_filename_try (opt.homedir, GNUPG_PRIVATE_KEYS_DIR, NULL);
1056       if (!dirname)
1057         {
1058           err = gpg_error_from_syserror ();
1059           goto leave;
1060         }
1061       dir = opendir (dirname);
1062       if (!dir)
1063         {
1064           err = gpg_error_from_syserror ();
1065           xfree (dirname);
1066           goto leave;
1067         }
1068       xfree (dirname);
1069
1070       while ( (dir_entry = readdir (dir)) )
1071         {
1072           if (strlen (dir_entry->d_name) != 44
1073               || strcmp (dir_entry->d_name + 40, ".key"))
1074             continue;
1075           strncpy (hexgrip, dir_entry->d_name, 40);
1076           hexgrip[40] = 0;
1077
1078           if ( hex2bin (hexgrip, grip, 20) < 0 )
1079             continue; /* Bad hex string.  */
1080
1081           err = do_one_keyinfo (ctrl, grip, ctx, opt_data);
1082           if (err)
1083             goto leave;
1084         }
1085       err = 0;
1086     }
1087   else
1088     {
1089       err = parse_keygrip (ctx, line, grip);
1090       if (err)
1091         goto leave;
1092       err = do_one_keyinfo (ctrl, grip, ctx, opt_data);
1093     }
1094
1095  leave:
1096   if (dir)
1097     closedir (dir);
1098   if (err && gpg_err_code (err) != GPG_ERR_NOT_FOUND)
1099     leave_cmd (ctx, err);
1100   return err;
1101 }
1102
1103
1104 \f
1105 static int
1106 send_back_passphrase (assuan_context_t ctx, int via_data, const char *pw)
1107 {
1108   size_t n;
1109   int rc;
1110
1111   assuan_begin_confidential (ctx);
1112   n = strlen (pw);
1113   if (via_data)
1114     rc = assuan_send_data (ctx, pw, n);
1115   else
1116     {
1117       char *p = xtrymalloc_secure (n*2+1);
1118       if (!p)
1119         rc = gpg_error_from_syserror ();
1120       else
1121         {
1122           bin2hex (pw, n, p);
1123           rc = assuan_set_okay_line (ctx, p);
1124           xfree (p);
1125         }
1126     }
1127   return rc;
1128 }
1129
1130
1131 static const char hlp_get_passphrase[] =
1132   "GET_PASSPHRASE [--data] [--check] [--no-ask] [--repeat[=N]]\n"
1133   "               [--qualitybar] <cache_id>\n"
1134   "               [<error_message> <prompt> <description>]\n"
1135   "\n"
1136   "This function is usually used to ask for a passphrase to be used\n"
1137   "for conventional encryption, but may also be used by programs which\n"
1138   "need specal handling of passphrases.  This command uses a syntax\n"
1139   "which helps clients to use the agent with minimum effort.  The\n"
1140   "agent either returns with an error or with a OK followed by the hex\n"
1141   "encoded passphrase.  Note that the length of the strings is\n"
1142   "implicitly limited by the maximum length of a command.\n"
1143   "\n"
1144   "If the option \"--data\" is used the passphrase is returned by usual\n"
1145   "data lines and not on the okay line.\n"
1146   "\n"
1147   "If the option \"--check\" is used the passphrase constraints checks as\n"
1148   "implemented by gpg-agent are applied.  A check is not done if the\n"
1149   "passphrase has been found in the cache.\n"
1150   "\n"
1151   "If the option \"--no-ask\" is used and the passphrase is not in the\n"
1152   "cache the user will not be asked to enter a passphrase but the error\n"
1153   "code GPG_ERR_NO_DATA is returned.  \n"
1154   "\n"
1155   "If the option \"--qualitybar\" is used a visual indication of the\n"
1156   "entered passphrase quality is shown.  (Unless no minimum passphrase\n"
1157   "length has been configured.)";
1158 static gpg_error_t
1159 cmd_get_passphrase (assuan_context_t ctx, char *line)
1160 {
1161   ctrl_t ctrl = assuan_get_pointer (ctx);
1162   int rc;
1163   char *pw;
1164   char *response;
1165   char *cacheid = NULL, *desc = NULL, *prompt = NULL, *errtext = NULL;
1166   const char *desc2 = _("Please re-enter this passphrase");
1167   char *p;
1168   int opt_data, opt_check, opt_no_ask, opt_qualbar;
1169   int opt_repeat = 0;
1170   char *repeat_errtext = NULL;
1171
1172   opt_data = has_option (line, "--data");
1173   opt_check = has_option (line, "--check");
1174   opt_no_ask = has_option (line, "--no-ask");
1175   if (has_option_name (line, "--repeat"))
1176     {
1177       p = option_value (line, "--repeat");
1178       if (p)
1179         opt_repeat = atoi (p);
1180       else
1181         opt_repeat = 1;
1182     }
1183   opt_qualbar = has_option (line, "--qualitybar");
1184   line = skip_options (line);
1185
1186   cacheid = line;
1187   p = strchr (cacheid, ' ');
1188   if (p)
1189     {
1190       *p++ = 0;
1191       while (*p == ' ')
1192         p++;
1193       errtext = p;
1194       p = strchr (errtext, ' ');
1195       if (p)
1196         {
1197           *p++ = 0;
1198           while (*p == ' ')
1199             p++;
1200           prompt = p;
1201           p = strchr (prompt, ' ');
1202           if (p)
1203             {
1204               *p++ = 0;
1205               while (*p == ' ')
1206                 p++;
1207               desc = p;
1208               p = strchr (desc, ' ');
1209               if (p)
1210                 *p = 0; /* Ignore trailing garbage. */
1211             }
1212         }
1213     }
1214   if (!cacheid || !*cacheid || strlen (cacheid) > 50)
1215     return set_error (GPG_ERR_ASS_PARAMETER, "invalid length of cacheID");
1216   if (!desc)
1217     return set_error (GPG_ERR_ASS_PARAMETER, "no description given");
1218
1219   if (!strcmp (cacheid, "X"))
1220     cacheid = NULL;
1221   if (!strcmp (errtext, "X"))
1222     errtext = NULL;
1223   if (!strcmp (prompt, "X"))
1224     prompt = NULL;
1225   if (!strcmp (desc, "X"))
1226     desc = NULL;
1227
1228   pw = cacheid ? agent_get_cache (cacheid, CACHE_MODE_NORMAL) : NULL;
1229   if (pw)
1230     {
1231       rc = send_back_passphrase (ctx, opt_data, pw);
1232       xfree (pw);
1233     }
1234   else if (opt_no_ask)
1235     rc = gpg_error (GPG_ERR_NO_DATA);
1236   else
1237     {
1238       /* Note, that we only need to replace the + characters and
1239          should leave the other escaping in place because the escaped
1240          string is send verbatim to the pinentry which does the
1241          unescaping (but not the + replacing) */
1242       if (errtext)
1243         plus_to_blank (errtext);
1244       if (prompt)
1245         plus_to_blank (prompt);
1246       if (desc)
1247         plus_to_blank (desc);
1248
1249     next_try:
1250       rc = agent_get_passphrase (ctrl, &response, desc, prompt,
1251                                  repeat_errtext? repeat_errtext:errtext,
1252                                  opt_qualbar);
1253       xfree (repeat_errtext);
1254       repeat_errtext = NULL;
1255       if (!rc)
1256         {
1257           int i;
1258
1259           if (opt_check && check_passphrase_constraints (ctrl, response, 0))
1260             {
1261               xfree (response);
1262               goto next_try;
1263             }
1264           for (i = 0; i < opt_repeat; i++)
1265             {
1266               char *response2;
1267
1268               rc = agent_get_passphrase (ctrl, &response2, desc2, prompt,
1269                                          errtext, 0);
1270               if (rc)
1271                 break;
1272               if (strcmp (response2, response))
1273                 {
1274                   xfree (response2);
1275                   xfree (response);
1276                   repeat_errtext = try_percent_escape
1277                     (_("does not match - try again"), NULL);
1278                   if (!repeat_errtext)
1279                     {
1280                       rc = gpg_error_from_syserror ();
1281                       break;
1282                     }
1283                   goto next_try;
1284                 }
1285               xfree (response2);
1286             }
1287           if (!rc)
1288             {
1289               if (cacheid)
1290                 agent_put_cache (cacheid, CACHE_MODE_USER, response, 0);
1291               rc = send_back_passphrase (ctx, opt_data, response);
1292             }
1293           xfree (response);
1294         }
1295     }
1296
1297   return leave_cmd (ctx, rc);
1298 }
1299
1300
1301 static const char hlp_clear_passphrase[] =
1302   "CLEAR_PASSPHRASE [--mode=normal] <cache_id>\n"
1303   "\n"
1304   "may be used to invalidate the cache entry for a passphrase.  The\n"
1305   "function returns with OK even when there is no cached passphrase.\n"
1306   "The --mode=normal option is used to clear an entry for a cacheid\n"
1307   "added by the agent.\n";
1308 static gpg_error_t
1309 cmd_clear_passphrase (assuan_context_t ctx, char *line)
1310 {
1311   char *cacheid = NULL;
1312   char *p;
1313   int opt_normal;
1314
1315   opt_normal = has_option (line, "--mode=normal");
1316   line = skip_options (line);
1317
1318   /* parse the stuff */
1319   for (p=line; *p == ' '; p++)
1320     ;
1321   cacheid = p;
1322   p = strchr (cacheid, ' ');
1323   if (p)
1324     *p = 0; /* ignore garbage */
1325   if (!cacheid || !*cacheid || strlen (cacheid) > 50)
1326     return set_error (GPG_ERR_ASS_PARAMETER, "invalid length of cacheID");
1327
1328   agent_put_cache (cacheid, opt_normal ? CACHE_MODE_NORMAL : CACHE_MODE_USER,
1329                    NULL, 0);
1330   return 0;
1331 }
1332
1333
1334 static const char hlp_get_confirmation[] =
1335   "GET_CONFIRMATION <description>\n"
1336   "\n"
1337   "This command may be used to ask for a simple confirmation.\n"
1338   "DESCRIPTION is displayed along with a Okay and Cancel button.  This\n"
1339   "command uses a syntax which helps clients to use the agent with\n"
1340   "minimum effort.  The agent either returns with an error or with a\n"
1341   "OK.  Note, that the length of DESCRIPTION is implicitly limited by\n"
1342   "the maximum length of a command. DESCRIPTION should not contain\n"
1343   "any spaces, those must be encoded either percent escaped or simply\n"
1344   "as '+'.";
1345 static gpg_error_t
1346 cmd_get_confirmation (assuan_context_t ctx, char *line)
1347 {
1348   ctrl_t ctrl = assuan_get_pointer (ctx);
1349   int rc;
1350   char *desc = NULL;
1351   char *p;
1352
1353   /* parse the stuff */
1354   for (p=line; *p == ' '; p++)
1355     ;
1356   desc = p;
1357   p = strchr (desc, ' ');
1358   if (p)
1359     *p = 0; /* We ignore any garbage -may be later used for other args. */
1360
1361   if (!desc || !*desc)
1362     return set_error (GPG_ERR_ASS_PARAMETER, "no description given");
1363
1364   if (!strcmp (desc, "X"))
1365     desc = NULL;
1366
1367   /* Note, that we only need to replace the + characters and should
1368      leave the other escaping in place because the escaped string is
1369      send verbatim to the pinentry which does the unescaping (but not
1370      the + replacing) */
1371   if (desc)
1372     plus_to_blank (desc);
1373
1374   rc = agent_get_confirmation (ctrl, desc, NULL, NULL, 0);
1375   return leave_cmd (ctx, rc);
1376 }
1377
1378
1379 \f
1380 static const char hlp_learn[] =
1381   "LEARN [--send]\n"
1382   "\n"
1383   "Learn something about the currently inserted smartcard.  With\n"
1384   "--send the new certificates are send back.";
1385 static gpg_error_t
1386 cmd_learn (assuan_context_t ctx, char *line)
1387 {
1388   ctrl_t ctrl = assuan_get_pointer (ctx);
1389   int rc;
1390
1391   rc = agent_handle_learn (ctrl, has_option (line, "--send")? ctx : NULL);
1392   return leave_cmd (ctx, rc);
1393 }
1394
1395
1396 \f
1397 static const char hlp_passwd[] =
1398   "PASSWD [--cache-nonce=<c>] [--passwd-nonce=<s>] <hexstring_with_keygrip>\n"
1399   "\n"
1400   "Change the passphrase/PIN for the key identified by keygrip in LINE.";
1401 static gpg_error_t
1402 cmd_passwd (assuan_context_t ctx, char *line)
1403 {
1404   ctrl_t ctrl = assuan_get_pointer (ctx);
1405   gpg_error_t err;
1406   int c;
1407   char *cache_nonce = NULL;
1408   char *passwd_nonce = NULL;
1409   unsigned char grip[20];
1410   gcry_sexp_t s_skey = NULL;
1411   unsigned char *shadow_info = NULL;
1412   char *passphrase = NULL;
1413   char *pend;
1414
1415   cache_nonce = option_value (line, "--cache-nonce");
1416   if (cache_nonce)
1417     {
1418       for (pend = cache_nonce; *pend && !spacep (pend); pend++)
1419         ;
1420       c = *pend;
1421       *pend = '\0';
1422       cache_nonce = xtrystrdup (cache_nonce);
1423       *pend = c;
1424       if (!cache_nonce)
1425         {
1426           err = gpg_error_from_syserror ();
1427           goto leave;
1428         }
1429     }
1430
1431   passwd_nonce = option_value (line, "--passwd-nonce");
1432   if (passwd_nonce)
1433     {
1434       for (pend = passwd_nonce; *pend && !spacep (pend); pend++)
1435         ;
1436       c = *pend;
1437       *pend = '\0';
1438       passwd_nonce = xtrystrdup (passwd_nonce);
1439       *pend = c;
1440       if (!passwd_nonce)
1441         {
1442           err = gpg_error_from_syserror ();
1443           goto leave;
1444         }
1445     }
1446
1447   line = skip_options (line);
1448
1449   err = parse_keygrip (ctx, line, grip);
1450   if (err)
1451     goto leave;
1452
1453   ctrl->in_passwd++;
1454   err = agent_key_from_file (ctrl, cache_nonce, ctrl->server_local->keydesc,
1455                              grip, &shadow_info, CACHE_MODE_IGNORE, NULL,
1456                              &s_skey, &passphrase);
1457   if (err)
1458     ;
1459   else if (!s_skey)
1460     {
1461       log_error ("changing a smartcard PIN is not yet supported\n");
1462       err = gpg_error (GPG_ERR_NOT_IMPLEMENTED);
1463     }
1464   else
1465     {
1466       char *newpass = NULL;
1467
1468       if (passwd_nonce)
1469         newpass = agent_get_cache (passwd_nonce, CACHE_MODE_NONCE);
1470       err = agent_protect_and_store (ctrl, s_skey, &newpass);
1471       if (!err && passphrase)
1472         {
1473           /* A passphrase existed on the old key and the change was
1474              successful.  Return a nonce for that old passphrase to
1475              let the caller try to unprotect the other subkeys with
1476              the same key.  */
1477           if (!cache_nonce)
1478             {
1479               char buf[12];
1480               gcry_create_nonce (buf, 12);
1481               cache_nonce = bin2hex (buf, 12, NULL);
1482             }
1483           if (cache_nonce
1484               && !agent_put_cache (cache_nonce, CACHE_MODE_NONCE,
1485                                    passphrase, 120 /*seconds*/))
1486             {
1487               assuan_write_status (ctx, "CACHE_NONCE", cache_nonce);
1488               xfree (ctrl->server_local->last_cache_nonce);
1489               ctrl->server_local->last_cache_nonce = cache_nonce;
1490               cache_nonce = NULL;
1491             }
1492           if (newpass)
1493             {
1494               /* If we have a new passphrase (which might be empty) we
1495                  store it under a passwd nonce so that the caller may
1496                  send that nonce again to use it for another key. */
1497               if (!passwd_nonce)
1498                 {
1499                   char buf[12];
1500                   gcry_create_nonce (buf, 12);
1501                   passwd_nonce = bin2hex (buf, 12, NULL);
1502                 }
1503               if (passwd_nonce
1504                   && !agent_put_cache (passwd_nonce, CACHE_MODE_NONCE,
1505                                        newpass, 120 /*seconds*/))
1506                 {
1507                   assuan_write_status (ctx, "PASSWD_NONCE", passwd_nonce);
1508                   xfree (ctrl->server_local->last_passwd_nonce);
1509                   ctrl->server_local->last_passwd_nonce = passwd_nonce;
1510                   passwd_nonce = NULL;
1511                 }
1512             }
1513         }
1514       xfree (newpass);
1515     }
1516   ctrl->in_passwd--;
1517
1518   xfree (ctrl->server_local->keydesc);
1519   ctrl->server_local->keydesc = NULL;
1520
1521  leave:
1522   xfree (passphrase);
1523   gcry_sexp_release (s_skey);
1524   xfree (shadow_info);
1525   xfree (cache_nonce);
1526   return leave_cmd (ctx, err);
1527 }
1528
1529
1530 static const char hlp_preset_passphrase[] =
1531   "PRESET_PASSPHRASE <string_or_keygrip> <timeout> <hexstring>\n"
1532   "\n"
1533   "Set the cached passphrase/PIN for the key identified by the keygrip\n"
1534   "to passwd for the given time, where -1 means infinite and 0 means\n"
1535   "the default (currently only a timeout of -1 is allowed, which means\n"
1536   "to never expire it).  If passwd is not provided, ask for it via the\n"
1537   "pinentry module.";
1538 static gpg_error_t
1539 cmd_preset_passphrase (assuan_context_t ctx, char *line)
1540 {
1541   int rc;
1542   char *grip_clear = NULL;
1543   char *passphrase = NULL;
1544   int ttl;
1545   size_t len;
1546
1547   if (!opt.allow_preset_passphrase)
1548     return set_error (GPG_ERR_NOT_SUPPORTED, "no --allow-preset-passphrase");
1549
1550   grip_clear = line;
1551   while (*line && (*line != ' ' && *line != '\t'))
1552     line++;
1553   if (!*line)
1554     return gpg_error (GPG_ERR_MISSING_VALUE);
1555   *line = '\0';
1556   line++;
1557   while (*line && (*line == ' ' || *line == '\t'))
1558     line++;
1559
1560   /* Currently, only infinite timeouts are allowed.  */
1561   ttl = -1;
1562   if (line[0] != '-' || line[1] != '1')
1563     return gpg_error (GPG_ERR_NOT_IMPLEMENTED);
1564   line++;
1565   line++;
1566   while (!(*line != ' ' && *line != '\t'))
1567     line++;
1568
1569   /* Syntax check the hexstring.  */
1570   len = 0;
1571   rc = parse_hexstring (ctx, line, &len);
1572   if (rc)
1573     return rc;
1574   line[len] = '\0';
1575
1576   /* If there is a passphrase, use it.  Currently, a passphrase is
1577      required.  */
1578   if (*line)
1579     {
1580       /* Do in-place conversion.  */
1581       passphrase = line;
1582       if (!hex2str (passphrase, passphrase, strlen (passphrase)+1, NULL))
1583         rc = set_error (GPG_ERR_ASS_PARAMETER, "invalid hexstring");
1584     }
1585   else
1586     rc = set_error (GPG_ERR_NOT_IMPLEMENTED, "passphrase is required");
1587
1588   if (!rc)
1589     rc = agent_put_cache (grip_clear, CACHE_MODE_ANY, passphrase, ttl);
1590
1591   return leave_cmd (ctx, rc);
1592 }
1593
1594
1595 \f
1596 static const char hlp_scd[] =
1597   "SCD <commands to pass to the scdaemon>\n"
1598   " \n"
1599   "This is a general quote command to redirect everything to the\n"
1600   "SCdaemon.";
1601 static gpg_error_t
1602 cmd_scd (assuan_context_t ctx, char *line)
1603 {
1604   ctrl_t ctrl = assuan_get_pointer (ctx);
1605   int rc;
1606
1607   rc = divert_generic_cmd (ctrl, line, ctx);
1608
1609   return rc;
1610 }
1611
1612
1613 \f
1614 static const char hlp_keywrap_key[] =
1615   "KEYWRAP_KEY [--clear] <mode>\n"
1616   "\n"
1617   "Return a key to wrap another key.  For now the key is returned\n"
1618   "verbatim and and thus makes not much sense because an eavesdropper on\n"
1619   "the gpg-agent connection will see the key as well as the wrapped key.\n"
1620   "However, this function may either be equipped with a public key\n"
1621   "mechanism or not used at all if the key is a pre-shared key.  In any\n"
1622   "case wrapping the import and export of keys is a requirement for\n"
1623   "certain cryptographic validations and thus useful.  The key persists\n"
1624   "a RESET command but may be cleared using the option --clear.\n"
1625   "\n"
1626   "Supported modes are:\n"
1627   "  --import  - Return a key to import a key into gpg-agent\n"
1628   "  --export  - Return a key to export a key from gpg-agent";
1629 static gpg_error_t
1630 cmd_keywrap_key (assuan_context_t ctx, char *line)
1631 {
1632   ctrl_t ctrl = assuan_get_pointer (ctx);
1633   gpg_error_t err = 0;
1634   int clearopt = has_option (line, "--clear");
1635
1636
1637   assuan_begin_confidential (ctx);
1638   if (has_option (line, "--import"))
1639     {
1640       xfree (ctrl->server_local->import_key);
1641       if (clearopt)
1642         ctrl->server_local->import_key = NULL;
1643       else if (!(ctrl->server_local->import_key =
1644                  gcry_random_bytes (KEYWRAP_KEYSIZE, GCRY_STRONG_RANDOM)))
1645         err = gpg_error_from_syserror ();
1646       else
1647         err = assuan_send_data (ctx, ctrl->server_local->import_key,
1648                                 KEYWRAP_KEYSIZE);
1649     }
1650   else if (has_option (line, "--export"))
1651     {
1652       xfree (ctrl->server_local->export_key);
1653       if (clearopt)
1654         ctrl->server_local->export_key = NULL;
1655       else if (!(ctrl->server_local->export_key =
1656             gcry_random_bytes (KEYWRAP_KEYSIZE, GCRY_STRONG_RANDOM)))
1657         err = gpg_error_from_syserror ();
1658       else
1659         err = assuan_send_data (ctx, ctrl->server_local->export_key,
1660                                 KEYWRAP_KEYSIZE);
1661     }
1662   else
1663     err = set_error (GPG_ERR_ASS_PARAMETER, "unknown value for MODE");
1664   assuan_end_confidential (ctx);
1665
1666   return leave_cmd (ctx, err);
1667 }
1668
1669
1670 \f
1671 static const char hlp_import_key[] =
1672   "IMPORT_KEY [<cache_nonce>]\n"
1673   "\n"
1674   "Import a secret key into the key store.  The key is expected to be\n"
1675   "encrypted using the current session's key wrapping key (cf. command\n"
1676   "KEYWRAP_KEY) using the AESWRAP-128 algorithm.  This function takes\n"
1677   "no arguments but uses the inquiry \"KEYDATA\" to ask for the actual\n"
1678   "key data.  The unwrapped key must be a canonical S-expression.";
1679 static gpg_error_t
1680 cmd_import_key (assuan_context_t ctx, char *line)
1681 {
1682   ctrl_t ctrl = assuan_get_pointer (ctx);
1683   gpg_error_t err;
1684   unsigned char *wrappedkey = NULL;
1685   size_t wrappedkeylen;
1686   gcry_cipher_hd_t cipherhd = NULL;
1687   unsigned char *key = NULL;
1688   size_t keylen, realkeylen;
1689   char *passphrase = NULL;
1690   unsigned char *finalkey = NULL;
1691   size_t finalkeylen;
1692   unsigned char grip[20];
1693   gcry_sexp_t openpgp_sexp = NULL;
1694   char *cache_nonce = NULL;
1695   char *p;
1696
1697   if (!ctrl->server_local->import_key)
1698     {
1699       err = gpg_error (GPG_ERR_MISSING_KEY);
1700       goto leave;
1701     }
1702
1703   p = line;
1704   for (p=line; *p && *p != ' ' && *p != '\t'; p++)
1705     ;
1706   *p = '\0';
1707   if (*line)
1708     cache_nonce = xtrystrdup (line);
1709
1710   assuan_begin_confidential (ctx);
1711   err = assuan_inquire (ctx, "KEYDATA",
1712                         &wrappedkey, &wrappedkeylen, MAXLEN_KEYDATA);
1713   assuan_end_confidential (ctx);
1714   if (err)
1715     goto leave;
1716   if (wrappedkeylen < 24)
1717     {
1718       err = gpg_error (GPG_ERR_INV_LENGTH);
1719       goto leave;
1720     }
1721   keylen = wrappedkeylen - 8;
1722   key = xtrymalloc_secure (keylen);
1723   if (!key)
1724     {
1725       err = gpg_error_from_syserror ();
1726       goto leave;
1727     }
1728
1729   err = gcry_cipher_open (&cipherhd, GCRY_CIPHER_AES128,
1730                           GCRY_CIPHER_MODE_AESWRAP, 0);
1731   if (err)
1732     goto leave;
1733   err = gcry_cipher_setkey (cipherhd,
1734                             ctrl->server_local->import_key, KEYWRAP_KEYSIZE);
1735   if (err)
1736     goto leave;
1737   err = gcry_cipher_decrypt (cipherhd, key, keylen, wrappedkey, wrappedkeylen);
1738   if (err)
1739     goto leave;
1740   gcry_cipher_close (cipherhd);
1741   cipherhd = NULL;
1742   xfree (wrappedkey);
1743   wrappedkey = NULL;
1744
1745   realkeylen = gcry_sexp_canon_len (key, keylen, NULL, &err);
1746   if (!realkeylen)
1747     goto leave; /* Invalid canonical encoded S-expression.  */
1748
1749   err = keygrip_from_canon_sexp (key, realkeylen, grip);
1750   if (err)
1751     {
1752       /* This might be due to an unsupported S-expression format.
1753          Check whether this is openpgp-private-key and trigger that
1754          import code.  */
1755       if (!gcry_sexp_sscan (&openpgp_sexp, NULL, key, realkeylen))
1756         {
1757           const char *tag;
1758           size_t taglen;
1759
1760           tag = gcry_sexp_nth_data (openpgp_sexp, 0, &taglen);
1761           if (tag && taglen == 19 && !memcmp (tag, "openpgp-private-key", 19))
1762             ;
1763           else
1764             {
1765               gcry_sexp_release (openpgp_sexp);
1766               openpgp_sexp = NULL;
1767             }
1768         }
1769       if (!openpgp_sexp)
1770         goto leave; /* Note that ERR is still set.  */
1771     }
1772
1773
1774   if (openpgp_sexp)
1775     {
1776       /* In most cases the key is encrypted and thus the conversion
1777          function from the OpenPGP format to our internal format will
1778          ask for a passphrase.  That passphrase will be returned and
1779          used to protect the key using the same code as for regular
1780          key import. */
1781
1782       err = convert_from_openpgp (ctrl, openpgp_sexp, grip,
1783                                   ctrl->server_local->keydesc, cache_nonce,
1784                                   &key, &passphrase);
1785       if (err)
1786         goto leave;
1787       realkeylen = gcry_sexp_canon_len (key, keylen, NULL, &err);
1788       if (!realkeylen)
1789         goto leave; /* Invalid canonical encoded S-expression.  */
1790       if (passphrase)
1791         {
1792           if (!cache_nonce)
1793             {
1794               char buf[12];
1795               gcry_create_nonce (buf, 12);
1796               cache_nonce = bin2hex (buf, 12, NULL);
1797             }
1798           if (cache_nonce
1799               && !agent_put_cache (cache_nonce, CACHE_MODE_NONCE,
1800                                    passphrase, 120 /*seconds*/))
1801             assuan_write_status (ctx, "CACHE_NONCE", cache_nonce);
1802         }
1803     }
1804   else
1805     {
1806       if (!agent_key_available (grip))
1807         err = gpg_error (GPG_ERR_EEXIST);
1808       else
1809         err = agent_ask_new_passphrase
1810           (ctrl, _("Please enter the passphrase to protect the "
1811                    "imported object within the GnuPG system."),
1812            &passphrase);
1813       if (err)
1814         goto leave;
1815     }
1816
1817   if (passphrase)
1818     {
1819       err = agent_protect (key, passphrase, &finalkey, &finalkeylen);
1820       if (!err)
1821         err = agent_write_private_key (grip, finalkey, finalkeylen, 0);
1822     }
1823   else
1824     err = agent_write_private_key (grip, key, realkeylen, 0);
1825
1826  leave:
1827   gcry_sexp_release (openpgp_sexp);
1828   xfree (finalkey);
1829   xfree (passphrase);
1830   xfree (key);
1831   gcry_cipher_close (cipherhd);
1832   xfree (wrappedkey);
1833   xfree (cache_nonce);
1834   xfree (ctrl->server_local->keydesc);
1835   ctrl->server_local->keydesc = NULL;
1836   return leave_cmd (ctx, err);
1837 }
1838
1839
1840 \f
1841 static const char hlp_export_key[] =
1842   "EXPORT_KEY [--cache-nonce=<nonce>] [--openpgp] <hexstring_with_keygrip>\n"
1843   "\n"
1844   "Export a secret key from the key store.  The key will be encrypted\n"
1845   "using the current session's key wrapping key (cf. command KEYWRAP_KEY)\n"
1846   "using the AESWRAP-128 algorithm.  The caller needs to retrieve that key\n"
1847   "prior to using this command.  The function takes the keygrip as argument.\n";
1848 static gpg_error_t
1849 cmd_export_key (assuan_context_t ctx, char *line)
1850 {
1851   ctrl_t ctrl = assuan_get_pointer (ctx);
1852   gpg_error_t err;
1853   unsigned char grip[20];
1854   gcry_sexp_t s_skey = NULL;
1855   unsigned char *key = NULL;
1856   size_t keylen;
1857   gcry_cipher_hd_t cipherhd = NULL;
1858   unsigned char *wrappedkey = NULL;
1859   size_t wrappedkeylen;
1860   int openpgp;
1861   char *cache_nonce;
1862   char *passphrase = NULL;
1863
1864   openpgp = has_option (line, "--openpgp");
1865   cache_nonce = option_value (line, "--cache-nonce");
1866   if (cache_nonce)
1867     {
1868       for (; *line && !spacep (line); line++)
1869         ;
1870       if (*line)
1871         *line++ = '\0';
1872       cache_nonce = xtrystrdup (cache_nonce);
1873       if (!cache_nonce)
1874         {
1875           err = gpg_error_from_syserror ();
1876           goto leave;
1877         }
1878     }
1879   line = skip_options (line);
1880
1881   if (!ctrl->server_local->export_key)
1882     {
1883       err = gpg_error (GPG_ERR_MISSING_KEY);
1884       goto leave;
1885     }
1886
1887   err = parse_keygrip (ctx, line, grip);
1888   if (err)
1889     goto leave;
1890
1891   if (agent_key_available (grip))
1892     {
1893       err = gpg_error (GPG_ERR_NO_SECKEY);
1894       goto leave;
1895     }
1896
1897   /* Get the key from the file.  With the openpgp flag we also ask for
1898      the passphrase so that we can use it to re-encrypt it.  */
1899   err = agent_key_from_file (ctrl, NULL, ctrl->server_local->keydesc, grip,
1900                              NULL, CACHE_MODE_IGNORE, NULL, &s_skey,
1901                              openpgp ? &passphrase : NULL);
1902   if (err)
1903     goto leave;
1904   if (!s_skey)
1905     {
1906       /* Key is on a smartcard.  Actually we should not see this here
1907          because we do not pass a shadow_info variable to the above
1908          function, thus it will return this error directly.  */
1909       err = gpg_error (GPG_ERR_UNUSABLE_SECKEY);
1910       goto leave;
1911     }
1912
1913   if (openpgp)
1914     {
1915       /* The openpgp option changes the key format into the OpenPGP
1916          key transfer format.  The result is already a padded
1917          canonical S-expression.  */
1918       if (!passphrase)
1919         {
1920           err = agent_ask_new_passphrase
1921             (ctrl, _("This key (or subkey) is not protected with a passphrase."
1922                      "  Please enter a new passphrase to export it."),
1923              &passphrase);
1924           if (err)
1925             goto leave;
1926         }
1927       err = convert_to_openpgp (ctrl, s_skey, passphrase, &key, &keylen);
1928     }
1929   else
1930     {
1931       /* Convert into a canonical S-expression and wrap that.  */
1932       err = make_canon_sexp_pad (s_skey, 1, &key, &keylen);
1933     }
1934   if (err)
1935     goto leave;
1936   gcry_sexp_release (s_skey);
1937   s_skey = NULL;
1938
1939   err = gcry_cipher_open (&cipherhd, GCRY_CIPHER_AES128,
1940                           GCRY_CIPHER_MODE_AESWRAP, 0);
1941   if (err)
1942     goto leave;
1943   err = gcry_cipher_setkey (cipherhd,
1944                             ctrl->server_local->export_key, KEYWRAP_KEYSIZE);
1945   if (err)
1946     goto leave;
1947
1948   wrappedkeylen = keylen + 8;
1949   wrappedkey = xtrymalloc (wrappedkeylen);
1950   if (!wrappedkey)
1951     {
1952       err = gpg_error_from_syserror ();
1953       goto leave;
1954     }
1955
1956   err = gcry_cipher_encrypt (cipherhd, wrappedkey, wrappedkeylen, key, keylen);
1957   if (err)
1958     goto leave;
1959   xfree (key);
1960   key = NULL;
1961   gcry_cipher_close (cipherhd);
1962   cipherhd = NULL;
1963
1964   assuan_begin_confidential (ctx);
1965   err = assuan_send_data (ctx, wrappedkey, wrappedkeylen);
1966   assuan_end_confidential (ctx);
1967
1968
1969  leave:
1970   xfree (cache_nonce);
1971   xfree (passphrase);
1972   xfree (wrappedkey);
1973   gcry_cipher_close (cipherhd);
1974   xfree (key);
1975   gcry_sexp_release (s_skey);
1976   xfree (ctrl->server_local->keydesc);
1977   ctrl->server_local->keydesc = NULL;
1978
1979   return leave_cmd (ctx, err);
1980 }
1981
1982
1983
1984 \f
1985 static const char hlp_getval[] =
1986   "GETVAL <key>\n"
1987   "\n"
1988   "Return the value for KEY from the special environment as created by\n"
1989   "PUTVAL.";
1990 static gpg_error_t
1991 cmd_getval (assuan_context_t ctx, char *line)
1992 {
1993   int rc = 0;
1994   char *key = NULL;
1995   char *p;
1996   struct putval_item_s *vl;
1997
1998   for (p=line; *p == ' '; p++)
1999     ;
2000   key = p;
2001   p = strchr (key, ' ');
2002   if (p)
2003     {
2004       *p++ = 0;
2005       for (; *p == ' '; p++)
2006         ;
2007       if (*p)
2008         return set_error (GPG_ERR_ASS_PARAMETER, "too many arguments");
2009     }
2010   if (!key || !*key)
2011     return set_error (GPG_ERR_ASS_PARAMETER, "no key given");
2012
2013
2014   for (vl=putval_list; vl; vl = vl->next)
2015     if ( !strcmp (vl->d, key) )
2016       break;
2017
2018   if (vl) /* Got an entry. */
2019     rc = assuan_send_data (ctx, vl->d+vl->off, vl->len);
2020   else
2021     return gpg_error (GPG_ERR_NO_DATA);
2022
2023   return leave_cmd (ctx, rc);
2024 }
2025
2026
2027 static const char hlp_putval[] =
2028   "PUTVAL <key> [<percent_escaped_value>]\n"
2029   "\n"
2030   "The gpg-agent maintains a kind of environment which may be used to\n"
2031   "store key/value pairs in it, so that they can be retrieved later.\n"
2032   "This may be used by helper daemons to daemonize themself on\n"
2033   "invocation and register them with gpg-agent.  Callers of the\n"
2034   "daemon's service may now first try connect to get the information\n"
2035   "for that service from gpg-agent through the GETVAL command and then\n"
2036   "try to connect to that daemon.  Only if that fails they may start\n"
2037   "an own instance of the service daemon. \n"
2038   "\n"
2039   "KEY is an an arbitrary symbol with the same syntax rules as keys\n"
2040   "for shell environment variables.  PERCENT_ESCAPED_VALUE is the\n"
2041   "corresponsing value; they should be similar to the values of\n"
2042   "envronment variables but gpg-agent does not enforce any\n"
2043   "restrictions.  If that value is not given any value under that KEY\n"
2044   "is removed from this special environment.";
2045 static gpg_error_t
2046 cmd_putval (assuan_context_t ctx, char *line)
2047 {
2048   int rc = 0;
2049   char *key = NULL;
2050   char *value = NULL;
2051   size_t valuelen = 0;
2052   char *p;
2053   struct putval_item_s *vl, *vlprev;
2054
2055   for (p=line; *p == ' '; p++)
2056     ;
2057   key = p;
2058   p = strchr (key, ' ');
2059   if (p)
2060     {
2061       *p++ = 0;
2062       for (; *p == ' '; p++)
2063         ;
2064       if (*p)
2065         {
2066           value = p;
2067           p = strchr (value, ' ');
2068           if (p)
2069             *p = 0;
2070           valuelen = percent_plus_unescape_inplace (value, 0);
2071         }
2072     }
2073   if (!key || !*key)
2074     return set_error (GPG_ERR_ASS_PARAMETER, "no key given");
2075
2076
2077   for (vl=putval_list,vlprev=NULL; vl; vlprev=vl, vl = vl->next)
2078     if ( !strcmp (vl->d, key) )
2079       break;
2080
2081   if (vl) /* Delete old entry. */
2082     {
2083       if (vlprev)
2084         vlprev->next = vl->next;
2085       else
2086         putval_list = vl->next;
2087       xfree (vl);
2088     }
2089
2090   if (valuelen) /* Add entry. */
2091     {
2092       vl = xtrymalloc (sizeof *vl + strlen (key) + valuelen);
2093       if (!vl)
2094         rc = gpg_error_from_syserror ();
2095       else
2096         {
2097           vl->len = valuelen;
2098           vl->off = strlen (key) + 1;
2099           strcpy (vl->d, key);
2100           memcpy (vl->d + vl->off, value, valuelen);
2101           vl->next = putval_list;
2102           putval_list = vl;
2103         }
2104     }
2105
2106   return leave_cmd (ctx, rc);
2107 }
2108
2109
2110
2111 \f
2112 static const char hlp_updatestartuptty[] =
2113   "UPDATESTARTUPTTY\n"
2114   "\n"
2115   "Set startup TTY and X11 DISPLAY variables to the values of this\n"
2116   "session.  This command is useful to pull future pinentries to\n"
2117   "another screen.  It is only required because there is no way in the\n"
2118   "ssh-agent protocol to convey this information.";
2119 static gpg_error_t
2120 cmd_updatestartuptty (assuan_context_t ctx, char *line)
2121 {
2122   static const char *names[] =
2123     { "GPG_TTY", "DISPLAY", "TERM", "XAUTHORITY", "PINENTRY_USER_DATA", NULL };
2124   ctrl_t ctrl = assuan_get_pointer (ctx);
2125   gpg_error_t err = 0;
2126   session_env_t se;
2127   int idx;
2128   char *lc_ctype = NULL;
2129   char *lc_messages = NULL;
2130
2131   (void)line;
2132
2133   se = session_env_new ();
2134   if (!se)
2135     err = gpg_error_from_syserror ();
2136
2137   for (idx=0; !err && names[idx]; idx++)
2138     {
2139       const char *value = session_env_getenv (ctrl->session_env, names[idx]);
2140       if (value)
2141         err = session_env_setenv (se, names[idx], value);
2142     }
2143
2144   if (!err && ctrl->lc_ctype)
2145     if (!(lc_ctype = xtrystrdup (ctrl->lc_ctype)))
2146       err = gpg_error_from_syserror ();
2147
2148   if (!err && ctrl->lc_messages)
2149     if (!(lc_messages = xtrystrdup (ctrl->lc_messages)))
2150       err = gpg_error_from_syserror ();
2151
2152   if (err)
2153     {
2154       session_env_release (se);
2155       xfree (lc_ctype);
2156       xfree (lc_messages);
2157     }
2158   else
2159     {
2160       session_env_release (opt.startup_env);
2161       opt.startup_env = se;
2162       xfree (opt.startup_lc_ctype);
2163       opt.startup_lc_ctype = lc_ctype;
2164       xfree (opt.startup_lc_messages);
2165       opt.startup_lc_messages = lc_messages;
2166     }
2167
2168   return err;
2169 }
2170
2171
2172 \f
2173 static const char hlp_killagent[] =
2174   "KILLAGENT\n"
2175   "\n"
2176   "If the agent has been started using a standard socket\n"
2177   "we allow a client to stop the agent.";
2178 static gpg_error_t
2179 cmd_killagent (assuan_context_t ctx, char *line)
2180 {
2181   ctrl_t ctrl = assuan_get_pointer (ctx);
2182
2183   (void)line;
2184
2185   if (!opt.use_standard_socket)
2186     return set_error (GPG_ERR_NOT_SUPPORTED, "no --use-standard-socket");
2187
2188   ctrl->server_local->stopme = 1;
2189   return gpg_error (GPG_ERR_EOF);
2190 }
2191
2192
2193 static const char hlp_reloadagent[] =
2194   "RELOADAGENT\n"
2195   "\n"
2196   "This command is an alternative to SIGHUP\n"
2197   "to reload the configuration.";
2198 static gpg_error_t
2199 cmd_reloadagent (assuan_context_t ctx, char *line)
2200 {
2201   (void)ctx;
2202   (void)line;
2203
2204   agent_sighup_action ();
2205   return 0;
2206 }
2207
2208
2209 \f
2210 static const char hlp_getinfo[] =
2211   "GETINFO <what>\n"
2212   "\n"
2213   "Multipurpose function to return a variety of information.\n"
2214   "Supported values for WHAT are:\n"
2215   "\n"
2216   "  version     - Return the version of the program.\n"
2217   "  pid         - Return the process id of the server.\n"
2218   "  socket_name - Return the name of the socket.\n"
2219   "  ssh_socket_name - Return the name of the ssh socket.\n"
2220   "  scd_running - Return OK if the SCdaemon is already running.\n"
2221   "  s2k_count   - Return the calibrated S2K count.\n"
2222   "  std_session_env - List the standard session environment.\n"
2223   "  std_startup_env - List the standard startup environment.\n"
2224   "  cmd_has_option\n"
2225   "              - Returns OK if the command CMD implements the option OPT\n.";
2226 static gpg_error_t
2227 cmd_getinfo (assuan_context_t ctx, char *line)
2228 {
2229   ctrl_t ctrl = assuan_get_pointer (ctx);
2230   int rc = 0;
2231
2232   if (!strcmp (line, "version"))
2233     {
2234       const char *s = VERSION;
2235       rc = assuan_send_data (ctx, s, strlen (s));
2236     }
2237   else if (!strcmp (line, "pid"))
2238     {
2239       char numbuf[50];
2240
2241       snprintf (numbuf, sizeof numbuf, "%lu", (unsigned long)getpid ());
2242       rc = assuan_send_data (ctx, numbuf, strlen (numbuf));
2243     }
2244   else if (!strcmp (line, "socket_name"))
2245     {
2246       const char *s = get_agent_socket_name ();
2247
2248       if (s)
2249         rc = assuan_send_data (ctx, s, strlen (s));
2250       else
2251         rc = gpg_error (GPG_ERR_NO_DATA);
2252     }
2253   else if (!strcmp (line, "ssh_socket_name"))
2254     {
2255       const char *s = get_agent_ssh_socket_name ();
2256
2257       if (s)
2258         rc = assuan_send_data (ctx, s, strlen (s));
2259       else
2260         rc = gpg_error (GPG_ERR_NO_DATA);
2261     }
2262   else if (!strcmp (line, "scd_running"))
2263     {
2264       rc = agent_scd_check_running ()? 0 : gpg_error (GPG_ERR_GENERAL);
2265     }
2266   else if (!strcmp (line, "s2k_count"))
2267     {
2268       char numbuf[50];
2269
2270       snprintf (numbuf, sizeof numbuf, "%lu", get_standard_s2k_count ());
2271       rc = assuan_send_data (ctx, numbuf, strlen (numbuf));
2272     }
2273   else if (!strcmp (line, "std_session_env")
2274            || !strcmp (line, "std_startup_env"))
2275     {
2276       int iterator;
2277       const char *name, *value;
2278       char *string;
2279
2280       iterator = 0;
2281       while ((name = session_env_list_stdenvnames (&iterator, NULL)))
2282         {
2283           value = session_env_getenv_or_default
2284             (line[5] == 't'? opt.startup_env:ctrl->session_env, name, NULL);
2285           if (value)
2286             {
2287               string = xtryasprintf ("%s=%s", name, value);
2288               if (!string)
2289                 rc = gpg_error_from_syserror ();
2290               else
2291                 {
2292                   rc = assuan_send_data (ctx, string, strlen (string)+1);
2293                   if (!rc)
2294                     rc = assuan_send_data (ctx, NULL, 0);
2295                 }
2296               if (rc)
2297                 break;
2298             }
2299         }
2300     }
2301   else if (!strncmp (line, "cmd_has_option", 14)
2302            && (line[14] == ' ' || line[14] == '\t' || !line[14]))
2303     {
2304       char *cmd, *cmdopt;
2305       line += 14;
2306       while (*line == ' ' || *line == '\t')
2307         line++;
2308       if (!*line)
2309         rc = gpg_error (GPG_ERR_MISSING_VALUE);
2310       else
2311         {
2312           cmd = line;
2313           while (*line && (*line != ' ' && *line != '\t'))
2314             line++;
2315           if (!*line)
2316             rc = gpg_error (GPG_ERR_MISSING_VALUE);
2317           else
2318             {
2319               *line++ = 0;
2320               while (*line == ' ' || *line == '\t')
2321                 line++;
2322               if (!*line)
2323                 rc = gpg_error (GPG_ERR_MISSING_VALUE);
2324               else
2325                 {
2326                   cmdopt = line;
2327                   if (!command_has_option (cmd, cmdopt))
2328                     rc = gpg_error (GPG_ERR_GENERAL);
2329                 }
2330             }
2331         }
2332     }
2333   else
2334     rc = set_error (GPG_ERR_ASS_PARAMETER, "unknown value for WHAT");
2335   return rc;
2336 }
2337
2338
2339 \f
2340 static gpg_error_t
2341 option_handler (assuan_context_t ctx, const char *key, const char *value)
2342 {
2343   ctrl_t ctrl = assuan_get_pointer (ctx);
2344   gpg_error_t err = 0;
2345
2346   if (!strcmp (key, "agent-awareness"))
2347     {
2348       /* The value is a version string telling us of which agent
2349          version the caller is aware of.  */
2350       ctrl->server_local->allow_fully_canceled =
2351         gnupg_compare_version (value, "2.1.0");
2352     }
2353   else if (!strcmp (key, "putenv"))
2354     {
2355       /* Change the session's environment to be used for the
2356          Pinentry.  Valid values are:
2357           <NAME>            Delete envvar NAME
2358           <KEY>=            Set envvar NAME to the empty string
2359           <KEY>=<VALUE>     Set envvar NAME to VALUE
2360       */
2361       err = session_env_putenv (ctrl->session_env, value);
2362     }
2363   else if (!strcmp (key, "display"))
2364     {
2365       err = session_env_setenv (ctrl->session_env, "DISPLAY", value);
2366     }
2367   else if (!strcmp (key, "ttyname"))
2368     {
2369       if (!opt.keep_tty)
2370         err = session_env_setenv (ctrl->session_env, "GPG_TTY", value);
2371     }
2372   else if (!strcmp (key, "ttytype"))
2373     {
2374       if (!opt.keep_tty)
2375         err = session_env_setenv (ctrl->session_env, "TERM", value);
2376     }
2377   else if (!strcmp (key, "lc-ctype"))
2378     {
2379       if (ctrl->lc_ctype)
2380         xfree (ctrl->lc_ctype);
2381       ctrl->lc_ctype = xtrystrdup (value);
2382       if (!ctrl->lc_ctype)
2383         return out_of_core ();
2384     }
2385   else if (!strcmp (key, "lc-messages"))
2386     {
2387       if (ctrl->lc_messages)
2388         xfree (ctrl->lc_messages);
2389       ctrl->lc_messages = xtrystrdup (value);
2390       if (!ctrl->lc_messages)
2391         return out_of_core ();
2392     }
2393   else if (!strcmp (key, "xauthority"))
2394     {
2395       err = session_env_setenv (ctrl->session_env, "XAUTHORITY", value);
2396     }
2397   else if (!strcmp (key, "pinentry-user-data"))
2398     {
2399       err = session_env_setenv (ctrl->session_env, "PINENTRY_USER_DATA", value);
2400     }
2401   else if (!strcmp (key, "use-cache-for-signing"))
2402     ctrl->server_local->use_cache_for_signing = *value? atoi (value) : 0;
2403   else if (!strcmp (key, "allow-pinentry-notify"))
2404     ctrl->server_local->allow_pinentry_notify = 1;
2405   else
2406     err = gpg_error (GPG_ERR_UNKNOWN_OPTION);
2407
2408   return err;
2409 }
2410
2411
2412
2413 \f
2414 /* Called by libassuan after all commands. ERR is the error from the
2415    last assuan operation and not the one returned from the command. */
2416 static void
2417 post_cmd_notify (assuan_context_t ctx, gpg_error_t err)
2418 {
2419   ctrl_t ctrl = assuan_get_pointer (ctx);
2420
2421   (void)err;
2422
2423   /* Switch off any I/O monitor controlled logging pausing. */
2424   ctrl->server_local->pause_io_logging = 0;
2425 }
2426
2427
2428 /* This function is called by libassuan for all I/O.  We use it here
2429    to disable logging for the GETEVENTCOUNTER commands.  This is so
2430    that the debug output won't get cluttered by this primitive
2431    command.  */
2432 static unsigned int
2433 io_monitor (assuan_context_t ctx, void *hook, int direction,
2434             const char *line, size_t linelen)
2435 {
2436   ctrl_t ctrl = assuan_get_pointer (ctx);
2437
2438   (void) hook;
2439
2440   /* Note that we only check for the uppercase name.  This allows to
2441      see the logging for debugging if using a non-upercase command
2442      name. */
2443   if (ctx && direction == ASSUAN_IO_FROM_PEER
2444       && linelen >= 15
2445       && !strncmp (line, "GETEVENTCOUNTER", 15)
2446       && (linelen == 15 || spacep (line+15)))
2447     {
2448       ctrl->server_local->pause_io_logging = 1;
2449     }
2450
2451   return ctrl->server_local->pause_io_logging? ASSUAN_IO_MONITOR_NOLOG : 0;
2452 }
2453
2454
2455 /* Return true if the command CMD implements the option OPT.  */
2456 static int
2457 command_has_option (const char *cmd, const char *cmdopt)
2458 {
2459   if (!strcmp (cmd, "GET_PASSPHRASE"))
2460     {
2461       if (!strcmp (cmdopt, "repeat"))
2462           return 1;
2463     }
2464
2465   return 0;
2466 }
2467
2468
2469 /* Tell the assuan library about our commands */
2470 static int
2471 register_commands (assuan_context_t ctx)
2472 {
2473   static struct {
2474     const char *name;
2475     assuan_handler_t handler;
2476     const char * const help;
2477   } table[] = {
2478     { "GETEVENTCOUNTER",cmd_geteventcounter, hlp_geteventcounter },
2479     { "ISTRUSTED",      cmd_istrusted, hlp_istrusted },
2480     { "HAVEKEY",        cmd_havekey,   hlp_havekey },
2481     { "KEYINFO",        cmd_keyinfo,   hlp_keyinfo },
2482     { "SIGKEY",         cmd_sigkey,    hlp_sigkey },
2483     { "SETKEY",         cmd_sigkey,    hlp_sigkey },
2484     { "SETKEYDESC",     cmd_setkeydesc,hlp_setkeydesc },
2485     { "SETHASH",        cmd_sethash,   hlp_sethash },
2486     { "PKSIGN",         cmd_pksign,    hlp_pksign },
2487     { "PKDECRYPT",      cmd_pkdecrypt, hlp_pkdecrypt },
2488     { "GENKEY",         cmd_genkey,    hlp_genkey },
2489     { "READKEY",        cmd_readkey,   hlp_readkey },
2490     { "GET_PASSPHRASE", cmd_get_passphrase, hlp_get_passphrase },
2491     { "PRESET_PASSPHRASE", cmd_preset_passphrase, hlp_preset_passphrase },
2492     { "CLEAR_PASSPHRASE", cmd_clear_passphrase,   hlp_clear_passphrase },
2493     { "GET_CONFIRMATION", cmd_get_confirmation,   hlp_get_confirmation },
2494     { "LISTTRUSTED",    cmd_listtrusted, hlp_listtrusted },
2495     { "MARKTRUSTED",    cmd_marktrusted, hlp_martrusted },
2496     { "LEARN",          cmd_learn,     hlp_learn },
2497     { "PASSWD",         cmd_passwd,    hlp_passwd },
2498     { "INPUT",          NULL },
2499     { "OUTPUT",         NULL },
2500     { "SCD",            cmd_scd,       hlp_scd },
2501     { "KEYWRAP_KEY",    cmd_keywrap_key, hlp_keywrap_key },
2502     { "IMPORT_KEY",     cmd_import_key, hlp_import_key },
2503     { "EXPORT_KEY",     cmd_export_key, hlp_export_key },
2504     { "GETVAL",         cmd_getval,    hlp_getval },
2505     { "PUTVAL",         cmd_putval,    hlp_putval },
2506     { "UPDATESTARTUPTTY",  cmd_updatestartuptty, hlp_updatestartuptty },
2507     { "KILLAGENT",      cmd_killagent,  hlp_killagent },
2508     { "RELOADAGENT",    cmd_reloadagent,hlp_reloadagent },
2509     { "GETINFO",        cmd_getinfo,   hlp_getinfo },
2510     { NULL }
2511   };
2512   int i, rc;
2513
2514   for (i=0; table[i].name; i++)
2515     {
2516       rc = assuan_register_command (ctx, table[i].name, table[i].handler,
2517                                     table[i].help);
2518       if (rc)
2519         return rc;
2520     }
2521   assuan_register_post_cmd_notify (ctx, post_cmd_notify);
2522   assuan_register_reset_notify (ctx, reset_notify);
2523   assuan_register_option_handler (ctx, option_handler);
2524   return 0;
2525 }
2526
2527
2528 /* Startup the server.  If LISTEN_FD and FD is given as -1, this is a
2529    simple piper server, otherwise it is a regular server.  CTRL is the
2530    control structure for this connection; it has only the basic
2531    intialization. */
2532 void
2533 start_command_handler (ctrl_t ctrl, gnupg_fd_t listen_fd, gnupg_fd_t fd)
2534 {
2535   int rc;
2536   assuan_context_t ctx = NULL;
2537
2538   rc = assuan_new (&ctx);
2539   if (rc)
2540     {
2541       log_error ("failed to allocate assuan context: %s\n", gpg_strerror (rc));
2542       agent_exit (2);
2543     }
2544
2545   if (listen_fd == GNUPG_INVALID_FD && fd == GNUPG_INVALID_FD)
2546     {
2547       assuan_fd_t filedes[2];
2548
2549       filedes[0] = assuan_fdopen (0);
2550       filedes[1] = assuan_fdopen (1);
2551       rc = assuan_init_pipe_server (ctx, filedes);
2552     }
2553   else if (listen_fd != GNUPG_INVALID_FD)
2554     {
2555       rc = assuan_init_socket_server (ctx, listen_fd, 0);
2556       /* FIXME: Need to call assuan_sock_set_nonce for Windows.  But
2557          this branch is currently not used.  */
2558     }
2559   else
2560     {
2561       rc = assuan_init_socket_server (ctx, fd, ASSUAN_SOCKET_SERVER_ACCEPTED);
2562     }
2563   if (rc)
2564     {
2565       log_error ("failed to initialize the server: %s\n",
2566                  gpg_strerror(rc));
2567       agent_exit (2);
2568     }
2569   rc = register_commands (ctx);
2570   if (rc)
2571     {
2572       log_error ("failed to register commands with Assuan: %s\n",
2573                  gpg_strerror(rc));
2574       agent_exit (2);
2575     }
2576
2577   assuan_set_pointer (ctx, ctrl);
2578   ctrl->server_local = xcalloc (1, sizeof *ctrl->server_local);
2579   ctrl->server_local->assuan_ctx = ctx;
2580   ctrl->server_local->message_fd = -1;
2581   ctrl->server_local->use_cache_for_signing = 1;
2582   ctrl->digest.raw_value = 0;
2583
2584   assuan_set_io_monitor (ctx, io_monitor, NULL);
2585
2586   for (;;)
2587     {
2588       rc = assuan_accept (ctx);
2589       if (gpg_err_code (rc) == GPG_ERR_EOF || rc == -1)
2590         {
2591           break;
2592         }
2593       else if (rc)
2594         {
2595           log_info ("Assuan accept problem: %s\n", gpg_strerror (rc));
2596           break;
2597         }
2598
2599       rc = assuan_process (ctx);
2600       if (rc)
2601         {
2602           log_info ("Assuan processing failed: %s\n", gpg_strerror (rc));
2603           continue;
2604         }
2605     }
2606
2607   /* Reset the nonce caches.  */
2608   clear_nonce_cache (ctrl);
2609
2610   /* Reset the SCD if needed. */
2611   agent_reset_scd (ctrl);
2612
2613   /* Reset the pinentry (in case of popup messages). */
2614   agent_reset_query (ctrl);
2615
2616   /* Cleanup.  */
2617   assuan_release (ctx);
2618   xfree (ctrl->server_local->keydesc);
2619   xfree (ctrl->server_local->import_key);
2620   xfree (ctrl->server_local->export_key);
2621   if (ctrl->server_local->stopme)
2622     agent_exit (0);
2623   xfree (ctrl->server_local);
2624   ctrl->server_local = NULL;
2625 }