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