gpg: Make keyserver-option http_proxy work.
[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);
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               if (rc)
1541                 break;
1542               if (strcmp (response2, response))
1543                 {
1544                   xfree (response2);
1545                   xfree (response);
1546                   repeat_errtext = try_percent_escape
1547                     (_("does not match - try again"), NULL);
1548                   if (!repeat_errtext)
1549                     {
1550                       rc = gpg_error_from_syserror ();
1551                       break;
1552                     }
1553                   goto next_try;
1554                 }
1555               xfree (response2);
1556             }
1557           if (!rc)
1558             {
1559               if (cacheid)
1560                 agent_put_cache (cacheid, CACHE_MODE_USER, response, 0);
1561               rc = send_back_passphrase (ctx, opt_data, response);
1562             }
1563           xfree (response);
1564         }
1565     }
1566
1567   return leave_cmd (ctx, rc);
1568 }
1569
1570
1571 static const char hlp_clear_passphrase[] =
1572   "CLEAR_PASSPHRASE [--mode=normal] <cache_id>\n"
1573   "\n"
1574   "may be used to invalidate the cache entry for a passphrase.  The\n"
1575   "function returns with OK even when there is no cached passphrase.\n"
1576   "The --mode=normal option is used to clear an entry for a cacheid\n"
1577   "added by the agent.\n";
1578 static gpg_error_t
1579 cmd_clear_passphrase (assuan_context_t ctx, char *line)
1580 {
1581   ctrl_t ctrl = assuan_get_pointer (ctx);
1582   char *cacheid = NULL;
1583   char *p;
1584   int opt_normal;
1585
1586   if (ctrl->restricted)
1587     return leave_cmd (ctx, gpg_error (GPG_ERR_FORBIDDEN));
1588
1589   opt_normal = has_option (line, "--mode=normal");
1590   line = skip_options (line);
1591
1592   /* parse the stuff */
1593   for (p=line; *p == ' '; p++)
1594     ;
1595   cacheid = p;
1596   p = strchr (cacheid, ' ');
1597   if (p)
1598     *p = 0; /* ignore garbage */
1599   if (!*cacheid || strlen (cacheid) > 50)
1600     return set_error (GPG_ERR_ASS_PARAMETER, "invalid length of cacheID");
1601
1602   agent_put_cache (cacheid, opt_normal ? CACHE_MODE_NORMAL : CACHE_MODE_USER,
1603                    NULL, 0);
1604   return 0;
1605 }
1606
1607
1608 static const char hlp_get_confirmation[] =
1609   "GET_CONFIRMATION <description>\n"
1610   "\n"
1611   "This command may be used to ask for a simple confirmation.\n"
1612   "DESCRIPTION is displayed along with a Okay and Cancel button.  This\n"
1613   "command uses a syntax which helps clients to use the agent with\n"
1614   "minimum effort.  The agent either returns with an error or with a\n"
1615   "OK.  Note, that the length of DESCRIPTION is implicitly limited by\n"
1616   "the maximum length of a command. DESCRIPTION should not contain\n"
1617   "any spaces, those must be encoded either percent escaped or simply\n"
1618   "as '+'.";
1619 static gpg_error_t
1620 cmd_get_confirmation (assuan_context_t ctx, char *line)
1621 {
1622   ctrl_t ctrl = assuan_get_pointer (ctx);
1623   int rc;
1624   char *desc = NULL;
1625   char *p;
1626
1627   if (ctrl->restricted)
1628     return leave_cmd (ctx, gpg_error (GPG_ERR_FORBIDDEN));
1629
1630   /* parse the stuff */
1631   for (p=line; *p == ' '; p++)
1632     ;
1633   desc = p;
1634   p = strchr (desc, ' ');
1635   if (p)
1636     *p = 0; /* We ignore any garbage -may be later used for other args. */
1637
1638   if (!*desc)
1639     return set_error (GPG_ERR_ASS_PARAMETER, "no description given");
1640
1641   if (!strcmp (desc, "X"))
1642     desc = NULL;
1643
1644   /* Note, that we only need to replace the + characters and should
1645      leave the other escaping in place because the escaped string is
1646      send verbatim to the pinentry which does the unescaping (but not
1647      the + replacing) */
1648   if (desc)
1649     plus_to_blank (desc);
1650
1651   rc = agent_get_confirmation (ctrl, desc, NULL, NULL, 0);
1652   return leave_cmd (ctx, rc);
1653 }
1654
1655
1656 \f
1657 static const char hlp_learn[] =
1658   "LEARN [--send] [--sendinfo] [--force]\n"
1659   "\n"
1660   "Learn something about the currently inserted smartcard.  With\n"
1661   "--sendinfo information about the card is returned; with --send\n"
1662   "the available certificates are returned as D lines; with --force\n"
1663   "private key storage will be updated by the result.";
1664 static gpg_error_t
1665 cmd_learn (assuan_context_t ctx, char *line)
1666 {
1667   ctrl_t ctrl = assuan_get_pointer (ctx);
1668   gpg_error_t err;
1669   int send, sendinfo, force;
1670
1671   send = has_option (line, "--send");
1672   sendinfo = send? 1 : has_option (line, "--sendinfo");
1673   force = has_option (line, "--force");
1674
1675   if (ctrl->restricted)
1676     return leave_cmd (ctx, gpg_error (GPG_ERR_FORBIDDEN));
1677
1678   err = agent_handle_learn (ctrl, send, sendinfo? ctx : NULL, force);
1679   return leave_cmd (ctx, err);
1680 }
1681
1682
1683 \f
1684 static const char hlp_passwd[] =
1685   "PASSWD [--cache-nonce=<c>] [--passwd-nonce=<s>] [--preset] <hexkeygrip>\n"
1686   "\n"
1687   "Change the passphrase/PIN for the key identified by keygrip in LINE. When\n"
1688   "--preset is used then the new passphrase will be added to the cache.\n";
1689 static gpg_error_t
1690 cmd_passwd (assuan_context_t ctx, char *line)
1691 {
1692   ctrl_t ctrl = assuan_get_pointer (ctx);
1693   gpg_error_t err;
1694   int c;
1695   char *cache_nonce = NULL;
1696   char *passwd_nonce = NULL;
1697   unsigned char grip[20];
1698   gcry_sexp_t s_skey = NULL;
1699   unsigned char *shadow_info = NULL;
1700   char *passphrase = NULL;
1701   char *pend;
1702   int opt_preset;
1703
1704   if (ctrl->restricted)
1705     return leave_cmd (ctx, gpg_error (GPG_ERR_FORBIDDEN));
1706
1707   opt_preset = has_option (line, "--preset");
1708   cache_nonce = option_value (line, "--cache-nonce");
1709   if (cache_nonce)
1710     {
1711       for (pend = cache_nonce; *pend && !spacep (pend); pend++)
1712         ;
1713       c = *pend;
1714       *pend = '\0';
1715       cache_nonce = xtrystrdup (cache_nonce);
1716       *pend = c;
1717       if (!cache_nonce)
1718         {
1719           err = gpg_error_from_syserror ();
1720           goto leave;
1721         }
1722     }
1723
1724   passwd_nonce = option_value (line, "--passwd-nonce");
1725   if (passwd_nonce)
1726     {
1727       for (pend = passwd_nonce; *pend && !spacep (pend); pend++)
1728         ;
1729       c = *pend;
1730       *pend = '\0';
1731       passwd_nonce = xtrystrdup (passwd_nonce);
1732       *pend = c;
1733       if (!passwd_nonce)
1734         {
1735           err = gpg_error_from_syserror ();
1736           goto leave;
1737         }
1738     }
1739
1740   line = skip_options (line);
1741
1742   err = parse_keygrip (ctx, line, grip);
1743   if (err)
1744     goto leave;
1745
1746   ctrl->in_passwd++;
1747   err = agent_key_from_file (ctrl, cache_nonce, ctrl->server_local->keydesc,
1748                              grip, &shadow_info, CACHE_MODE_IGNORE, NULL,
1749                              &s_skey, &passphrase);
1750   if (err)
1751     ;
1752   else if (shadow_info)
1753     {
1754       log_error ("changing a smartcard PIN is not yet supported\n");
1755       err = gpg_error (GPG_ERR_NOT_IMPLEMENTED);
1756     }
1757   else
1758     {
1759       char *newpass = NULL;
1760
1761       if (passwd_nonce)
1762         newpass = agent_get_cache (passwd_nonce, CACHE_MODE_NONCE);
1763       err = agent_protect_and_store (ctrl, s_skey, &newpass);
1764       if (!err && passphrase)
1765         {
1766           /* A passphrase existed on the old key and the change was
1767              successful.  Return a nonce for that old passphrase to
1768              let the caller try to unprotect the other subkeys with
1769              the same key.  */
1770           if (!cache_nonce)
1771             {
1772               char buf[12];
1773               gcry_create_nonce (buf, 12);
1774               cache_nonce = bin2hex (buf, 12, NULL);
1775             }
1776           if (cache_nonce
1777               && !agent_put_cache (cache_nonce, CACHE_MODE_NONCE,
1778                                    passphrase, CACHE_TTL_NONCE))
1779             {
1780               assuan_write_status (ctx, "CACHE_NONCE", cache_nonce);
1781               xfree (ctrl->server_local->last_cache_nonce);
1782               ctrl->server_local->last_cache_nonce = cache_nonce;
1783               cache_nonce = NULL;
1784             }
1785           if (newpass)
1786             {
1787               /* If we have a new passphrase (which might be empty) we
1788                  store it under a passwd nonce so that the caller may
1789                  send that nonce again to use it for another key. */
1790               if (!passwd_nonce)
1791                 {
1792                   char buf[12];
1793                   gcry_create_nonce (buf, 12);
1794                   passwd_nonce = bin2hex (buf, 12, NULL);
1795                 }
1796               if (passwd_nonce
1797                   && !agent_put_cache (passwd_nonce, CACHE_MODE_NONCE,
1798                                        newpass, CACHE_TTL_NONCE))
1799                 {
1800                   assuan_write_status (ctx, "PASSWD_NONCE", passwd_nonce);
1801                   xfree (ctrl->server_local->last_passwd_nonce);
1802                   ctrl->server_local->last_passwd_nonce = passwd_nonce;
1803                   passwd_nonce = NULL;
1804                 }
1805             }
1806         }
1807       if (!err && opt_preset)
1808         {
1809           char hexgrip[40+1];
1810           bin2hex(grip, 20, hexgrip);
1811           err = agent_put_cache (hexgrip, CACHE_MODE_ANY, newpass,
1812                                  ctrl->cache_ttl_opt_preset);
1813         }
1814       xfree (newpass);
1815     }
1816   ctrl->in_passwd--;
1817
1818   xfree (ctrl->server_local->keydesc);
1819   ctrl->server_local->keydesc = NULL;
1820
1821  leave:
1822   xfree (passphrase);
1823   gcry_sexp_release (s_skey);
1824   xfree (shadow_info);
1825   xfree (cache_nonce);
1826   return leave_cmd (ctx, err);
1827 }
1828
1829
1830 static const char hlp_preset_passphrase[] =
1831   "PRESET_PASSPHRASE [--inquire] <string_or_keygrip> <timeout> [<hexstring>]\n"
1832   "\n"
1833   "Set the cached passphrase/PIN for the key identified by the keygrip\n"
1834   "to passwd for the given time, where -1 means infinite and 0 means\n"
1835   "the default (currently only a timeout of -1 is allowed, which means\n"
1836   "to never expire it).  If passwd is not provided, ask for it via the\n"
1837   "pinentry module unless --inquire is passed in which case the passphrase\n"
1838   "is retrieved from the client via a server inquire.\n";
1839 static gpg_error_t
1840 cmd_preset_passphrase (assuan_context_t ctx, char *line)
1841 {
1842   ctrl_t ctrl = assuan_get_pointer (ctx);
1843   int rc;
1844   char *grip_clear = NULL;
1845   unsigned char *passphrase = NULL;
1846   int ttl;
1847   size_t len;
1848   int opt_inquire;
1849
1850   if (ctrl->restricted)
1851     return leave_cmd (ctx, gpg_error (GPG_ERR_FORBIDDEN));
1852
1853   if (!opt.allow_preset_passphrase)
1854     return set_error (GPG_ERR_NOT_SUPPORTED, "no --allow-preset-passphrase");
1855
1856   opt_inquire = has_option (line, "--inquire");
1857   line = skip_options (line);
1858   grip_clear = line;
1859   while (*line && (*line != ' ' && *line != '\t'))
1860     line++;
1861   if (!*line)
1862     return gpg_error (GPG_ERR_MISSING_VALUE);
1863   *line = '\0';
1864   line++;
1865   while (*line && (*line == ' ' || *line == '\t'))
1866     line++;
1867
1868   /* Currently, only infinite timeouts are allowed.  */
1869   ttl = -1;
1870   if (line[0] != '-' || line[1] != '1')
1871     return gpg_error (GPG_ERR_NOT_IMPLEMENTED);
1872   line++;
1873   line++;
1874   while (!(*line != ' ' && *line != '\t'))
1875     line++;
1876
1877   /* Syntax check the hexstring.  */
1878   len = 0;
1879   rc = parse_hexstring (ctx, line, &len);
1880   if (rc)
1881     return rc;
1882   line[len] = '\0';
1883
1884   /* If there is a passphrase, use it.  Currently, a passphrase is
1885      required.  */
1886   if (*line)
1887     {
1888       if (opt_inquire)
1889         {
1890           rc = set_error (GPG_ERR_ASS_PARAMETER,
1891                           "both --inquire and passphrase specified");
1892           goto leave;
1893         }
1894
1895       /* Do in-place conversion.  */
1896       passphrase = line;
1897       if (!hex2str (passphrase, passphrase, strlen (passphrase)+1, NULL))
1898         rc = set_error (GPG_ERR_ASS_PARAMETER, "invalid hexstring");
1899     }
1900   else if (opt_inquire)
1901     {
1902       /* Note that the passphrase will be truncated at any null byte and the
1903        * limit is 480 characters. */
1904       size_t maxlen = 480;
1905
1906       rc = print_assuan_status (ctx, "INQUIRE_MAXLEN", "%zu", maxlen);
1907       if (!rc)
1908         rc = assuan_inquire (ctx, "PASSPHRASE", &passphrase, &len, maxlen);
1909     }
1910   else
1911     rc = set_error (GPG_ERR_NOT_IMPLEMENTED, "passphrase is required");
1912
1913   if (!rc)
1914     {
1915       rc = agent_put_cache (grip_clear, CACHE_MODE_ANY, passphrase, ttl);
1916       if (opt_inquire)
1917         xfree (passphrase);
1918     }
1919
1920 leave:
1921   return leave_cmd (ctx, rc);
1922 }
1923
1924
1925 \f
1926 static const char hlp_scd[] =
1927   "SCD <commands to pass to the scdaemon>\n"
1928   " \n"
1929   "This is a general quote command to redirect everything to the\n"
1930   "SCdaemon.";
1931 static gpg_error_t
1932 cmd_scd (assuan_context_t ctx, char *line)
1933 {
1934   ctrl_t ctrl = assuan_get_pointer (ctx);
1935   int rc;
1936
1937   if (ctrl->restricted)
1938     return leave_cmd (ctx, gpg_error (GPG_ERR_FORBIDDEN));
1939
1940   rc = divert_generic_cmd (ctrl, line, ctx);
1941
1942   return rc;
1943 }
1944
1945
1946 \f
1947 static const char hlp_keywrap_key[] =
1948   "KEYWRAP_KEY [--clear] <mode>\n"
1949   "\n"
1950   "Return a key to wrap another key.  For now the key is returned\n"
1951   "verbatim and and thus makes not much sense because an eavesdropper on\n"
1952   "the gpg-agent connection will see the key as well as the wrapped key.\n"
1953   "However, this function may either be equipped with a public key\n"
1954   "mechanism or not used at all if the key is a pre-shared key.  In any\n"
1955   "case wrapping the import and export of keys is a requirement for\n"
1956   "certain cryptographic validations and thus useful.  The key persists\n"
1957   "a RESET command but may be cleared using the option --clear.\n"
1958   "\n"
1959   "Supported modes are:\n"
1960   "  --import  - Return a key to import a key into gpg-agent\n"
1961   "  --export  - Return a key to export a key from gpg-agent";
1962 static gpg_error_t
1963 cmd_keywrap_key (assuan_context_t ctx, char *line)
1964 {
1965   ctrl_t ctrl = assuan_get_pointer (ctx);
1966   gpg_error_t err = 0;
1967   int clearopt = has_option (line, "--clear");
1968
1969   if (ctrl->restricted)
1970     return leave_cmd (ctx, gpg_error (GPG_ERR_FORBIDDEN));
1971
1972   assuan_begin_confidential (ctx);
1973   if (has_option (line, "--import"))
1974     {
1975       xfree (ctrl->server_local->import_key);
1976       if (clearopt)
1977         ctrl->server_local->import_key = NULL;
1978       else if (!(ctrl->server_local->import_key =
1979                  gcry_random_bytes (KEYWRAP_KEYSIZE, GCRY_STRONG_RANDOM)))
1980         err = gpg_error_from_syserror ();
1981       else
1982         err = assuan_send_data (ctx, ctrl->server_local->import_key,
1983                                 KEYWRAP_KEYSIZE);
1984     }
1985   else if (has_option (line, "--export"))
1986     {
1987       xfree (ctrl->server_local->export_key);
1988       if (clearopt)
1989         ctrl->server_local->export_key = NULL;
1990       else if (!(ctrl->server_local->export_key =
1991             gcry_random_bytes (KEYWRAP_KEYSIZE, GCRY_STRONG_RANDOM)))
1992         err = gpg_error_from_syserror ();
1993       else
1994         err = assuan_send_data (ctx, ctrl->server_local->export_key,
1995                                 KEYWRAP_KEYSIZE);
1996     }
1997   else
1998     err = set_error (GPG_ERR_ASS_PARAMETER, "unknown value for MODE");
1999   assuan_end_confidential (ctx);
2000
2001   return leave_cmd (ctx, err);
2002 }
2003
2004
2005 \f
2006 static const char hlp_import_key[] =
2007   "IMPORT_KEY [--unattended] [<cache_nonce>]\n"
2008   "\n"
2009   "Import a secret key into the key store.  The key is expected to be\n"
2010   "encrypted using the current session's key wrapping key (cf. command\n"
2011   "KEYWRAP_KEY) using the AESWRAP-128 algorithm.  This function takes\n"
2012   "no arguments but uses the inquiry \"KEYDATA\" to ask for the actual\n"
2013   "key data.  The unwrapped key must be a canonical S-expression.  The\n"
2014   "option --unattended tries to import the key as-is without any\n"
2015   "re-encryption";
2016 static gpg_error_t
2017 cmd_import_key (assuan_context_t ctx, char *line)
2018 {
2019   ctrl_t ctrl = assuan_get_pointer (ctx);
2020   gpg_error_t err;
2021   int opt_unattended;
2022   unsigned char *wrappedkey = NULL;
2023   size_t wrappedkeylen;
2024   gcry_cipher_hd_t cipherhd = NULL;
2025   unsigned char *key = NULL;
2026   size_t keylen, realkeylen;
2027   char *passphrase = NULL;
2028   unsigned char *finalkey = NULL;
2029   size_t finalkeylen;
2030   unsigned char grip[20];
2031   gcry_sexp_t openpgp_sexp = NULL;
2032   char *cache_nonce = NULL;
2033   char *p;
2034
2035   if (ctrl->restricted)
2036     return leave_cmd (ctx, gpg_error (GPG_ERR_FORBIDDEN));
2037
2038   if (!ctrl->server_local->import_key)
2039     {
2040       err = gpg_error (GPG_ERR_MISSING_KEY);
2041       goto leave;
2042     }
2043
2044   opt_unattended = has_option (line, "--unattended");
2045   line = skip_options (line);
2046
2047   p = line;
2048   for (p=line; *p && *p != ' ' && *p != '\t'; p++)
2049     ;
2050   *p = '\0';
2051   if (*line)
2052     cache_nonce = xtrystrdup (line);
2053
2054   assuan_begin_confidential (ctx);
2055   err = assuan_inquire (ctx, "KEYDATA",
2056                         &wrappedkey, &wrappedkeylen, MAXLEN_KEYDATA);
2057   assuan_end_confidential (ctx);
2058   if (err)
2059     goto leave;
2060   if (wrappedkeylen < 24)
2061     {
2062       err = gpg_error (GPG_ERR_INV_LENGTH);
2063       goto leave;
2064     }
2065   keylen = wrappedkeylen - 8;
2066   key = xtrymalloc_secure (keylen);
2067   if (!key)
2068     {
2069       err = gpg_error_from_syserror ();
2070       goto leave;
2071     }
2072
2073   err = gcry_cipher_open (&cipherhd, GCRY_CIPHER_AES128,
2074                           GCRY_CIPHER_MODE_AESWRAP, 0);
2075   if (err)
2076     goto leave;
2077   err = gcry_cipher_setkey (cipherhd,
2078                             ctrl->server_local->import_key, KEYWRAP_KEYSIZE);
2079   if (err)
2080     goto leave;
2081   err = gcry_cipher_decrypt (cipherhd, key, keylen, wrappedkey, wrappedkeylen);
2082   if (err)
2083     goto leave;
2084   gcry_cipher_close (cipherhd);
2085   cipherhd = NULL;
2086   xfree (wrappedkey);
2087   wrappedkey = NULL;
2088
2089   realkeylen = gcry_sexp_canon_len (key, keylen, NULL, &err);
2090   if (!realkeylen)
2091     goto leave; /* Invalid canonical encoded S-expression.  */
2092
2093   err = keygrip_from_canon_sexp (key, realkeylen, grip);
2094   if (err)
2095     {
2096       /* This might be due to an unsupported S-expression format.
2097          Check whether this is openpgp-private-key and trigger that
2098          import code.  */
2099       if (!gcry_sexp_sscan (&openpgp_sexp, NULL, key, realkeylen))
2100         {
2101           const char *tag;
2102           size_t taglen;
2103
2104           tag = gcry_sexp_nth_data (openpgp_sexp, 0, &taglen);
2105           if (tag && taglen == 19 && !memcmp (tag, "openpgp-private-key", 19))
2106             ;
2107           else
2108             {
2109               gcry_sexp_release (openpgp_sexp);
2110               openpgp_sexp = NULL;
2111             }
2112         }
2113       if (!openpgp_sexp)
2114         goto leave; /* Note that ERR is still set.  */
2115     }
2116
2117
2118   if (openpgp_sexp)
2119     {
2120       /* In most cases the key is encrypted and thus the conversion
2121          function from the OpenPGP format to our internal format will
2122          ask for a passphrase.  That passphrase will be returned and
2123          used to protect the key using the same code as for regular
2124          key import. */
2125
2126       xfree (key);
2127       key = NULL;
2128       err = convert_from_openpgp (ctrl, openpgp_sexp, grip,
2129                                   ctrl->server_local->keydesc, cache_nonce,
2130                                   &key, opt_unattended? NULL : &passphrase);
2131       if (err)
2132         goto leave;
2133       realkeylen = gcry_sexp_canon_len (key, 0, NULL, &err);
2134       if (!realkeylen)
2135         goto leave; /* Invalid canonical encoded S-expression.  */
2136       if (passphrase)
2137         {
2138           assert (!opt_unattended);
2139           if (!cache_nonce)
2140             {
2141               char buf[12];
2142               gcry_create_nonce (buf, 12);
2143               cache_nonce = bin2hex (buf, 12, NULL);
2144             }
2145           if (cache_nonce
2146               && !agent_put_cache (cache_nonce, CACHE_MODE_NONCE,
2147                                    passphrase, CACHE_TTL_NONCE))
2148             assuan_write_status (ctx, "CACHE_NONCE", cache_nonce);
2149         }
2150     }
2151   else if (opt_unattended)
2152     {
2153       err = set_error (GPG_ERR_ASS_PARAMETER,
2154                        "\"--unattended\" may only be used with OpenPGP keys");
2155       goto leave;
2156     }
2157   else
2158     {
2159       if (!agent_key_available (grip))
2160         err = gpg_error (GPG_ERR_EEXIST);
2161       else
2162         {
2163           char *prompt = xtryasprintf
2164             (_("Please enter the passphrase to protect the "
2165                "imported object within the %s system."), GNUPG_NAME);
2166           if (!prompt)
2167             err = gpg_error_from_syserror ();
2168           else
2169             err = agent_ask_new_passphrase (ctrl, prompt, &passphrase);
2170           xfree (prompt);
2171         }
2172       if (err)
2173         goto leave;
2174     }
2175
2176   if (passphrase)
2177     {
2178       err = agent_protect (key, passphrase, &finalkey, &finalkeylen,
2179                            ctrl->s2k_count);
2180       if (!err)
2181         err = agent_write_private_key (grip, finalkey, finalkeylen, 0);
2182     }
2183   else
2184     err = agent_write_private_key (grip, key, realkeylen, 0);
2185
2186  leave:
2187   gcry_sexp_release (openpgp_sexp);
2188   xfree (finalkey);
2189   xfree (passphrase);
2190   xfree (key);
2191   gcry_cipher_close (cipherhd);
2192   xfree (wrappedkey);
2193   xfree (cache_nonce);
2194   xfree (ctrl->server_local->keydesc);
2195   ctrl->server_local->keydesc = NULL;
2196   return leave_cmd (ctx, err);
2197 }
2198
2199
2200 \f
2201 static const char hlp_export_key[] =
2202   "EXPORT_KEY [--cache-nonce=<nonce>] [--openpgp] <hexstring_with_keygrip>\n"
2203   "\n"
2204   "Export a secret key from the key store.  The key will be encrypted\n"
2205   "using the current session's key wrapping key (cf. command KEYWRAP_KEY)\n"
2206   "using the AESWRAP-128 algorithm.  The caller needs to retrieve that key\n"
2207   "prior to using this command.  The function takes the keygrip as argument.\n";
2208 static gpg_error_t
2209 cmd_export_key (assuan_context_t ctx, char *line)
2210 {
2211   ctrl_t ctrl = assuan_get_pointer (ctx);
2212   gpg_error_t err;
2213   unsigned char grip[20];
2214   gcry_sexp_t s_skey = NULL;
2215   unsigned char *key = NULL;
2216   size_t keylen;
2217   gcry_cipher_hd_t cipherhd = NULL;
2218   unsigned char *wrappedkey = NULL;
2219   size_t wrappedkeylen;
2220   int openpgp;
2221   char *cache_nonce;
2222   char *passphrase = NULL;
2223   unsigned char *shadow_info = NULL;
2224   char *pend;
2225   int c;
2226
2227   if (ctrl->restricted)
2228     return leave_cmd (ctx, gpg_error (GPG_ERR_FORBIDDEN));
2229
2230   openpgp = has_option (line, "--openpgp");
2231   cache_nonce = option_value (line, "--cache-nonce");
2232   if (cache_nonce)
2233     {
2234       for (pend = cache_nonce; *pend && !spacep (pend); pend++)
2235         ;
2236       c = *pend;
2237       *pend = '\0';
2238       cache_nonce = xtrystrdup (cache_nonce);
2239       *pend = c;
2240       if (!cache_nonce)
2241         {
2242           err = gpg_error_from_syserror ();
2243           goto leave;
2244         }
2245     }
2246   line = skip_options (line);
2247
2248   if (!ctrl->server_local->export_key)
2249     {
2250       err = set_error (GPG_ERR_MISSING_KEY, "did you run KEYWRAP_KEY ?");
2251       goto leave;
2252     }
2253
2254   err = parse_keygrip (ctx, line, grip);
2255   if (err)
2256     goto leave;
2257
2258   if (agent_key_available (grip))
2259     {
2260       err = gpg_error (GPG_ERR_NO_SECKEY);
2261       goto leave;
2262     }
2263
2264   /* Get the key from the file.  With the openpgp flag we also ask for
2265      the passphrase so that we can use it to re-encrypt it.  */
2266   err = agent_key_from_file (ctrl, cache_nonce,
2267                              ctrl->server_local->keydesc, grip,
2268                              &shadow_info, CACHE_MODE_IGNORE, NULL, &s_skey,
2269                              openpgp ? &passphrase : NULL);
2270   if (err)
2271     goto leave;
2272   if (shadow_info)
2273     {
2274       /* Key is on a smartcard.  */
2275       err = gpg_error (GPG_ERR_UNUSABLE_SECKEY);
2276       goto leave;
2277     }
2278
2279   if (openpgp)
2280     {
2281       /* The openpgp option changes the key format into the OpenPGP
2282          key transfer format.  The result is already a padded
2283          canonical S-expression.  */
2284       if (!passphrase)
2285         {
2286           err = agent_ask_new_passphrase
2287             (ctrl, _("This key (or subkey) is not protected with a passphrase."
2288                      "  Please enter a new passphrase to export it."),
2289              &passphrase);
2290           if (err)
2291             goto leave;
2292         }
2293       err = convert_to_openpgp (ctrl, s_skey, passphrase, &key, &keylen);
2294       if (!err && passphrase)
2295         {
2296           if (!cache_nonce)
2297             {
2298               char buf[12];
2299               gcry_create_nonce (buf, 12);
2300               cache_nonce = bin2hex (buf, 12, NULL);
2301             }
2302           if (cache_nonce
2303               && !agent_put_cache (cache_nonce, CACHE_MODE_NONCE,
2304                                    passphrase, CACHE_TTL_NONCE))
2305             {
2306               assuan_write_status (ctx, "CACHE_NONCE", cache_nonce);
2307               xfree (ctrl->server_local->last_cache_nonce);
2308               ctrl->server_local->last_cache_nonce = cache_nonce;
2309               cache_nonce = NULL;
2310             }
2311         }
2312     }
2313   else
2314     {
2315       /* Convert into a canonical S-expression and wrap that.  */
2316       err = make_canon_sexp_pad (s_skey, 1, &key, &keylen);
2317     }
2318   if (err)
2319     goto leave;
2320   gcry_sexp_release (s_skey);
2321   s_skey = NULL;
2322
2323   err = gcry_cipher_open (&cipherhd, GCRY_CIPHER_AES128,
2324                           GCRY_CIPHER_MODE_AESWRAP, 0);
2325   if (err)
2326     goto leave;
2327   err = gcry_cipher_setkey (cipherhd,
2328                             ctrl->server_local->export_key, KEYWRAP_KEYSIZE);
2329   if (err)
2330     goto leave;
2331
2332   wrappedkeylen = keylen + 8;
2333   wrappedkey = xtrymalloc (wrappedkeylen);
2334   if (!wrappedkey)
2335     {
2336       err = gpg_error_from_syserror ();
2337       goto leave;
2338     }
2339
2340   err = gcry_cipher_encrypt (cipherhd, wrappedkey, wrappedkeylen, key, keylen);
2341   if (err)
2342     goto leave;
2343   xfree (key);
2344   key = NULL;
2345   gcry_cipher_close (cipherhd);
2346   cipherhd = NULL;
2347
2348   assuan_begin_confidential (ctx);
2349   err = assuan_send_data (ctx, wrappedkey, wrappedkeylen);
2350   assuan_end_confidential (ctx);
2351
2352
2353  leave:
2354   xfree (cache_nonce);
2355   xfree (passphrase);
2356   xfree (wrappedkey);
2357   gcry_cipher_close (cipherhd);
2358   xfree (key);
2359   gcry_sexp_release (s_skey);
2360   xfree (ctrl->server_local->keydesc);
2361   ctrl->server_local->keydesc = NULL;
2362   xfree (shadow_info);
2363
2364   return leave_cmd (ctx, err);
2365 }
2366
2367
2368 \f
2369 static const char hlp_delete_key[] =
2370   "DELETE_KEY <hexstring_with_keygrip>\n"
2371   "\n"
2372   "Delete a secret key from the key store.\n"
2373   "As safeguard the agent asks the user for confirmation.\n";
2374 static gpg_error_t
2375 cmd_delete_key (assuan_context_t ctx, char *line)
2376 {
2377   ctrl_t ctrl = assuan_get_pointer (ctx);
2378   gpg_error_t err;
2379   unsigned char grip[20];
2380
2381   if (ctrl->restricted)
2382     return leave_cmd (ctx, gpg_error (GPG_ERR_FORBIDDEN));
2383
2384   line = skip_options (line);
2385
2386   err = parse_keygrip (ctx, line, grip);
2387   if (err)
2388     goto leave;
2389
2390   err = agent_delete_key (ctrl, ctrl->server_local->keydesc, grip);
2391   if (err)
2392     goto leave;
2393
2394  leave:
2395   xfree (ctrl->server_local->keydesc);
2396   ctrl->server_local->keydesc = NULL;
2397
2398   return leave_cmd (ctx, err);
2399 }
2400
2401
2402 \f
2403 static const char hlp_keytocard[] =
2404   "KEYTOCARD [--force] <hexstring_with_keygrip> <serialno> <id> <timestamp>\n"
2405   "\n";
2406 static gpg_error_t
2407 cmd_keytocard (assuan_context_t ctx, char *line)
2408 {
2409   ctrl_t ctrl = assuan_get_pointer (ctx);
2410   int force;
2411   gpg_error_t err = 0;
2412   unsigned char grip[20];
2413   gcry_sexp_t s_skey = NULL;
2414   unsigned char *keydata;
2415   size_t keydatalen, timestamplen;
2416   const char *serialno, *timestamp_str, *id;
2417   unsigned char *shadow_info = NULL;
2418   time_t timestamp;
2419
2420   if (ctrl->restricted)
2421     return leave_cmd (ctx, gpg_error (GPG_ERR_FORBIDDEN));
2422
2423   force = has_option (line, "--force");
2424   line = skip_options (line);
2425
2426   err = parse_keygrip (ctx, line, grip);
2427   if (err)
2428     return err;
2429
2430   if (agent_key_available (grip))
2431     return gpg_error (GPG_ERR_NO_SECKEY);
2432
2433   line += 40;
2434   while (*line && (*line == ' ' || *line == '\t'))
2435     line++;
2436   serialno = line;
2437   while (*line && (*line != ' ' && *line != '\t'))
2438     line++;
2439   if (!*line)
2440     return gpg_error (GPG_ERR_MISSING_VALUE);
2441   *line = '\0';
2442   line++;
2443   while (*line && (*line == ' ' || *line == '\t'))
2444     line++;
2445   id = line;
2446   while (*line && (*line != ' ' && *line != '\t'))
2447     line++;
2448   if (!*line)
2449     return gpg_error (GPG_ERR_MISSING_VALUE);
2450   *line = '\0';
2451   line++;
2452   while (*line && (*line == ' ' || *line == '\t'))
2453     line++;
2454   timestamp_str = line;
2455   while (*line && (*line != ' ' && *line != '\t'))
2456     line++;
2457   if (*line)
2458     *line = '\0';
2459   timestamplen = line - timestamp_str;
2460   if (timestamplen != 15)
2461     return gpg_error (GPG_ERR_INV_VALUE);
2462
2463   err = agent_key_from_file (ctrl, NULL, ctrl->server_local->keydesc, grip,
2464                              &shadow_info, CACHE_MODE_IGNORE, NULL,
2465                              &s_skey, NULL);
2466   if (err)
2467     {
2468       xfree (shadow_info);
2469       return err;
2470     }
2471   if (shadow_info)
2472     {
2473       /* Key is on a smartcard already.  */
2474       xfree (shadow_info);
2475       gcry_sexp_release (s_skey);
2476       return gpg_error (GPG_ERR_UNUSABLE_SECKEY);
2477     }
2478
2479   keydatalen =  gcry_sexp_sprint (s_skey, GCRYSEXP_FMT_CANON, NULL, 0);
2480   keydata = xtrymalloc_secure (keydatalen + 30);
2481   if (keydata == NULL)
2482     {
2483       gcry_sexp_release (s_skey);
2484       return gpg_error_from_syserror ();
2485     }
2486
2487   gcry_sexp_sprint (s_skey, GCRYSEXP_FMT_CANON, keydata, keydatalen);
2488   gcry_sexp_release (s_skey);
2489   keydatalen--;                 /* Decrement for last '\0'.  */
2490   /* Add timestamp "created-at" in the private key */
2491   timestamp = isotime2epoch (timestamp_str);
2492   snprintf (keydata+keydatalen-1, 30, "(10:created-at10:%010lu))", timestamp);
2493   keydatalen += 10 + 19 - 1;
2494   err = divert_writekey (ctrl, force, serialno, id, keydata, keydatalen);
2495   xfree (keydata);
2496
2497   return leave_cmd (ctx, err);
2498 }
2499
2500
2501 \f
2502 static const char hlp_getval[] =
2503   "GETVAL <key>\n"
2504   "\n"
2505   "Return the value for KEY from the special environment as created by\n"
2506   "PUTVAL.";
2507 static gpg_error_t
2508 cmd_getval (assuan_context_t ctx, char *line)
2509 {
2510   ctrl_t ctrl = assuan_get_pointer (ctx);
2511   int rc = 0;
2512   char *key = NULL;
2513   char *p;
2514   struct putval_item_s *vl;
2515
2516   if (ctrl->restricted)
2517     return leave_cmd (ctx, gpg_error (GPG_ERR_FORBIDDEN));
2518
2519   for (p=line; *p == ' '; p++)
2520     ;
2521   key = p;
2522   p = strchr (key, ' ');
2523   if (p)
2524     {
2525       *p++ = 0;
2526       for (; *p == ' '; p++)
2527         ;
2528       if (*p)
2529         return set_error (GPG_ERR_ASS_PARAMETER, "too many arguments");
2530     }
2531   if (!*key)
2532     return set_error (GPG_ERR_ASS_PARAMETER, "no key given");
2533
2534
2535   for (vl=putval_list; vl; vl = vl->next)
2536     if ( !strcmp (vl->d, key) )
2537       break;
2538
2539   if (vl) /* Got an entry. */
2540     rc = assuan_send_data (ctx, vl->d+vl->off, vl->len);
2541   else
2542     return gpg_error (GPG_ERR_NO_DATA);
2543
2544   return leave_cmd (ctx, rc);
2545 }
2546
2547
2548 static const char hlp_putval[] =
2549   "PUTVAL <key> [<percent_escaped_value>]\n"
2550   "\n"
2551   "The gpg-agent maintains a kind of environment which may be used to\n"
2552   "store key/value pairs in it, so that they can be retrieved later.\n"
2553   "This may be used by helper daemons to daemonize themself on\n"
2554   "invocation and register them with gpg-agent.  Callers of the\n"
2555   "daemon's service may now first try connect to get the information\n"
2556   "for that service from gpg-agent through the GETVAL command and then\n"
2557   "try to connect to that daemon.  Only if that fails they may start\n"
2558   "an own instance of the service daemon. \n"
2559   "\n"
2560   "KEY is an an arbitrary symbol with the same syntax rules as keys\n"
2561   "for shell environment variables.  PERCENT_ESCAPED_VALUE is the\n"
2562   "corresponsing value; they should be similar to the values of\n"
2563   "envronment variables but gpg-agent does not enforce any\n"
2564   "restrictions.  If that value is not given any value under that KEY\n"
2565   "is removed from this special environment.";
2566 static gpg_error_t
2567 cmd_putval (assuan_context_t ctx, char *line)
2568 {
2569   ctrl_t ctrl = assuan_get_pointer (ctx);
2570   int rc = 0;
2571   char *key = NULL;
2572   char *value = NULL;
2573   size_t valuelen = 0;
2574   char *p;
2575   struct putval_item_s *vl, *vlprev;
2576
2577   if (ctrl->restricted)
2578     return leave_cmd (ctx, gpg_error (GPG_ERR_FORBIDDEN));
2579
2580   for (p=line; *p == ' '; p++)
2581     ;
2582   key = p;
2583   p = strchr (key, ' ');
2584   if (p)
2585     {
2586       *p++ = 0;
2587       for (; *p == ' '; p++)
2588         ;
2589       if (*p)
2590         {
2591           value = p;
2592           p = strchr (value, ' ');
2593           if (p)
2594             *p = 0;
2595           valuelen = percent_plus_unescape_inplace (value, 0);
2596         }
2597     }
2598   if (!*key)
2599     return set_error (GPG_ERR_ASS_PARAMETER, "no key given");
2600
2601
2602   for (vl=putval_list,vlprev=NULL; vl; vlprev=vl, vl = vl->next)
2603     if ( !strcmp (vl->d, key) )
2604       break;
2605
2606   if (vl) /* Delete old entry. */
2607     {
2608       if (vlprev)
2609         vlprev->next = vl->next;
2610       else
2611         putval_list = vl->next;
2612       xfree (vl);
2613     }
2614
2615   if (valuelen) /* Add entry. */
2616     {
2617       vl = xtrymalloc (sizeof *vl + strlen (key) + valuelen);
2618       if (!vl)
2619         rc = gpg_error_from_syserror ();
2620       else
2621         {
2622           vl->len = valuelen;
2623           vl->off = strlen (key) + 1;
2624           strcpy (vl->d, key);
2625           memcpy (vl->d + vl->off, value, valuelen);
2626           vl->next = putval_list;
2627           putval_list = vl;
2628         }
2629     }
2630
2631   return leave_cmd (ctx, rc);
2632 }
2633
2634
2635
2636 \f
2637 static const char hlp_updatestartuptty[] =
2638   "UPDATESTARTUPTTY\n"
2639   "\n"
2640   "Set startup TTY and X11 DISPLAY variables to the values of this\n"
2641   "session.  This command is useful to pull future pinentries to\n"
2642   "another screen.  It is only required because there is no way in the\n"
2643   "ssh-agent protocol to convey this information.";
2644 static gpg_error_t
2645 cmd_updatestartuptty (assuan_context_t ctx, char *line)
2646 {
2647   static const char *names[] =
2648     { "GPG_TTY", "DISPLAY", "TERM", "XAUTHORITY", "PINENTRY_USER_DATA", NULL };
2649   ctrl_t ctrl = assuan_get_pointer (ctx);
2650   gpg_error_t err = 0;
2651   session_env_t se;
2652   int idx;
2653   char *lc_ctype = NULL;
2654   char *lc_messages = NULL;
2655
2656   (void)line;
2657
2658   if (ctrl->restricted)
2659     return leave_cmd (ctx, gpg_error (GPG_ERR_FORBIDDEN));
2660
2661   se = session_env_new ();
2662   if (!se)
2663     err = gpg_error_from_syserror ();
2664
2665   for (idx=0; !err && names[idx]; idx++)
2666     {
2667       const char *value = session_env_getenv (ctrl->session_env, names[idx]);
2668       if (value)
2669         err = session_env_setenv (se, names[idx], value);
2670     }
2671
2672   if (!err && ctrl->lc_ctype)
2673     if (!(lc_ctype = xtrystrdup (ctrl->lc_ctype)))
2674       err = gpg_error_from_syserror ();
2675
2676   if (!err && ctrl->lc_messages)
2677     if (!(lc_messages = xtrystrdup (ctrl->lc_messages)))
2678       err = gpg_error_from_syserror ();
2679
2680   if (err)
2681     {
2682       session_env_release (se);
2683       xfree (lc_ctype);
2684       xfree (lc_messages);
2685     }
2686   else
2687     {
2688       session_env_release (opt.startup_env);
2689       opt.startup_env = se;
2690       xfree (opt.startup_lc_ctype);
2691       opt.startup_lc_ctype = lc_ctype;
2692       xfree (opt.startup_lc_messages);
2693       opt.startup_lc_messages = lc_messages;
2694     }
2695
2696   return err;
2697 }
2698
2699
2700 \f
2701 static const char hlp_killagent[] =
2702   "KILLAGENT\n"
2703   "\n"
2704   "Stop the agent.";
2705 static gpg_error_t
2706 cmd_killagent (assuan_context_t ctx, char *line)
2707 {
2708   ctrl_t ctrl = assuan_get_pointer (ctx);
2709
2710   (void)line;
2711
2712   if (ctrl->restricted)
2713     return leave_cmd (ctx, gpg_error (GPG_ERR_FORBIDDEN));
2714
2715   ctrl->server_local->stopme = 1;
2716   assuan_set_flag (ctx, ASSUAN_FORCE_CLOSE, 1);
2717   return 0;
2718 }
2719
2720
2721 static const char hlp_reloadagent[] =
2722   "RELOADAGENT\n"
2723   "\n"
2724   "This command is an alternative to SIGHUP\n"
2725   "to reload the configuration.";
2726 static gpg_error_t
2727 cmd_reloadagent (assuan_context_t ctx, char *line)
2728 {
2729   ctrl_t ctrl = assuan_get_pointer (ctx);
2730
2731   (void)line;
2732
2733   if (ctrl->restricted)
2734     return leave_cmd (ctx, gpg_error (GPG_ERR_FORBIDDEN));
2735
2736   agent_sighup_action ();
2737   return 0;
2738 }
2739
2740
2741 \f
2742 static const char hlp_getinfo[] =
2743   "GETINFO <what>\n"
2744   "\n"
2745   "Multipurpose function to return a variety of information.\n"
2746   "Supported values for WHAT are:\n"
2747   "\n"
2748   "  version     - Return the version of the program.\n"
2749   "  pid         - Return the process id of the server.\n"
2750   "  socket_name - Return the name of the socket.\n"
2751   "  ssh_socket_name - Return the name of the ssh socket.\n"
2752   "  scd_running - Return OK if the SCdaemon is already running.\n"
2753   "  s2k_count   - Return the calibrated S2K count.\n"
2754   "  std_session_env - List the standard session environment.\n"
2755   "  std_startup_env - List the standard startup environment.\n"
2756   "  cmd_has_option\n"
2757   "              - Returns OK if the command CMD implements the option OPT.\n"
2758   "  restricted  - Returns OK if the connection is in restricted mode.\n";
2759 static gpg_error_t
2760 cmd_getinfo (assuan_context_t ctx, char *line)
2761 {
2762   ctrl_t ctrl = assuan_get_pointer (ctx);
2763   int rc = 0;
2764
2765   if (!strcmp (line, "version"))
2766     {
2767       const char *s = VERSION;
2768       rc = assuan_send_data (ctx, s, strlen (s));
2769     }
2770   else if (!strncmp (line, "cmd_has_option", 14)
2771            && (line[14] == ' ' || line[14] == '\t' || !line[14]))
2772     {
2773       char *cmd, *cmdopt;
2774       line += 14;
2775       while (*line == ' ' || *line == '\t')
2776         line++;
2777       if (!*line)
2778         rc = gpg_error (GPG_ERR_MISSING_VALUE);
2779       else
2780         {
2781           cmd = line;
2782           while (*line && (*line != ' ' && *line != '\t'))
2783             line++;
2784           if (!*line)
2785             rc = gpg_error (GPG_ERR_MISSING_VALUE);
2786           else
2787             {
2788               *line++ = 0;
2789               while (*line == ' ' || *line == '\t')
2790                 line++;
2791               if (!*line)
2792                 rc = gpg_error (GPG_ERR_MISSING_VALUE);
2793               else
2794                 {
2795                   cmdopt = line;
2796                   if (!command_has_option (cmd, cmdopt))
2797                     rc = gpg_error (GPG_ERR_GENERAL);
2798                 }
2799             }
2800         }
2801     }
2802   else if (!strcmp (line, "s2k_count"))
2803     {
2804       char numbuf[50];
2805
2806       snprintf (numbuf, sizeof numbuf, "%lu", get_standard_s2k_count ());
2807       rc = assuan_send_data (ctx, numbuf, strlen (numbuf));
2808     }
2809   else if (!strcmp (line, "restricted"))
2810     {
2811       rc = ctrl->restricted? 0 : gpg_error (GPG_ERR_GENERAL);
2812     }
2813   else if (ctrl->restricted)
2814     {
2815       rc = gpg_error (GPG_ERR_FORBIDDEN);
2816     }
2817   /* All sub-commands below are not allowed in restricted mode.  */
2818   else if (!strcmp (line, "pid"))
2819     {
2820       char numbuf[50];
2821
2822       snprintf (numbuf, sizeof numbuf, "%lu", (unsigned long)getpid ());
2823       rc = assuan_send_data (ctx, numbuf, strlen (numbuf));
2824     }
2825   else if (!strcmp (line, "socket_name"))
2826     {
2827       const char *s = get_agent_socket_name ();
2828
2829       if (s)
2830         rc = assuan_send_data (ctx, s, strlen (s));
2831       else
2832         rc = gpg_error (GPG_ERR_NO_DATA);
2833     }
2834   else if (!strcmp (line, "ssh_socket_name"))
2835     {
2836       const char *s = get_agent_ssh_socket_name ();
2837
2838       if (s)
2839         rc = assuan_send_data (ctx, s, strlen (s));
2840       else
2841         rc = gpg_error (GPG_ERR_NO_DATA);
2842     }
2843   else if (!strcmp (line, "scd_running"))
2844     {
2845       rc = agent_scd_check_running ()? 0 : gpg_error (GPG_ERR_GENERAL);
2846     }
2847   else if (!strcmp (line, "std_session_env")
2848            || !strcmp (line, "std_startup_env"))
2849     {
2850       int iterator;
2851       const char *name, *value;
2852       char *string;
2853
2854       iterator = 0;
2855       while ((name = session_env_list_stdenvnames (&iterator, NULL)))
2856         {
2857           value = session_env_getenv_or_default
2858             (line[5] == 't'? opt.startup_env:ctrl->session_env, name, NULL);
2859           if (value)
2860             {
2861               string = xtryasprintf ("%s=%s", name, value);
2862               if (!string)
2863                 rc = gpg_error_from_syserror ();
2864               else
2865                 {
2866                   rc = assuan_send_data (ctx, string, strlen (string)+1);
2867                   if (!rc)
2868                     rc = assuan_send_data (ctx, NULL, 0);
2869                 }
2870               if (rc)
2871                 break;
2872             }
2873         }
2874     }
2875   else
2876     rc = set_error (GPG_ERR_ASS_PARAMETER, "unknown value for WHAT");
2877   return rc;
2878 }
2879
2880
2881 \f
2882 /* This function is called by Libassuan to parse the OPTION command.
2883    It has been registered similar to the other Assuan commands.  */
2884 static gpg_error_t
2885 option_handler (assuan_context_t ctx, const char *key, const char *value)
2886 {
2887   ctrl_t ctrl = assuan_get_pointer (ctx);
2888   gpg_error_t err = 0;
2889
2890   if (!strcmp (key, "agent-awareness"))
2891     {
2892       /* The value is a version string telling us of which agent
2893          version the caller is aware of.  */
2894       ctrl->server_local->allow_fully_canceled =
2895         gnupg_compare_version (value, "2.1.0");
2896     }
2897   else if (ctrl->restricted)
2898     {
2899       err = gpg_error (GPG_ERR_FORBIDDEN);
2900     }
2901   /* All options below are not allowed in restricted mode.  */
2902   else if (!strcmp (key, "putenv"))
2903     {
2904       /* Change the session's environment to be used for the
2905          Pinentry.  Valid values are:
2906           <NAME>            Delete envvar NAME
2907           <KEY>=            Set envvar NAME to the empty string
2908           <KEY>=<VALUE>     Set envvar NAME to VALUE
2909       */
2910       err = session_env_putenv (ctrl->session_env, value);
2911     }
2912   else if (!strcmp (key, "display"))
2913     {
2914       err = session_env_setenv (ctrl->session_env, "DISPLAY", value);
2915     }
2916   else if (!strcmp (key, "ttyname"))
2917     {
2918       if (!opt.keep_tty)
2919         err = session_env_setenv (ctrl->session_env, "GPG_TTY", value);
2920     }
2921   else if (!strcmp (key, "ttytype"))
2922     {
2923       if (!opt.keep_tty)
2924         err = session_env_setenv (ctrl->session_env, "TERM", value);
2925     }
2926   else if (!strcmp (key, "lc-ctype"))
2927     {
2928       if (ctrl->lc_ctype)
2929         xfree (ctrl->lc_ctype);
2930       ctrl->lc_ctype = xtrystrdup (value);
2931       if (!ctrl->lc_ctype)
2932         return out_of_core ();
2933     }
2934   else if (!strcmp (key, "lc-messages"))
2935     {
2936       if (ctrl->lc_messages)
2937         xfree (ctrl->lc_messages);
2938       ctrl->lc_messages = xtrystrdup (value);
2939       if (!ctrl->lc_messages)
2940         return out_of_core ();
2941     }
2942   else if (!strcmp (key, "xauthority"))
2943     {
2944       err = session_env_setenv (ctrl->session_env, "XAUTHORITY", value);
2945     }
2946   else if (!strcmp (key, "pinentry-user-data"))
2947     {
2948       err = session_env_setenv (ctrl->session_env, "PINENTRY_USER_DATA", value);
2949     }
2950   else if (!strcmp (key, "use-cache-for-signing"))
2951     ctrl->server_local->use_cache_for_signing = *value? atoi (value) : 0;
2952   else if (!strcmp (key, "allow-pinentry-notify"))
2953     ctrl->server_local->allow_pinentry_notify = 1;
2954   else if (!strcmp (key, "pinentry-mode"))
2955     {
2956       int tmp = parse_pinentry_mode (value);
2957       if (tmp == -1)
2958         err = gpg_error (GPG_ERR_INV_VALUE);
2959       else if (tmp == PINENTRY_MODE_LOOPBACK && !opt.allow_loopback_pinentry)
2960         err = gpg_error (GPG_ERR_NOT_SUPPORTED);
2961       else
2962         ctrl->pinentry_mode = tmp;
2963     }
2964   else if (!strcmp (key, "cache-ttl-opt-preset"))
2965     {
2966       ctrl->cache_ttl_opt_preset = *value? atoi (value) : 0;
2967     }
2968   else if (!strcmp (key, "s2k-count"))
2969     {
2970       ctrl->s2k_count = *value? strtoul(value, NULL, 10) : 0;
2971       if (ctrl->s2k_count && ctrl->s2k_count < 65536)
2972         {
2973           ctrl->s2k_count = 0;
2974         }
2975     }
2976   else
2977     err = gpg_error (GPG_ERR_UNKNOWN_OPTION);
2978
2979   return err;
2980 }
2981
2982
2983
2984 \f
2985 /* Called by libassuan after all commands. ERR is the error from the
2986    last assuan operation and not the one returned from the command. */
2987 static void
2988 post_cmd_notify (assuan_context_t ctx, gpg_error_t err)
2989 {
2990   ctrl_t ctrl = assuan_get_pointer (ctx);
2991
2992   (void)err;
2993
2994   /* Switch off any I/O monitor controlled logging pausing. */
2995   ctrl->server_local->pause_io_logging = 0;
2996 }
2997
2998
2999 /* This function is called by libassuan for all I/O.  We use it here
3000    to disable logging for the GETEVENTCOUNTER commands.  This is so
3001    that the debug output won't get cluttered by this primitive
3002    command.  */
3003 static unsigned int
3004 io_monitor (assuan_context_t ctx, void *hook, int direction,
3005             const char *line, size_t linelen)
3006 {
3007   ctrl_t ctrl = assuan_get_pointer (ctx);
3008
3009   (void) hook;
3010
3011   /* Note that we only check for the uppercase name.  This allows to
3012      see the logging for debugging if using a non-upercase command
3013      name. */
3014   if (ctx && direction == ASSUAN_IO_FROM_PEER
3015       && linelen >= 15
3016       && !strncmp (line, "GETEVENTCOUNTER", 15)
3017       && (linelen == 15 || spacep (line+15)))
3018     {
3019       ctrl->server_local->pause_io_logging = 1;
3020     }
3021
3022   return ctrl->server_local->pause_io_logging? ASSUAN_IO_MONITOR_NOLOG : 0;
3023 }
3024
3025
3026 /* Return true if the command CMD implements the option OPT.  */
3027 static int
3028 command_has_option (const char *cmd, const char *cmdopt)
3029 {
3030   if (!strcmp (cmd, "GET_PASSPHRASE"))
3031     {
3032       if (!strcmp (cmdopt, "repeat"))
3033           return 1;
3034     }
3035
3036   return 0;
3037 }
3038
3039
3040 /* Tell Libassuan about our commands.  Also register the other Assuan
3041    handlers. */
3042 static int
3043 register_commands (assuan_context_t ctx)
3044 {
3045   static struct {
3046     const char *name;
3047     assuan_handler_t handler;
3048     const char * const help;
3049   } table[] = {
3050     { "GETEVENTCOUNTER",cmd_geteventcounter, hlp_geteventcounter },
3051     { "ISTRUSTED",      cmd_istrusted, hlp_istrusted },
3052     { "HAVEKEY",        cmd_havekey,   hlp_havekey },
3053     { "KEYINFO",        cmd_keyinfo,   hlp_keyinfo },
3054     { "SIGKEY",         cmd_sigkey,    hlp_sigkey },
3055     { "SETKEY",         cmd_sigkey,    hlp_sigkey },
3056     { "SETKEYDESC",     cmd_setkeydesc,hlp_setkeydesc },
3057     { "SETHASH",        cmd_sethash,   hlp_sethash },
3058     { "PKSIGN",         cmd_pksign,    hlp_pksign },
3059     { "PKDECRYPT",      cmd_pkdecrypt, hlp_pkdecrypt },
3060     { "GENKEY",         cmd_genkey,    hlp_genkey },
3061     { "READKEY",        cmd_readkey,   hlp_readkey },
3062     { "GET_PASSPHRASE", cmd_get_passphrase, hlp_get_passphrase },
3063     { "PRESET_PASSPHRASE", cmd_preset_passphrase, hlp_preset_passphrase },
3064     { "CLEAR_PASSPHRASE", cmd_clear_passphrase,   hlp_clear_passphrase },
3065     { "GET_CONFIRMATION", cmd_get_confirmation,   hlp_get_confirmation },
3066     { "LISTTRUSTED",    cmd_listtrusted, hlp_listtrusted },
3067     { "MARKTRUSTED",    cmd_marktrusted, hlp_martrusted },
3068     { "LEARN",          cmd_learn,     hlp_learn },
3069     { "PASSWD",         cmd_passwd,    hlp_passwd },
3070     { "INPUT",          NULL },
3071     { "OUTPUT",         NULL },
3072     { "SCD",            cmd_scd,       hlp_scd },
3073     { "KEYWRAP_KEY",    cmd_keywrap_key, hlp_keywrap_key },
3074     { "IMPORT_KEY",     cmd_import_key, hlp_import_key },
3075     { "EXPORT_KEY",     cmd_export_key, hlp_export_key },
3076     { "DELETE_KEY",     cmd_delete_key, hlp_delete_key },
3077     { "GETVAL",         cmd_getval,    hlp_getval },
3078     { "PUTVAL",         cmd_putval,    hlp_putval },
3079     { "UPDATESTARTUPTTY",  cmd_updatestartuptty, hlp_updatestartuptty },
3080     { "KILLAGENT",      cmd_killagent,  hlp_killagent },
3081     { "RELOADAGENT",    cmd_reloadagent,hlp_reloadagent },
3082     { "GETINFO",        cmd_getinfo,   hlp_getinfo },
3083     { "KEYTOCARD",      cmd_keytocard, hlp_keytocard },
3084     { NULL }
3085   };
3086   int i, rc;
3087
3088   for (i=0; table[i].name; i++)
3089     {
3090       rc = assuan_register_command (ctx, table[i].name, table[i].handler,
3091                                     table[i].help);
3092       if (rc)
3093         return rc;
3094     }
3095   assuan_register_post_cmd_notify (ctx, post_cmd_notify);
3096   assuan_register_reset_notify (ctx, reset_notify);
3097   assuan_register_option_handler (ctx, option_handler);
3098   return 0;
3099 }
3100
3101
3102 /* Startup the server.  If LISTEN_FD and FD is given as -1, this is a
3103    simple piper server, otherwise it is a regular server.  CTRL is the
3104    control structure for this connection; it has only the basic
3105    intialization. */
3106 void
3107 start_command_handler (ctrl_t ctrl, gnupg_fd_t listen_fd, gnupg_fd_t fd)
3108 {
3109   int rc;
3110   assuan_context_t ctx = NULL;
3111
3112   if (ctrl->restricted)
3113     {
3114       if (agent_copy_startup_env (ctrl))
3115         return;
3116     }
3117
3118   rc = assuan_new (&ctx);
3119   if (rc)
3120     {
3121       log_error ("failed to allocate assuan context: %s\n", gpg_strerror (rc));
3122       agent_exit (2);
3123     }
3124
3125   if (listen_fd == GNUPG_INVALID_FD && fd == GNUPG_INVALID_FD)
3126     {
3127       assuan_fd_t filedes[2];
3128
3129       filedes[0] = assuan_fdopen (0);
3130       filedes[1] = assuan_fdopen (1);
3131       rc = assuan_init_pipe_server (ctx, filedes);
3132     }
3133   else if (listen_fd != GNUPG_INVALID_FD)
3134     {
3135       rc = assuan_init_socket_server (ctx, listen_fd, 0);
3136       /* FIXME: Need to call assuan_sock_set_nonce for Windows.  But
3137          this branch is currently not used.  */
3138     }
3139   else
3140     {
3141       rc = assuan_init_socket_server (ctx, fd, ASSUAN_SOCKET_SERVER_ACCEPTED);
3142     }
3143   if (rc)
3144     {
3145       log_error ("failed to initialize the server: %s\n",
3146                  gpg_strerror(rc));
3147       agent_exit (2);
3148     }
3149   rc = register_commands (ctx);
3150   if (rc)
3151     {
3152       log_error ("failed to register commands with Assuan: %s\n",
3153                  gpg_strerror(rc));
3154       agent_exit (2);
3155     }
3156
3157   assuan_set_pointer (ctx, ctrl);
3158   ctrl->server_local = xcalloc (1, sizeof *ctrl->server_local);
3159   ctrl->server_local->assuan_ctx = ctx;
3160   ctrl->server_local->use_cache_for_signing = 1;
3161   ctrl->digest.raw_value = 0;
3162
3163   assuan_set_io_monitor (ctx, io_monitor, NULL);
3164
3165   for (;;)
3166     {
3167       rc = assuan_accept (ctx);
3168       if (gpg_err_code (rc) == GPG_ERR_EOF || rc == -1)
3169         {
3170           break;
3171         }
3172       else if (rc)
3173         {
3174           log_info ("Assuan accept problem: %s\n", gpg_strerror (rc));
3175           break;
3176         }
3177
3178       rc = assuan_process (ctx);
3179       if (rc)
3180         {
3181           log_info ("Assuan processing failed: %s\n", gpg_strerror (rc));
3182           continue;
3183         }
3184     }
3185
3186   /* Reset the nonce caches.  */
3187   clear_nonce_cache (ctrl);
3188
3189   /* Reset the SCD if needed. */
3190   agent_reset_scd (ctrl);
3191
3192   /* Reset the pinentry (in case of popup messages). */
3193   agent_reset_query (ctrl);
3194
3195   /* Cleanup.  */
3196   assuan_release (ctx);
3197   xfree (ctrl->server_local->keydesc);
3198   xfree (ctrl->server_local->import_key);
3199   xfree (ctrl->server_local->export_key);
3200   if (ctrl->server_local->stopme)
3201     agent_exit (0);
3202   xfree (ctrl->server_local);
3203   ctrl->server_local = NULL;
3204 }
3205
3206
3207 /* Helper for the pinentry loopback mode.  It merely passes the
3208    parameters on to the client.  */
3209 gpg_error_t
3210 pinentry_loopback(ctrl_t ctrl, const char *keyword,
3211                   unsigned char **buffer, size_t *size,
3212                   size_t max_length)
3213 {
3214   gpg_error_t rc;
3215   assuan_context_t ctx = ctrl->server_local->assuan_ctx;
3216
3217   rc = print_assuan_status (ctx, "INQUIRE_MAXLEN", "%zu", max_length);
3218   if (rc)
3219     return rc;
3220
3221   assuan_begin_confidential (ctx);
3222   rc = assuan_inquire (ctx, keyword, buffer, size, max_length);
3223   assuan_end_confidential (ctx);
3224   return rc;
3225 }