* certpath.c (gpgsm_validate_path): Ask the agent to add the
[gnupg.git] / sm / call-agent.c
1 /* call-agent.c - divert operations to the agent
2  *      Copyright (C) 2001, 2002 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 <stdio.h>
23 #include <stdlib.h>
24 #include <string.h>
25 #include <errno.h>
26 #include <unistd.h> 
27 #include <time.h>
28 #include <assert.h>
29
30 #include <gcrypt.h>
31
32 #include "gpgsm.h"
33 #include "../assuan/assuan.h"
34 #include "i18n.h"
35
36
37 static ASSUAN_CONTEXT agent_ctx = NULL;
38 static int force_pipe_server = 0;
39
40 struct cipher_parm_s {
41   ASSUAN_CONTEXT ctx;
42   const char *ciphertext;
43   size_t ciphertextlen;
44 };
45
46 struct genkey_parm_s {
47   ASSUAN_CONTEXT ctx;
48   const char *sexp;
49   size_t sexplen;
50 };
51
52
53 struct membuf {
54   size_t len;
55   size_t size;
56   char *buf;
57   int out_of_core;
58 };
59
60
61 \f
62 /* A simple implemnation of a dynamic buffer.  Use init_membuf() to
63    create a buffer, put_membuf to append bytes and get_membuf to
64    release and return the buffer.  Allocation errors are detected but
65    only returned at the final get_membuf(), this helps not to clutter
66    the code with out of core checks.  */
67
68 static void
69 init_membuf (struct membuf *mb, int initiallen)
70 {
71   mb->len = 0;
72   mb->size = initiallen;
73   mb->out_of_core = 0;
74   mb->buf = xtrymalloc (initiallen);
75   if (!mb->buf)
76       mb->out_of_core = 1;
77 }
78
79 static void
80 put_membuf (struct membuf *mb, const void *buf, size_t len)
81 {
82   if (mb->out_of_core)
83     return;
84
85   if (mb->len + len >= mb->size)
86     {
87       char *p;
88       
89       mb->size += len + 1024;
90       p = xtryrealloc (mb->buf, mb->size);
91       if (!p)
92         {
93           mb->out_of_core = 1;
94           return;
95         }
96       mb->buf = p;
97     }
98   memcpy (mb->buf + mb->len, buf, len);
99   mb->len += len;
100 }
101
102 static void *
103 get_membuf (struct membuf *mb, size_t *len)
104 {
105   char *p;
106
107   if (mb->out_of_core)
108     {
109       xfree (mb->buf);
110       mb->buf = NULL;
111       return NULL;
112     }
113
114   p = mb->buf;
115   *len = mb->len;
116   mb->buf = NULL;
117   mb->out_of_core = 1; /* don't allow a reuse */
118   return p;
119 }
120
121
122 \f
123 /* Try to connect to the agent via socket or fork it off and work by
124    pipes.  Handle the server's initial greeting */
125 static int
126 start_agent (void)
127 {
128   int rc;
129   char *infostr, *p;
130   ASSUAN_CONTEXT ctx;
131
132   if (agent_ctx)
133     return 0; /* fixme: We need a context for each thread or serialize
134                  the access to the agent (which is suitable given that
135                  the agent is not MT */
136
137   infostr = force_pipe_server? NULL : getenv ("GPG_AGENT_INFO");
138   if (!infostr)
139     {
140       const char *pgmname;
141       const char *argv[3];
142
143       log_info (_("no running gpg-agent - starting one\n"));
144       
145       if (fflush (NULL))
146         {
147           log_error ("error flushing pending output: %s\n", strerror (errno));
148           return seterr (Write_Error);
149         }
150
151       if (!opt.agent_program || !*opt.agent_program)
152         opt.agent_program = "../agent/gpg-agent";
153       if ( !(pgmname = strrchr (opt.agent_program, '/')))
154         pgmname = opt.agent_program;
155       else
156         pgmname++;
157
158       argv[0] = pgmname;
159       argv[1] = "--server";
160       argv[2] = NULL;
161
162       /* connect to the agent and perform initial handshaking */
163       rc = assuan_pipe_connect (&ctx, opt.agent_program, (char**)argv, 0);
164     }
165   else
166     {
167       int prot;
168       int pid;
169
170       infostr = xstrdup (infostr);
171       if ( !(p = strchr (infostr, ':')) || p == infostr)
172         {
173           log_error (_("malformed GPG_AGENT_INFO environment variable\n"));
174           xfree (infostr);
175           force_pipe_server = 1;
176           return start_agent ();
177         }
178       *p++ = 0;
179       pid = atoi (p);
180       while (*p && *p != ':')
181         p++;
182       prot = *p? atoi (p+1) : 0;
183       if (prot != 1)
184         {
185           log_error (_("gpg-agent protocol version %d is not supported\n"),
186                      prot);
187           xfree (infostr);
188           force_pipe_server = 1;
189           return start_agent ();
190         }
191
192       rc = assuan_socket_connect (&ctx, infostr, pid);
193       xfree (infostr);
194       if (rc == ASSUAN_Connect_Failed)
195         {
196           log_error (_("can't connect to the agent - trying fall back\n"));
197           force_pipe_server = 1;
198           return start_agent ();
199         }
200     }
201
202
203   if (rc)
204     {
205       log_error ("can't connect to the agent: %s\n", assuan_strerror (rc));
206       return seterr (No_Agent);
207     }
208   agent_ctx = ctx;
209
210   if (DBG_AGENT)
211     log_debug ("connection to agent established\n");
212   return 0;
213 }
214
215
216 static AssuanError
217 membuf_data_cb (void *opaque, const void *buffer, size_t length)
218 {
219   struct membuf *data = opaque;
220
221   put_membuf (data, buffer, length);
222   return 0;
223 }
224   
225
226
227 \f
228 /* Call the agent to do a sign operation using the key identified by
229    the hex string KEYGRIP. */
230 int
231 gpgsm_agent_pksign (const char *keygrip,
232                     unsigned char *digest, size_t digestlen, int digestalgo,
233                     char **r_buf, size_t *r_buflen )
234 {
235   int rc, i;
236   char *p, line[ASSUAN_LINELENGTH];
237   struct membuf data;
238   size_t len;
239
240   *r_buf = NULL;
241   rc = start_agent ();
242   if (rc)
243     return rc;
244
245   if (digestlen*2 + 50 > DIM(line))
246     return seterr (General_Error);
247
248   rc = assuan_transact (agent_ctx, "RESET", NULL, NULL, NULL, NULL);
249   if (rc)
250     return map_assuan_err (rc);
251
252   snprintf (line, DIM(line)-1, "SIGKEY %s", keygrip);
253   line[DIM(line)-1] = 0;
254   rc = assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL);
255   if (rc)
256     return map_assuan_err (rc);
257
258   sprintf (line, "SETHASH %d ", digestalgo);
259   p = line + strlen (line);
260   for (i=0; i < digestlen ; i++, p += 2 )
261     sprintf (p, "%02X", digest[i]);
262   rc = assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL);
263   if (rc)
264     return map_assuan_err (rc);
265
266   init_membuf (&data, 1024);
267   rc = assuan_transact (agent_ctx, "PKSIGN",
268                         membuf_data_cb, &data, NULL, NULL);
269   if (rc)
270     {
271       xfree (get_membuf (&data, &len));
272       return map_assuan_err (rc);
273     }
274   *r_buf = get_membuf (&data, r_buflen);
275
276   if (!gcry_sexp_canon_len (*r_buf, *r_buflen, NULL, NULL))
277     {
278       xfree (*r_buf); *r_buf = NULL;
279       return GNUPG_Invalid_Value;
280     }
281
282   return *r_buf? 0 : GNUPG_Out_Of_Core;
283 }
284
285
286
287 \f
288 /* Handle a CIPHERTEXT inquiry.  Note, we only send the data,
289    assuan_transact talkes care of flushing and writing the end */
290 static AssuanError
291 inq_ciphertext_cb (void *opaque, const char *keyword)
292 {
293   struct cipher_parm_s *parm = opaque; 
294   AssuanError rc;
295
296   assuan_begin_confidential (parm->ctx);
297   rc = assuan_send_data (parm->ctx, parm->ciphertext, parm->ciphertextlen);
298   assuan_end_confidential (parm->ctx);
299   return rc; 
300 }
301
302
303 /* Call the agent to do a decrypt operation using the key identified by
304    the hex string KEYGRIP. */
305 int
306 gpgsm_agent_pkdecrypt (const char *keygrip,
307                        KsbaConstSexp ciphertext, 
308                        char **r_buf, size_t *r_buflen )
309 {
310   int rc;
311   char line[ASSUAN_LINELENGTH];
312   struct membuf data;
313   struct cipher_parm_s cipher_parm;
314   size_t n, len;
315   char *buf, *endp;
316   size_t ciphertextlen;
317   
318   if (!keygrip || strlen(keygrip) != 40 || !ciphertext || !r_buf || !r_buflen)
319     return GNUPG_Invalid_Value;
320   *r_buf = NULL;
321
322   ciphertextlen = gcry_sexp_canon_len (ciphertext, 0, NULL, NULL);
323   if (!ciphertextlen)
324     return GNUPG_Invalid_Value;
325
326   rc = start_agent ();
327   if (rc)
328     return rc;
329
330   rc = assuan_transact (agent_ctx, "RESET", NULL, NULL, NULL, NULL);
331   if (rc)
332     return map_assuan_err (rc);
333
334   assert ( DIM(line) >= 50 );
335   snprintf (line, DIM(line)-1, "SETKEY %s", keygrip);
336   line[DIM(line)-1] = 0;
337   rc = assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL);
338   if (rc)
339     return map_assuan_err (rc);
340
341   init_membuf (&data, 1024);
342   cipher_parm.ctx = agent_ctx;
343   cipher_parm.ciphertext = ciphertext;
344   cipher_parm.ciphertextlen = ciphertextlen;
345   rc = assuan_transact (agent_ctx, "PKDECRYPT",
346                         membuf_data_cb, &data,
347                         inq_ciphertext_cb, &cipher_parm);
348   if (rc)
349     {
350       xfree (get_membuf (&data, &len));
351       return map_assuan_err (rc);
352     }
353
354   put_membuf (&data, "", 1); /* make sure it is 0 terminated */
355   buf = get_membuf (&data, &len);
356   if (!buf)
357     return seterr (Out_Of_Core);
358   /* FIXME: We would better a return a full S-exp and not just a part */
359   assert (len);
360   len--; /* remove the terminating 0 */
361   n = strtoul (buf, &endp, 10);
362   if (!n || *endp != ':')
363     return seterr (Invalid_Sexp);
364   endp++;
365   if (endp-buf+n > len)
366     return seterr (Invalid_Sexp); /* oops len does not match internal len*/
367   memmove (buf, endp, n);
368   *r_buflen = n;
369   *r_buf = buf;
370   return 0;
371 }
372
373
374
375
376 \f
377 /* Handle a KEYPARMS inquiry.  Note, we only send the data,
378    assuan_transact takes care of flushing and writing the end */
379 static AssuanError
380 inq_genkey_parms (void *opaque, const char *keyword)
381 {
382   struct genkey_parm_s *parm = opaque; 
383   AssuanError rc;
384
385   rc = assuan_send_data (parm->ctx, parm->sexp, parm->sexplen);
386   return rc; 
387 }
388
389
390 \f
391 /* Call the agent to generate a newkey */
392 int
393 gpgsm_agent_genkey (KsbaConstSexp keyparms, KsbaSexp *r_pubkey)
394 {
395   int rc;
396   struct genkey_parm_s gk_parm;
397   struct membuf data;
398   size_t len;
399   char *buf;
400
401   *r_pubkey = NULL;
402   rc = start_agent ();
403   if (rc)
404     return rc;
405
406   rc = assuan_transact (agent_ctx, "RESET", NULL, NULL, NULL, NULL);
407   if (rc)
408     return map_assuan_err (rc);
409
410   init_membuf (&data, 1024);
411   gk_parm.ctx = agent_ctx;
412   gk_parm.sexp = keyparms;
413   gk_parm.sexplen = gcry_sexp_canon_len (keyparms, 0, NULL, NULL);
414   if (!gk_parm.sexplen)
415     return GNUPG_Invalid_Value;
416   rc = assuan_transact (agent_ctx, "GENKEY",
417                         membuf_data_cb, &data, 
418                         inq_genkey_parms, &gk_parm);
419   if (rc)
420     {
421       xfree (get_membuf (&data, &len));
422       return map_assuan_err (rc);
423     }
424   buf = get_membuf (&data, &len);
425   if (!buf)
426     return GNUPG_Out_Of_Core;
427   if (!gcry_sexp_canon_len (buf, len, NULL, NULL))
428     {
429       xfree (buf);
430       return GNUPG_Invalid_Sexp;
431     }
432   *r_pubkey = buf;
433   return 0;
434 }
435
436 \f
437 /* Ask the agent whether the certificate is in the list of trusted
438    keys */
439 int
440 gpgsm_agent_istrusted (KsbaCert cert)
441 {
442   int rc;
443   char *fpr;
444   char line[ASSUAN_LINELENGTH];
445
446   rc = start_agent ();
447   if (rc)
448     return rc;
449
450   fpr = gpgsm_get_fingerprint_hexstring (cert, GCRY_MD_SHA1);
451   if (!fpr)
452     {
453       log_error ("error getting the fingerprint\n");
454       return seterr (General_Error);
455     }
456
457   snprintf (line, DIM(line)-1, "ISTRUSTED %s", fpr);
458   line[DIM(line)-1] = 0;
459   xfree (fpr);
460
461   rc = assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL);
462   return map_assuan_err (rc);
463 }
464
465 /* Ask the agent to mark CERT as a trusted Root-CA one */
466 int
467 gpgsm_agent_marktrusted (KsbaCert cert)
468 {
469   int rc;
470   char *fpr, *dn;
471   char line[ASSUAN_LINELENGTH];
472
473   rc = start_agent ();
474   if (rc)
475     return rc;
476
477   fpr = gpgsm_get_fingerprint_hexstring (cert, GCRY_MD_SHA1);
478   if (!fpr)
479     {
480       log_error ("error getting the fingerprint\n");
481       return seterr (General_Error);
482     }
483
484   dn = ksba_cert_get_issuer (cert, 0);
485   if (!dn)
486     {
487       xfree (fpr);
488       return seterr (General_Error);
489     }
490   snprintf (line, DIM(line)-1, "MARKTRUSTED %s S %s", fpr, dn);
491   line[DIM(line)-1] = 0;
492   ksba_free (dn);
493   xfree (fpr);
494
495   rc = assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL);
496   return map_assuan_err (rc);
497 }
498
499
500 \f
501 /* Ask the agent whether the a corresponding secret key is available
502    for the given keygrip */
503 int
504 gpgsm_agent_havekey (const char *hexkeygrip)
505 {
506   int rc;
507   char line[ASSUAN_LINELENGTH];
508
509   rc = start_agent ();
510   if (rc)
511     return rc;
512
513   if (!hexkeygrip || strlen (hexkeygrip) != 40)
514     return GNUPG_Invalid_Value;
515
516   snprintf (line, DIM(line)-1, "HAVEKEY %s", hexkeygrip);
517   line[DIM(line)-1] = 0;
518
519   rc = assuan_transact (agent_ctx, line, NULL, NULL, NULL, NULL);
520   return map_assuan_err (rc);
521 }
522