The Agent does now call the pin entry program; however because we have
[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 #define LINELENGTH 1002 /* 1000 + [CR,]LF */
41
42 static ASSUAN_CONTEXT entry_ctx = NULL;
43
44 /* data to be passed to our callbacks */
45 struct entry_parm_s {
46   int lines;
47   size_t size;
48   char *buffer;
49 };
50
51
52
53 \f
54 /* Fork off the pin entry if this has not already been done */
55 static int
56 start_pinentry (void)
57 {
58   int rc;
59   const char *pgmname;
60   ASSUAN_CONTEXT ctx;
61   const char *argv[3];
62
63   if (entry_ctx)
64     return 0; /* No need to serialize things becuase the agent is
65                  expected to tun as a single-thread (or may be in
66                  future using libpth) */
67
68
69   log_debug ("no running PIN Entry - starting it\n");
70       
71   if (fflush (NULL))
72     {
73       log_error ("error flushing pending output: %s\n", strerror (errno));
74       return seterr (Write_Error);
75     }
76
77   /* FIXME: change the default location of the program */
78   if (!opt.pinentry_program || !*opt.pinentry_program)
79     opt.pinentry_program = "../../pinentry/kpinentry/kpinentry";
80   if ( !(pgmname = strrchr (opt.pinentry_program, '/')))
81     pgmname = opt.pinentry_program;
82   else
83     pgmname++;
84
85   argv[0] = pgmname;
86   argv[1] = NULL;
87
88   /* connect to the pinentry and perform initial handshaking */
89   rc = assuan_pipe_connect (&ctx, opt.pinentry_program, (char**)argv);
90   if (rc)
91     {
92       log_error ("can't connect to the PIN entry module: %s\n",
93                  assuan_strerror (rc));
94       return seterr (No_PIN_Entry);
95     }
96   entry_ctx = ctx;
97   
98   log_debug ("connection to PIN entry established\n");
99
100   if (DBG_COMMAND)
101     {
102       log_debug ("waiting for debugger [hit RETURN when ready] .....\n");
103       getchar ();
104       log_debug ("... okay\n");
105     }
106
107   return 0;
108 }
109
110
111 static AssuanError
112 getpin_cb (void *opaque, const void *buffer, size_t length)
113 {
114   struct entry_parm_s *parm = opaque;
115
116   /* we expect the pin to fit on one line */
117   if (parm->lines || length >= parm->size)
118     return ASSUAN_Too_Much_Data;
119
120   /* fixme: we should make sure that the assuan buffer is allocated in
121      secure memory or read the response byte by byte */
122   memcpy (parm->buffer, buffer, length);
123   parm->buffer[length] = 0;
124   parm->lines++;
125   return 0;
126 }
127
128
129 static int
130 all_digitsp( const char *s)
131 {
132   for (; *s && *s >= '0' && *s <= '9'; s++)
133     ;
134   return !*s;
135 }  
136
137
138 \f
139 /* Call the Entry and ask for the PIN.  We do chekc for a valid PIN
140    number here and repeat it as long as we have invalid formed
141    numbers. */
142 int
143 agent_askpin (const char *desc_text,
144               struct pin_entry_info_s *pininfo)
145 {
146   int rc;
147   char line[LINELENGTH];
148   struct entry_parm_s parm;
149   const char *errtext = NULL;
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
218
219