agent: Improve error reporting from Pinentry.
[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 <http://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 #define JNLIB_NEED_LOG_LOGV
48 #include "agent.h"
49 #include "simple-pwquery.h"
50 #include "i18n.h"
51 #include "sysutils.h"
52 #include "../common/init.h"
53
54
55 enum cmd_and_opt_values
56 { aNull = 0,
57   oVerbose        = 'v',
58   oPassphrase     = 'P',
59
60   oPreset         = 'c',
61   oForget         = 'f',
62
63   oNoVerbose = 500,
64
65   oHomedir,
66
67 aTest };
68
69
70 static const char *opt_homedir;
71 static const char *opt_passphrase;
72
73 static ARGPARSE_OPTS opts[] = {
74
75   { 301, NULL, 0, N_("@Options:\n ") },
76
77   { oVerbose, "verbose",   0, "verbose" },
78   { oPassphrase, "passphrase", 2, "|STRING|use passphrase STRING" },
79   { oPreset,  "preset",   256, "preset passphrase"},
80   { oForget,  "forget",  256, "forget passphrase"},
81
82   { oHomedir, "homedir", 2, "@" },
83   {0}
84 };
85
86
87 static const char *
88 my_strusage (int level)
89 {
90   const char *p;
91   switch (level)
92     {
93     case 11: p = "gpg-preset-passphrase (@GNUPG@)";
94       break;
95     case 13: p = VERSION; break;
96     case 17: p = PRINTABLE_OS_NAME; break;
97     case 19: p = _("Please report bugs to <@EMAIL@>.\n"); break;
98
99     case 1:
100     case 40:
101       p =  _("Usage: gpg-preset-passphrase [options] KEYGRIP (-h for help)\n");
102       break;
103     case 41:
104       p = _("Syntax: gpg-preset-passphrase [options] KEYGRIP\n"
105                     "Password cache maintenance\n");
106     break;
107
108     default: p = NULL;
109     }
110   return p;
111 }
112
113
114 \f
115
116 /* Include the implementation of map_spwq_error.  */
117 MAP_SPWQ_ERROR_IMPL
118
119
120 static void
121 preset_passphrase (const char *keygrip)
122 {
123   int  rc;
124   char *line;
125   /* FIXME: Use secure memory.  */
126   char passphrase[500];
127   char *passphrase_esc;
128
129   if (!opt_passphrase)
130     {
131       rc = read (0, passphrase, sizeof (passphrase) - 1);
132       if (rc < 0)
133         {
134           log_error ("reading passphrase failed: %s\n",
135                      gpg_strerror (gpg_error_from_syserror ()));
136           return;
137         }
138       passphrase[rc] = '\0';
139       line = strchr (passphrase, '\n');
140       if (line)
141         {
142           if (line > passphrase && line[-1] == '\r')
143             line--;
144           *line = '\0';
145         }
146
147       /* FIXME: How to handle empty passwords?  */
148     }
149
150   {
151     const char *s = opt_passphrase ? opt_passphrase : passphrase;
152     passphrase_esc = bin2hex (s, strlen (s), NULL);
153   }
154   if (!passphrase_esc)
155     {
156       log_error ("can not escape string: %s\n",
157                  gpg_strerror (gpg_error_from_syserror ()));
158       return;
159     }
160
161   rc = asprintf (&line, "PRESET_PASSPHRASE %s -1 %s\n", keygrip,
162                  passphrase_esc);
163   wipememory (passphrase_esc, strlen (passphrase_esc));
164   xfree (passphrase_esc);
165
166   if (rc < 0)
167     {
168       log_error ("caching passphrase failed: %s\n",
169                  gpg_strerror (gpg_error_from_syserror ()));
170       return;
171     }
172   if (!opt_passphrase)
173     wipememory (passphrase, sizeof (passphrase));
174
175   rc = map_spwq_error (simple_query (line));
176   if (rc)
177     {
178       log_error ("caching passphrase failed: %s\n", gpg_strerror (rc));
179       return;
180     }
181
182   wipememory (line, strlen (line));
183   xfree (line);
184 }
185
186
187 static void
188 forget_passphrase (const char *keygrip)
189 {
190   int rc;
191   char *line;
192
193   rc = asprintf (&line, "CLEAR_PASSPHRASE %s\n", keygrip);
194   if (rc < 0)
195     rc = gpg_error_from_syserror ();
196   else
197     rc = map_spwq_error (simple_query (line));
198   if (rc)
199     {
200       log_error ("clearing passphrase failed: %s\n", gpg_strerror (rc));
201       return;
202     }
203
204   xfree (line);
205 }
206
207 \f
208 int
209 main (int argc, char **argv)
210 {
211   ARGPARSE_ARGS pargs;
212   int cmd = 0;
213   const char *keygrip = NULL;
214
215   early_system_init ();
216   set_strusage (my_strusage);
217   log_set_prefix ("gpg-preset-passphrase", 1);
218
219   /* Make sure that our subsystems are ready.  */
220   i18n_init ();
221   init_common_subsystems (&argc, &argv);
222
223   opt_homedir = default_homedir ();
224
225   pargs.argc = &argc;
226   pargs.argv = &argv;
227   pargs.flags=  1;  /* (do not remove the args) */
228   while (arg_parse (&pargs, opts) )
229     {
230       switch (pargs.r_opt)
231         {
232         case oVerbose: opt.verbose++; break;
233         case oHomedir: opt_homedir = pargs.r.ret_str; break;
234
235         case oPreset: cmd = oPreset; break;
236         case oForget: cmd = oForget; break;
237         case oPassphrase: opt_passphrase = pargs.r.ret_str; break;
238
239         default : pargs.err = 2; break;
240         }
241     }
242   if (log_get_errorcount(0))
243     exit(2);
244
245   if (argc == 1)
246     keygrip = *argv;
247   else
248     usage (1);
249
250   /* Tell simple-pwquery about the the standard socket name.  */
251   {
252     char *tmp = make_filename (opt_homedir, GPG_AGENT_SOCK_NAME, NULL);
253     simple_pw_set_socket (tmp);
254     xfree (tmp);
255   }
256
257   if (cmd == oPreset)
258     preset_passphrase (keygrip);
259   else if (cmd == oForget)
260     forget_passphrase (keygrip);
261   else
262     log_error ("one of the options --preset or --forget must be given\n");
263
264   agent_exit (0);
265   return 8; /*NOTREACHED*/
266 }
267
268
269 void
270 agent_exit (int rc)
271 {
272   rc = rc? rc : log_get_errorcount(0)? 2 : 0;
273   exit (rc);
274 }