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