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