A small step for GnuPG but a huge leap for error codes.
[gnupg.git] / g10 / call-agent.c
1 /* call-agent.c - divert operations to the agent
2  *      Copyright (C) 2001, 2002, 2003 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 #if 0  /* lety Emacs display a red warning */
22 #error fixme: this shares a lof of code with the file in ../sm
23 #endif
24
25 #include <config.h>
26 #include <stdio.h>
27 #include <stdlib.h>
28 #include <string.h>
29 #include <errno.h>
30 #include <unistd.h> 
31 #include <time.h>
32 #include <assert.h>
33 #include <gcrypt.h>
34 #ifdef HAVE_LOCALE_H
35 #include <locale.h>
36 #endif
37 #include <assuan.h>
38
39 #include "gpg.h"
40 #include "i18n.h"
41
42 static ASSUAN_CONTEXT agent_ctx = NULL;
43 static int force_pipe_server = 0;
44
45 struct cipher_parm_s {
46   ASSUAN_CONTEXT ctx;
47   const char *ciphertext;
48   size_t ciphertextlen;
49 };
50
51 struct genkey_parm_s {
52   ASSUAN_CONTEXT ctx;
53   const char *sexp;
54   size_t sexplen;
55 };
56
57 struct learn_parm_s {
58   int error;
59   ASSUAN_CONTEXT ctx;
60   struct membuf *data;
61 };
62
63 \f
64 /* Try to connect to the agent via socket or fork it off and work by
65    pipes.  Handle the server's initial greeting */
66 static int
67 start_agent (void)
68 {
69   int rc = 0;
70   char *infostr, *p;
71   ASSUAN_CONTEXT ctx;
72   char *dft_display = NULL;
73   char *dft_ttyname = NULL;
74   char *dft_ttytype = NULL;
75   char *old_lc = NULL;
76   char *dft_lc = NULL;
77
78   if (agent_ctx)
79     return 0; /* fixme: We need a context for each thread or serialize
80                  the access to the agent. */
81
82   infostr = force_pipe_server? NULL : getenv ("GPG_AGENT_INFO");
83   if (!infostr)
84     {
85       const char *pgmname;
86       const char *argv[3];
87       int no_close_list[3];
88       int i;
89
90       if (opt.verbose)
91         log_info (_("no running gpg-agent - starting one\n"));
92
93       if (fflush (NULL))
94         {
95           gpg_error_t tmperr = gpg_error_from_errno (errno);
96           log_error ("error flushing pending output: %s\n", strerror (errno));
97           return tmperr;
98         }
99
100       if (!opt.agent_program || !*opt.agent_program)
101         opt.agent_program = GNUPG_DEFAULT_AGENT;
102       if ( !(pgmname = strrchr (opt.agent_program, '/')))
103         pgmname = opt.agent_program;
104       else
105         pgmname++;
106
107       argv[0] = pgmname;
108       argv[1] = "--server";
109       argv[2] = NULL;
110
111       i=0;
112       if (log_get_fd () != -1)
113         no_close_list[i++] = log_get_fd ();
114       no_close_list[i++] = fileno (stderr);
115       no_close_list[i] = -1;
116
117       /* connect to the agent and perform initial handshaking */
118       rc = assuan_pipe_connect (&ctx, opt.agent_program, (char**)argv,
119                                 no_close_list);
120     }
121   else
122     {
123       int prot;
124       int pid;
125
126       infostr = xstrdup (infostr);
127       if ( !(p = strchr (infostr, ':')) || p == infostr)
128         {
129           log_error (_("malformed GPG_AGENT_INFO environment variable\n"));
130           xfree (infostr);
131           force_pipe_server = 1;
132           return start_agent ();
133         }
134       *p++ = 0;
135       pid = atoi (p);
136       while (*p && *p != ':')
137         p++;
138       prot = *p? atoi (p+1) : 0;
139       if (prot != 1)
140         {
141           log_error (_("gpg-agent protocol version %d is not supported\n"),
142                      prot);
143           xfree (infostr);
144           force_pipe_server = 1;
145           return start_agent ();
146         }
147
148       rc = assuan_socket_connect (&ctx, infostr, pid);
149       xfree (infostr);
150       if (rc == ASSUAN_Connect_Failed)
151         {
152           log_error (_("can't connect to the agent - trying fall back\n"));
153           force_pipe_server = 1;
154           return start_agent ();
155         }
156     }
157
158   if (rc)
159     {
160       log_error ("can't connect to the agent: %s\n", assuan_strerror (rc));
161       return gpg_error (GPG_ERR_NO_AGENT);
162     }
163   agent_ctx = ctx;
164
165   if (DBG_ASSUAN)
166     log_debug ("connection to agent established\n");
167
168   rc = assuan_transact (agent_ctx, "RESET", NULL, NULL, NULL, NULL, NULL, NULL);
169   if (rc)
170     return map_assuan_err (rc);
171
172   dft_display = getenv ("DISPLAY");
173   if (opt.display || dft_display)
174     {
175       char *optstr;
176       if (asprintf (&optstr, "OPTION display=%s",
177                     opt.display ? opt.display : dft_display) < 0)
178         return OUT_OF_CORE (errno);
179       rc = assuan_transact (agent_ctx, optstr, NULL, NULL, NULL, NULL, NULL,
180                             NULL);
181       free (optstr);
182       if (rc)
183         return map_assuan_err (rc);
184     }
185   if (!opt.ttyname)
186     {
187       dft_ttyname = getenv ("GPG_TTY");
188       if ((!dft_ttyname || !*dft_ttyname) && ttyname (0))
189         dft_ttyname = ttyname (0);
190     }
191   if (opt.ttyname || dft_ttyname)
192     {
193       char *optstr;
194       if (asprintf (&optstr, "OPTION ttyname=%s",
195                     opt.ttyname ? opt.ttyname : dft_ttyname) < 0)
196         return OUT_OF_CORE (errno);
197       rc = assuan_transact (agent_ctx, optstr, NULL, NULL, NULL, NULL, NULL,
198                             NULL);
199       free (optstr);
200       if (rc)
201         return map_assuan_err (rc);
202     }
203   dft_ttytype = getenv ("TERM");
204   if (opt.ttytype || (dft_ttyname && dft_ttytype))
205     {
206       char *optstr;
207       if (asprintf (&optstr, "OPTION ttytype=%s",
208                     opt.ttyname ? opt.ttytype : dft_ttytype) < 0)
209         return OUT_OF_CORE (errno);
210       rc = assuan_transact (agent_ctx, optstr, NULL, NULL, NULL, NULL, NULL,
211                             NULL);
212       free (optstr);
213       if (rc)
214         return map_assuan_err (rc);
215     }
216 #if defined(HAVE_SETLOCALE) && defined(LC_CTYPE)
217   old_lc = setlocale (LC_CTYPE, NULL);
218   if (old_lc)
219     {
220       old_lc = strdup (old_lc);
221       if (!old_lc)
222         return OUT_OF_CORE (errno);
223     }
224   dft_lc = setlocale (LC_CTYPE, "");
225 #endif
226   if (opt.lc_ctype || (dft_ttyname && dft_lc))
227     {
228       char *optstr;
229       if (asprintf (&optstr, "OPTION lc-ctype=%s",
230                     opt.lc_ctype ? opt.lc_ctype : dft_lc) < 0)
231         rc = OUT_OF_CORE (errno);
232       else
233         {
234           rc = assuan_transact (agent_ctx, optstr, NULL, NULL, NULL, NULL, NULL,
235                                 NULL);
236           free (optstr);
237           if (rc)
238             rc = map_assuan_err (rc);
239         }
240     }
241 #if defined(HAVE_SETLOCALE) && defined(LC_CTYPE)
242   if (old_lc)
243     {
244       setlocale (LC_CTYPE, old_lc);
245       free (old_lc);
246     }
247 #endif
248   if (rc)
249     return rc;
250 #if defined(HAVE_SETLOCALE) && defined(LC_MESSAGES)
251   old_lc = setlocale (LC_MESSAGES, NULL);
252   if (old_lc)
253     {
254       old_lc = strdup (old_lc);
255       if (!old_lc)
256         return OUT_OF_CORE (errno);
257     }
258   dft_lc = setlocale (LC_MESSAGES, "");
259 #endif
260   if (opt.lc_messages || (dft_ttyname && dft_lc))
261     {
262       char *optstr;
263       if (asprintf (&optstr, "OPTION lc-messages=%s",
264                     opt.lc_messages ? opt.lc_messages : dft_lc) < 0)
265         rc = OUT_OF_CORE (errno);
266       else
267         {
268           rc = assuan_transact (agent_ctx, optstr, NULL, NULL, NULL, NULL, NULL,
269                                 NULL);
270           free (optstr);
271           if (rc)
272             rc = map_assuan_err (rc);
273         }
274     }
275 #if defined(HAVE_SETLOCALE) && defined(LC_MESSAGES)
276   if (old_lc)
277     {
278       setlocale (LC_MESSAGES, old_lc);
279       free (old_lc);
280     }
281 #endif
282
283   return rc;
284 }
285
286
287 static AssuanError
288 membuf_data_cb (void *opaque, const void *buffer, size_t length)
289 {
290   membuf_t *data = opaque;
291
292   if (buffer)
293     put_membuf (data, buffer, length);
294   return 0;
295 }
296   
297
298 \f
299 #if 0
300 /* Handle a KEYPARMS inquiry.  Note, we only send the data,
301    assuan_transact takes care of flushing and writing the end */
302 static AssuanError
303 inq_genkey_parms (void *opaque, const char *keyword)
304 {
305   struct genkey_parm_s *parm = opaque; 
306   AssuanError rc;
307
308   rc = assuan_send_data (parm->ctx, parm->sexp, parm->sexplen);
309   return rc; 
310 }
311
312
313 \f
314 /* Call the agent to generate a new key */
315 int
316 agent_genkey (KsbaConstSexp keyparms, KsbaSexp *r_pubkey)
317 {
318   int rc;
319   struct genkey_parm_s gk_parm;
320   membuf_t data;
321   size_t len;
322   char *buf;
323
324   *r_pubkey = NULL;
325   rc = start_agent ();
326   if (rc)
327     return rc;
328
329   rc = assuan_transact (agent_ctx, "RESET", NULL, NULL,
330                         NULL, NULL, NULL, NULL);
331   if (rc)
332     return map_assuan_err (rc);
333
334   init_membuf (&data, 1024);
335   gk_parm.ctx = agent_ctx;
336   gk_parm.sexp = keyparms;
337   gk_parm.sexplen = gcry_sexp_canon_len (keyparms, 0, NULL, NULL);
338   if (!gk_parm.sexplen)
339     return gpg_error (GPG_ERR_INV_VALUE);
340   rc = assuan_transact (agent_ctx, "GENKEY",
341                         membuf_data_cb, &data, 
342                         inq_genkey_parms, &gk_parm, NULL, NULL);
343   if (rc)
344     {
345       xfree (get_membuf (&data, &len));
346       return map_assuan_err (rc);
347     }
348   buf = get_membuf (&data, &len);
349   if (!buf)
350     return gpg_error (GPG_ERR_ENOMEM);
351   if (!gcry_sexp_canon_len (buf, len, NULL, NULL))
352     {
353       xfree (buf);
354       return gpg_error (GPG_ERR_INV_SEXP);
355     }
356   *r_pubkey = buf;
357   return 0;
358 }
359 #endif /*0*/
360
361
362 \f
363 /* Ask the agent whether the corresponding secret key is available for
364    the given keygrip. */
365 int
366 agent_havekey (const char *hexkeygrip)
367 {
368   int rc;
369   char line[ASSUAN_LINELENGTH];
370
371   rc = start_agent ();
372   if (rc)
373     return rc;
374
375   if (!hexkeygrip || strlen (hexkeygrip) != 40)
376     return gpg_error (GPG_ERR_INV_VALUE);
377
378   snprintf (line, DIM(line)-1, "HAVEKEY %s", hexkeygrip);
379   line[DIM(line)-1] = 0;
380
381   rc = assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
382   return map_assuan_err (rc);
383 }
384
385 \f
386 /* Ask the agent to change the passphrase of the key identified by
387    HEXKEYGRIP. */
388 int
389 agent_passwd (const char *hexkeygrip)
390 {
391   int rc;
392   char line[ASSUAN_LINELENGTH];
393
394   rc = start_agent ();
395   if (rc)
396     return rc;
397
398   if (!hexkeygrip || strlen (hexkeygrip) != 40)
399     return gpg_error (GPG_ERR_INV_VALUE);
400
401   snprintf (line, DIM(line)-1, "PASSWD %s", hexkeygrip);
402   line[DIM(line)-1] = 0;
403
404   rc = assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
405   return map_assuan_err (rc);
406 }
407