agent: Avoid appending a '\0' byte to the response of READKEY
[gnupg.git] / agent / preset-passphrase.c
1 /* preset-passphrase.c - A tool to preset a passphrase.
2  *      Copyright (C) 2004 Free Software Foundation, Inc.
3  *
4  * This file is part of GnuPG.
5  *
6  * GnuPG is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * GnuPG is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, see <https://www.gnu.org/licenses/>.
18  */
19
20 #include <config.h>
21
22 #include <stdio.h>
23 #include <stdlib.h>
24 #include <stddef.h>
25 #include <stdarg.h>
26 #include <string.h>
27 #include <errno.h>
28 #include <assert.h>
29 #include <sys/stat.h>
30 #include <unistd.h>
31 #ifdef HAVE_LOCALE_H
32 #include <locale.h>
33 #endif
34 #ifdef HAVE_LANGINFO_CODESET
35 #include <langinfo.h>
36 #endif
37 #ifdef HAVE_DOSISH_SYSTEM
38 #include <fcntl.h> /* for setmode() */
39 #endif
40 #ifdef HAVE_W32_SYSTEM
41 # ifdef HAVE_WINSOCK2_H
42 #  include <winsock2.h>
43 # endif
44 # include <windows.h>  /* To initialize the sockets.  fixme */
45 #endif
46
47 #include "agent.h"
48 #include "../common/simple-pwquery.h"
49 #include "../common/i18n.h"
50 #include "../common/sysutils.h"
51 #include "../common/init.h"
52
53
54 enum cmd_and_opt_values
55 { aNull = 0,
56   oVerbose        = 'v',
57   oPassphrase     = 'P',
58
59   oPreset         = 'c',
60   oForget         = 'f',
61
62   oNoVerbose = 500,
63
64   oHomedir,
65
66 aTest };
67
68
69 static const char *opt_passphrase;
70
71 static ARGPARSE_OPTS opts[] = {
72
73   { 301, NULL, 0, N_("@Options:\n ") },
74
75   { oVerbose, "verbose",   0, "verbose" },
76   { oPassphrase, "passphrase", 2, "|STRING|use passphrase STRING" },
77   { oPreset,  "preset",   256, "preset passphrase"},
78   { oForget,  "forget",  256, "forget passphrase"},
79
80   { oHomedir, "homedir", 2, "@" },
81
82   ARGPARSE_end ()
83 };
84
85
86 static const char *
87 my_strusage (int level)
88 {
89   const char *p;
90   switch (level)
91     {
92     case 11: p = "gpg-preset-passphrase (@GNUPG@)";
93       break;
94     case 13: p = VERSION; break;
95     case 17: p = PRINTABLE_OS_NAME; break;
96     case 19: p = _("Please report bugs to <@EMAIL@>.\n"); break;
97
98     case 1:
99     case 40:
100       p =  _("Usage: gpg-preset-passphrase [options] KEYGRIP (-h for help)\n");
101       break;
102     case 41:
103       p = _("Syntax: gpg-preset-passphrase [options] KEYGRIP\n"
104                     "Password cache maintenance\n");
105     break;
106
107     default: p = NULL;
108     }
109   return p;
110 }
111
112
113 \f
114
115 static void
116 preset_passphrase (const char *keygrip)
117 {
118   int  rc;
119   char *line;
120   /* FIXME: Use secure memory.  */
121   char passphrase[500];
122   char *passphrase_esc;
123
124   if (!opt_passphrase)
125     {
126       rc = read (0, passphrase, sizeof (passphrase) - 1);
127       if (rc < 0)
128         {
129           log_error ("reading passphrase failed: %s\n",
130                      gpg_strerror (gpg_error_from_syserror ()));
131           return;
132         }
133       passphrase[rc] = '\0';
134       line = strchr (passphrase, '\n');
135       if (line)
136         {
137           if (line > passphrase && line[-1] == '\r')
138             line--;
139           *line = '\0';
140         }
141
142       /* FIXME: How to handle empty passwords?  */
143     }
144
145   {
146     const char *s = opt_passphrase ? opt_passphrase : passphrase;
147     passphrase_esc = bin2hex (s, strlen (s), NULL);
148   }
149   if (!passphrase_esc)
150     {
151       log_error ("can not escape string: %s\n",
152                  gpg_strerror (gpg_error_from_syserror ()));
153       return;
154     }
155
156   rc = asprintf (&line, "PRESET_PASSPHRASE %s -1 %s\n", keygrip,
157                  passphrase_esc);
158   wipememory (passphrase_esc, strlen (passphrase_esc));
159   xfree (passphrase_esc);
160
161   if (rc < 0)
162     {
163       log_error ("caching passphrase failed: %s\n",
164                  gpg_strerror (gpg_error_from_syserror ()));
165       return;
166     }
167   if (!opt_passphrase)
168     wipememory (passphrase, sizeof (passphrase));
169
170   rc = simple_query (line);
171   if (rc)
172     {
173       log_error ("caching passphrase failed: %s\n", gpg_strerror (rc));
174       return;
175     }
176
177   wipememory (line, strlen (line));
178   xfree (line);
179 }
180
181
182 static void
183 forget_passphrase (const char *keygrip)
184 {
185   int rc;
186   char *line;
187
188   rc = asprintf (&line, "CLEAR_PASSPHRASE %s\n", keygrip);
189   if (rc < 0)
190     rc = gpg_error_from_syserror ();
191   else
192     rc = simple_query (line);
193   if (rc)
194     {
195       log_error ("clearing passphrase failed: %s\n", gpg_strerror (rc));
196       return;
197     }
198
199   xfree (line);
200 }
201
202 \f
203 int
204 main (int argc, char **argv)
205 {
206   ARGPARSE_ARGS pargs;
207   int cmd = 0;
208   const char *keygrip = NULL;
209
210   early_system_init ();
211   set_strusage (my_strusage);
212   log_set_prefix ("gpg-preset-passphrase", GPGRT_LOG_WITH_PREFIX);
213
214   /* Make sure that our subsystems are ready.  */
215   i18n_init ();
216   init_common_subsystems (&argc, &argv);
217
218   pargs.argc = &argc;
219   pargs.argv = &argv;
220   pargs.flags=  1;  /* (do not remove the args) */
221   while (arg_parse (&pargs, opts) )
222     {
223       switch (pargs.r_opt)
224         {
225         case oVerbose: opt.verbose++; break;
226         case oHomedir: gnupg_set_homedir (pargs.r.ret_str); break;
227
228         case oPreset: cmd = oPreset; break;
229         case oForget: cmd = oForget; break;
230         case oPassphrase: opt_passphrase = pargs.r.ret_str; break;
231
232         default : pargs.err = 2; break;
233         }
234     }
235   if (log_get_errorcount(0))
236     exit(2);
237
238   if (argc == 1)
239     keygrip = *argv;
240   else
241     usage (1);
242
243   /* Tell simple-pwquery about the standard socket name.  */
244   {
245     char *tmp = make_filename (gnupg_socketdir (), GPG_AGENT_SOCK_NAME, NULL);
246     simple_pw_set_socket (tmp);
247     xfree (tmp);
248   }
249
250   if (cmd == oPreset)
251     preset_passphrase (keygrip);
252   else if (cmd == oForget)
253     forget_passphrase (keygrip);
254   else
255     log_error ("one of the options --preset or --forget must be given\n");
256
257   agent_exit (0);
258   return 8; /*NOTREACHED*/
259 }
260
261
262 void
263 agent_exit (int rc)
264 {
265   rc = rc? rc : log_get_errorcount(0)? 2 : 0;
266   exit (rc);
267 }