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