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