013c9411dd9bfef886f1767e278181d0fff5f236
[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 static void
156 preset_passphrase (const char *keygrip)
157 {
158   int  rc;
159   char *line;
160   /* FIXME: Use secure memory.  */
161   char passphrase[500];
162
163   if (!opt_passphrase)
164     {
165       rc = read (0, passphrase, sizeof (passphrase) - 1);
166       if (rc < 0)
167         {
168           log_error ("reading passphrase failed: %s\n",
169                      gpg_strerror (gpg_error_from_errno (errno)));
170           return;
171         }
172       passphrase[rc] = '\0';
173       line = strchr (passphrase, '\n');
174       if (line)
175         {
176           line--;
177           if (line > passphrase && line[-1] == '\r')
178             line--;
179           *line = '\0';
180         }
181
182       /* FIXME: How to handle empty passwords?  */
183     }
184
185   rc = asprintf (&line, "PRESET_PASSPHRASE %s -1 %s\n", keygrip,
186                  opt_passphrase? opt_passphrase : passphrase);
187   if (rc < 0)
188     {
189       log_error ("caching passphrase failed: %s\n",
190                  gpg_strerror (gpg_error_from_errno (errno)));
191       return;
192     }
193   if (!opt_passphrase)
194     wipememory (passphrase, sizeof (passphrase));
195
196   rc = map_spwq_error (simple_query (line));
197   if (rc)
198     {
199       log_error ("caching passphrase failed: %s\n", gpg_strerror (rc));
200       return;
201     }
202
203   wipememory (line, strlen (line));
204   free (line);
205 }
206
207
208 static void
209 forget_passphrase (const char *keygrip)
210 {
211   int rc;
212   char *line;
213
214   rc = asprintf (&line, "CLEAR_PASSPHRASE %s\n", keygrip);
215   if (rc < 0)
216     {
217       log_error ("clearing passphrase failed: %s\n",
218                  gpg_strerror (gpg_error_from_errno (errno)));
219       return;
220     }
221   free (line);
222 }
223
224 \f
225 int
226 main (int argc, char **argv)
227 {
228   ARGPARSE_ARGS pargs;
229   int cmd = 0;
230   const char *keygrip = NULL;
231
232   set_strusage (my_strusage);
233   log_set_prefix ("gpg-preset-passphrase", 1); 
234
235   /* Try to auto set the character set.  */
236   set_native_charset (NULL); 
237
238 #ifdef HAVE_W32_SYSTEM
239   /* Fixme: Need to initialize the Windows sockets: This should be
240      moved to another place and we should make sure that it won't get
241      doen twice, like when Pth is used too. */
242   {
243     WSADATA wsadat;
244     WSAStartup (0x202, &wsadat);
245   }
246 #endif
247
248   i18n_init ();
249
250   opt_homedir = default_homedir ();
251
252   pargs.argc = &argc;
253   pargs.argv = &argv;
254   pargs.flags=  1;  /* (do not remove the args) */
255   while (arg_parse (&pargs, opts) )
256     {
257       switch (pargs.r_opt)
258         {
259         case oVerbose: opt.verbose++; break;
260         case oHomedir: opt_homedir = pargs.r.ret_str; break;
261
262         case oPreset: cmd = oPreset; break;
263         case oForget: cmd = oForget; break;
264         case oPassphrase: opt_passphrase = pargs.r.ret_str; break;
265           
266         default : pargs.err = 2; break;
267         }
268     }
269   if (log_get_errorcount(0))
270     exit(2);
271
272   if (argc == 1)
273     keygrip = *argv;
274   else
275     usage (1);
276
277   if (cmd == oPreset)
278     preset_passphrase (keygrip);
279   else if (cmd == oForget)
280     forget_passphrase (keygrip);
281   else
282     log_error ("one of the options --preset or --forget must be given\n");
283
284   agent_exit (0);
285   return 8; /*NOTREACHED*/
286 }
287
288
289 void
290 agent_exit (int rc)
291 {
292   rc = rc? rc : log_get_errorcount(0)? 2 : 0;
293   exit (rc);
294 }