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