* command.c (cmd_get_passphrase): Remove the plus signs.
[gnupg.git] / agent / query.c
1 /* query.c - fork of the pinentry to query stuff from the user
2  *      Copyright (C) 2001 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
19  */
20
21 #include <config.h>
22 #include <errno.h>
23 #include <stdio.h>
24 #include <stdlib.h>
25 #include <string.h>
26 #include <ctype.h>
27 #include <assert.h>
28 #include <unistd.h>
29 #include <sys/stat.h>
30
31 #include "agent.h"
32 #include "../assuan/assuan.h"
33
34 #ifdef _POSIX_OPEN_MAX
35 #define MAX_OPEN_FDS _POSIX_OPEN_MAX
36 #else
37 #define MAX_OPEN_FDS 20
38 #endif
39
40 static ASSUAN_CONTEXT entry_ctx = NULL;
41
42 /* data to be passed to our callbacks */
43 struct entry_parm_s {
44   int lines;
45   size_t size;
46   char *buffer;
47 };
48
49
50
51 \f
52 /* Fork off the pin entry if this has not already been done */
53 static int
54 start_pinentry (void)
55 {
56   int rc;
57   const char *pgmname;
58   ASSUAN_CONTEXT ctx;
59   const char *argv[3];
60
61   if (entry_ctx)
62     return 0; /* No need to serialize things becuase the agent is
63                  expected to tun as a single-thread (or may be in
64                  future using libpth) */
65
66
67   log_debug ("no running PIN Entry - starting it\n");
68       
69   if (fflush (NULL))
70     {
71       log_error ("error flushing pending output: %s\n", strerror (errno));
72       return seterr (Write_Error);
73     }
74
75   /* FIXME: change the default location of the program */
76   if (!opt.pinentry_program || !*opt.pinentry_program)
77     opt.pinentry_program = "../../pinentry/kpinentry/kpinentry";
78   if ( !(pgmname = strrchr (opt.pinentry_program, '/')))
79     pgmname = opt.pinentry_program;
80   else
81     pgmname++;
82
83   argv[0] = pgmname;
84   argv[1] = NULL;
85
86   /* connect to the pinentry and perform initial handshaking */
87   rc = assuan_pipe_connect (&ctx, opt.pinentry_program, (char**)argv, 0);
88   if (rc)
89     {
90       log_error ("can't connect to the PIN entry module: %s\n",
91                  assuan_strerror (rc));
92       return seterr (No_PIN_Entry);
93     }
94   entry_ctx = ctx;
95   
96   log_debug ("connection to PIN entry established\n");
97
98   rc = assuan_transact (entry_ctx, 
99                         opt.no_grab? "OPTION no-grab":"OPTION grab",
100                         NULL, NULL, NULL, NULL);
101   if (rc)
102     return map_assuan_err (rc);
103
104   return 0;
105 }
106
107
108 static AssuanError
109 getpin_cb (void *opaque, const void *buffer, size_t length)
110 {
111   struct entry_parm_s *parm = opaque;
112
113   /* we expect the pin to fit on one line */
114   if (parm->lines || length >= parm->size)
115     return ASSUAN_Too_Much_Data;
116
117   /* fixme: we should make sure that the assuan buffer is allocated in
118      secure memory or read the response byte by byte */
119   memcpy (parm->buffer, buffer, length);
120   parm->buffer[length] = 0;
121   parm->lines++;
122   return 0;
123 }
124
125
126 static int
127 all_digitsp( const char *s)
128 {
129   for (; *s && *s >= '0' && *s <= '9'; s++)
130     ;
131   return !*s;
132 }  
133
134
135 \f
136 /* Call the Entry and ask for the PIN.  We do check for a valid PIN
137    number here and repeat it as long as we have invalid formed
138    numbers. */
139 int
140 agent_askpin (const char *desc_text,
141               struct pin_entry_info_s *pininfo)
142 {
143   int rc;
144   char line[ASSUAN_LINELENGTH];
145   struct entry_parm_s parm;
146   const char *errtext = NULL;
147
148   if (opt.batch)
149     return 0; /* fixme: we should return BAD PIN */
150
151   if (!pininfo || pininfo->max_length < 1)
152     return seterr (Invalid_Value);
153   if (!desc_text)
154     desc_text = trans ("Please enter you PIN, so that the secret key "
155                        "can be unlocked for this session");
156   
157   rc = start_pinentry ();
158   if (rc)
159     return rc;
160
161   snprintf (line, DIM(line)-1, "SETDESC %s", desc_text);
162   line[DIM(line)-1] = 0;
163   rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL);
164   if (rc)
165     return map_assuan_err (rc);
166
167   rc = assuan_transact (entry_ctx,
168                         pininfo->min_digits? "SETPROMPT PIN:"
169                                            : "SETPROMPT Passphrase:",
170                         NULL, NULL, NULL, NULL);
171   if (rc)
172     return map_assuan_err (rc);
173
174   for (;pininfo->failed_tries < pininfo->max_tries; pininfo->failed_tries++)
175     {
176       memset (&parm, 0, sizeof parm);
177       parm.size = pininfo->max_length;
178       parm.buffer = pininfo->pin;
179
180       if (errtext)
181         { 
182           /* fixme: should we show the try count? It must be translated */
183           snprintf (line, DIM(line)-1, "SETERROR %s (try %d of %d)",
184                     errtext, pininfo->failed_tries+1, pininfo->max_tries);
185           line[DIM(line)-1] = 0;
186           rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL);
187           if (rc)
188             return map_assuan_err (rc);
189           errtext = NULL;
190         }
191       
192       rc = assuan_transact (entry_ctx, "GETPIN", getpin_cb, &parm, NULL, NULL);
193       if (rc == ASSUAN_Too_Much_Data)
194         errtext = pininfo->min_digits? trans ("PIN too long")
195                                      : trans ("Passphrase too long");
196       else if (rc)
197         return map_assuan_err (rc);
198       if (!errtext && !pininfo->min_digits)
199         return 0; /* okay, got a passphrase */
200       if (!errtext && !all_digitsp (pininfo->pin))
201         errtext = trans ("Invalid characters in PIN");
202       if (!errtext && pininfo->max_digits
203           && strlen (pininfo->pin) > pininfo->max_digits)
204         errtext = trans ("PIN too long");
205       if (!errtext
206           && strlen (pininfo->pin) < pininfo->min_digits)
207         errtext = trans ("PIN too short");
208
209       if (!errtext)
210         return 0; /* okay, got a PIN */
211     }
212
213   return pininfo->min_digits? GNUPG_Bad_PIN : GNUPG_Bad_Passphrase;
214 }
215
216
217 \f
218 /* Ask for the passphrase using the supplied arguments.  The
219    passphrase is returned in RETPASS as an hex encoded string to be
220    freed by the caller */
221 int 
222 agent_get_passphrase (char **retpass, const char *desc, const char *prompt,
223                       const char *errtext)
224 {
225
226   int rc;
227   char line[ASSUAN_LINELENGTH];
228   struct entry_parm_s parm;
229   unsigned char *p, *hexstring;
230   int i;
231
232   *retpass = NULL;
233   if (opt.batch)
234     return GNUPG_Bad_Passphrase; 
235
236   rc = start_pinentry ();
237   if (rc)
238     return rc;
239
240   if (desc)
241     snprintf (line, DIM(line)-1, "SETDESC %s", desc);
242   else
243     snprintf (line, DIM(line)-1, "RESET");
244   line[DIM(line)-1] = 0;
245   rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL);
246   if (rc)
247     return map_assuan_err (rc);
248
249   snprintf (line, DIM(line)-1, "SETPROMPT %s", prompt? prompt : "Passphrase");
250   line[DIM(line)-1] = 0;
251   rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL);
252   if (rc)
253     return map_assuan_err (rc);
254
255   if (errtext)
256     {
257       snprintf (line, DIM(line)-1, "SETERROR %s", errtext);
258       line[DIM(line)-1] = 0;
259       rc = assuan_transact (entry_ctx, line, NULL, NULL, NULL, NULL);
260       if (rc)
261         return map_assuan_err (rc);
262     }
263
264   memset (&parm, 0, sizeof parm);
265   parm.size = ASSUAN_LINELENGTH/2 - 5;
266   parm.buffer = gcry_malloc_secure (parm.size+10);
267   if (!parm.buffer)
268     return seterr (Out_Of_Core);
269
270   assuan_begin_confidential (entry_ctx);
271   rc = assuan_transact (entry_ctx, "GETPIN", getpin_cb, &parm, NULL, NULL);
272   if (rc)
273     {
274       xfree (parm.buffer);
275       return map_assuan_err (rc);
276     }
277   
278   hexstring = gcry_malloc_secure (strlen (parm.buffer)*2+1);
279   if (!hexstring)
280     {
281       xfree (parm.buffer);
282       return seterr (Out_Of_Core);
283     }
284
285   for (i=0, p=parm.buffer; *p; p++, i += 2)
286     sprintf (hexstring+i, "%02X", *p);
287   
288   xfree (parm.buffer);
289   *retpass = hexstring;
290   return 0;
291 }
292
293
294
295
296