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