8f8f60e76870575cd5d2cc0bca5aa73e211c3be4
[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 2 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, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
19  * USA.
20  */
21
22 #include <config.h>
23
24 #include <stdio.h>
25 #include <stdlib.h>
26 #include <stddef.h>
27 #include <stdarg.h>
28 #include <string.h>
29 #include <errno.h>
30 #include <assert.h>
31 #include <sys/stat.h>
32 #include <unistd.h>
33 #ifdef HAVE_LOCALE_H
34 #include <locale.h>
35 #endif
36 #ifdef HAVE_LANGINFO_CODESET
37 #include <langinfo.h>
38 #endif
39 #ifdef HAVE_DOSISH_SYSTEM
40 #include <fcntl.h> /* for setmode() */
41 #endif
42 #ifdef HAVE_W32_SYSTEM
43 #include <windows.h>  /* To initialize the sockets.  fixme */
44 #endif
45
46 #define JNLIB_NEED_LOG_LOGV
47 #include "agent.h"
48 #include "minip12.h"
49 #include "simple-pwquery.h"
50 #include "i18n.h"
51 #include "sysutils.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_homedir;
70 static const char *opt_passphrase;
71
72 static ARGPARSE_OPTS opts[] = {
73   
74   { 301, NULL, 0, N_("@Options:\n ") },
75
76   { oVerbose, "verbose",   0, "verbose" },
77   { oPassphrase, "passphrase", 2, "|STRING|use passphrase STRING" },
78   { oPreset,  "preset",   256, "preset passphrase"},
79   { oForget,  "forget",  256, "forget passphrase"},
80
81   { oHomedir, "homedir", 2, "@" }, 
82   {0}
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 <" PACKAGE_BUGREPORT ">.\n");
97       break;
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
114 static void
115 i18n_init (void)
116 {
117 #ifdef USE_SIMPLE_GETTEXT
118     set_gettext_file( PACKAGE_GT );
119 #else
120 #ifdef ENABLE_NLS
121     setlocale (LC_ALL, "");
122     bindtextdomain (PACKAGE_GT, LOCALEDIR);
123     textdomain (PACKAGE_GT);
124 #endif
125 #endif
126 }
127
128 \f
129 static gpg_error_t
130 map_spwq_error (int err)
131 {
132   switch (err)
133     {
134     case 0:
135       return 0;
136     case SPWQ_OUT_OF_CORE:
137       return gpg_error_from_errno (ENOMEM);
138     case SPWQ_IO_ERROR:
139       return gpg_error_from_errno (EIO);
140     case SPWQ_PROTOCOL_ERROR:
141       return gpg_error (GPG_ERR_PROTOCOL_VIOLATION);
142     case SPWQ_ERR_RESPONSE:
143       return gpg_error (GPG_ERR_INV_RESPONSE);
144     case SPWQ_NO_AGENT:
145       return gpg_error (GPG_ERR_NO_AGENT);
146     case SPWQ_SYS_ERROR:
147       return gpg_error_from_errno (errno);
148     case SPWQ_GENERAL_ERROR:
149     default:
150       return gpg_error (GPG_ERR_GENERAL);
151     }
152 }
153
154       
155 /* Convert the string SRC into HEX encoding.  Caller needs to xfree
156    the returned string.  */
157 static char *
158 make_hexstring (const char *src)
159 {
160   int len = 2 * strlen (src) + 1;
161   char *dst;
162   char *res;
163
164   res = dst = xtrymalloc (len);
165   if (!dst)
166     {
167       log_error ("can not escape string: %s\n",
168                  gpg_strerror (gpg_error_from_errno (errno)));
169       return NULL;
170     }
171
172 #define _tohex(nr)      ((nr) < 10 ? ((nr) + '0') : (((nr) - 10) + 'A'))
173 #define tohex1(p)  _tohex (*((unsigned char *) p) & 15)
174 #define tohex2(p)  _tohex ((*((unsigned char *) p) >> 4) & 15)
175
176   while (*src)
177     {
178       *(dst++) = tohex2 (src);
179       *(dst++) = tohex1 (src);
180       src++;
181     }
182   *dst = '\0';
183   return res;
184 }
185
186
187 static void
188 preset_passphrase (const char *keygrip)
189 {
190   int  rc;
191   char *line;
192   /* FIXME: Use secure memory.  */
193   char passphrase[500];
194   char *passphrase_esc;
195
196   if (!opt_passphrase)
197     {
198       rc = read (0, passphrase, sizeof (passphrase) - 1);
199       if (rc < 0)
200         {
201           log_error ("reading passphrase failed: %s\n",
202                      gpg_strerror (gpg_error_from_errno (errno)));
203           return;
204         }
205       passphrase[rc] = '\0';
206       line = strchr (passphrase, '\n');
207       if (line)
208         {
209           if (line > passphrase && line[-1] == '\r')
210             line--;
211           *line = '\0';
212         }
213
214       /* FIXME: How to handle empty passwords?  */
215     }
216
217   passphrase_esc = make_hexstring (opt_passphrase
218                                    ? opt_passphrase : passphrase);
219   if (!passphrase_esc)
220     {
221       /* Error message printed by callee.  */
222       return;
223     }
224
225   rc = asprintf (&line, "PRESET_PASSPHRASE %s -1 %s\n", keygrip,
226                  passphrase_esc);
227   wipememory (passphrase_esc, strlen (passphrase_esc));
228   xfree (passphrase_esc);
229
230   if (rc < 0)
231     {
232       log_error ("caching passphrase failed: %s\n",
233                  gpg_strerror (gpg_error_from_errno (errno)));
234       return;
235     }
236   if (!opt_passphrase)
237     wipememory (passphrase, sizeof (passphrase));
238
239   rc = map_spwq_error (simple_query (line));
240   if (rc)
241     {
242       log_error ("caching passphrase failed: %s\n", gpg_strerror (rc));
243       return;
244     }
245
246   wipememory (line, strlen (line));
247   free (line);
248 }
249
250
251 static void
252 forget_passphrase (const char *keygrip)
253 {
254   int rc;
255   char *line;
256
257   rc = asprintf (&line, "CLEAR_PASSPHRASE %s\n", keygrip);
258   if (rc < 0)
259     {
260       log_error ("clearing passphrase failed: %s\n",
261                  gpg_strerror (gpg_error_from_errno (errno)));
262       return;
263     }
264   free (line);
265 }
266
267 \f
268 int
269 main (int argc, char **argv)
270 {
271   ARGPARSE_ARGS pargs;
272   int cmd = 0;
273   const char *keygrip = NULL;
274
275   set_strusage (my_strusage);
276   log_set_prefix ("gpg-preset-passphrase", 1); 
277
278   /* Try to auto set the character set.  */
279   set_native_charset (NULL); 
280
281 #ifdef HAVE_W32_SYSTEM
282   /* Fixme: Need to initialize the Windows sockets: This should be
283      moved to another place and we should make sure that it won't get
284      doen twice, like when Pth is used too. */
285   {
286     WSADATA wsadat;
287     WSAStartup (0x202, &wsadat);
288   }
289 #endif
290
291   i18n_init ();
292
293   opt_homedir = default_homedir ();
294
295   pargs.argc = &argc;
296   pargs.argv = &argv;
297   pargs.flags=  1;  /* (do not remove the args) */
298   while (arg_parse (&pargs, opts) )
299     {
300       switch (pargs.r_opt)
301         {
302         case oVerbose: opt.verbose++; break;
303         case oHomedir: opt_homedir = pargs.r.ret_str; break;
304
305         case oPreset: cmd = oPreset; break;
306         case oForget: cmd = oForget; break;
307         case oPassphrase: opt_passphrase = pargs.r.ret_str; break;
308           
309         default : pargs.err = 2; break;
310         }
311     }
312   if (log_get_errorcount(0))
313     exit(2);
314
315   if (argc == 1)
316     keygrip = *argv;
317   else
318     usage (1);
319
320   if (cmd == oPreset)
321     preset_passphrase (keygrip);
322   else if (cmd == oForget)
323     forget_passphrase (keygrip);
324   else
325     log_error ("one of the options --preset or --forget must be given\n");
326
327   agent_exit (0);
328   return 8; /*NOTREACHED*/
329 }
330
331
332 void
333 agent_exit (int rc)
334 {
335   rc = rc? rc : log_get_errorcount(0)? 2 : 0;
336   exit (rc);
337 }