* mainproc.c (check_sig_and_print): Get the uid validity before printing
[gnupg.git] / agent / call-scd.c
1 /* call-scd.c - fork of the scdaemon to do SC operations
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 /* Fixme: For now we have serialized all access to the scdaemon which
22    make sense becuase the scdaemon can't handle concurrent connections
23    right now.  We should however keep a list of connections and lock
24    just that connection - it migth make sense to implemtn parts of
25    this in Assuan.*/
26
27 #include <config.h>
28 #include <errno.h>
29 #include <stdio.h>
30 #include <stdlib.h>
31 #include <string.h>
32 #include <ctype.h>
33 #include <assert.h>
34 #include <unistd.h>
35 #include <sys/stat.h>
36 #ifdef USE_GNU_PTH
37 # include <pth.h>
38 #endif
39
40 #include "agent.h"
41 #include <assuan.h>
42
43 #ifdef _POSIX_OPEN_MAX
44 #define MAX_OPEN_FDS _POSIX_OPEN_MAX
45 #else
46 #define MAX_OPEN_FDS 20
47 #endif
48
49 static ASSUAN_CONTEXT scd_ctx = NULL;
50 #ifdef USE_GNU_PTH
51 static pth_mutex_t scd_lock = PTH_MUTEX_INIT;
52 #endif
53
54 /* callback parameter for learn card */
55 struct learn_parm_s {
56   void (*kpinfo_cb)(void*, const char *);
57   void *kpinfo_cb_arg;
58   void (*certinfo_cb)(void*, const char *);
59   void *certinfo_cb_arg;
60   void (*sinfo_cb)(void*, const char *, size_t, const char *);
61   void *sinfo_cb_arg;
62 };
63
64 struct inq_needpin_s {
65   ASSUAN_CONTEXT ctx;
66   int (*getpin_cb)(void *, const char *, char*, size_t);
67   void *getpin_cb_arg;
68 };
69
70 struct membuf {
71   size_t len;
72   size_t size;
73   char *buf;
74   int out_of_core;
75 };
76
77
78 \f
79 /* A simple implementation of a dynamic buffer.  Use init_membuf() to
80    create a buffer, put_membuf to append bytes and get_membuf to
81    release and return the buffer.  Allocation errors are detected but
82    only returned at the final get_membuf(), this helps not to clutter
83    the code with out of core checks.  */
84
85 static void
86 init_membuf (struct membuf *mb, int initiallen)
87 {
88   mb->len = 0;
89   mb->size = initiallen;
90   mb->out_of_core = 0;
91   mb->buf = xtrymalloc (initiallen);
92   if (!mb->buf)
93       mb->out_of_core = 1;
94 }
95
96 static void
97 put_membuf (struct membuf *mb, const void *buf, size_t len)
98 {
99   if (mb->out_of_core)
100     return;
101
102   if (mb->len + len >= mb->size)
103     {
104       char *p;
105       
106       mb->size += len + 1024;
107       p = xtryrealloc (mb->buf, mb->size);
108       if (!p)
109         {
110           mb->out_of_core = 1;
111           return;
112         }
113       mb->buf = p;
114     }
115   memcpy (mb->buf + mb->len, buf, len);
116   mb->len += len;
117 }
118
119 static void *
120 get_membuf (struct membuf *mb, size_t *len)
121 {
122   char *p;
123
124   if (mb->out_of_core)
125     {
126       xfree (mb->buf);
127       mb->buf = NULL;
128       return NULL;
129     }
130
131   p = mb->buf;
132   *len = mb->len;
133   mb->buf = NULL;
134   mb->out_of_core = 1; /* don't allow a reuse */
135   return p;
136 }
137
138
139
140 \f
141 static int 
142 unlock_scd (int rc)
143 {
144 #ifdef USE_GNU_PTH
145   if (!pth_mutex_release (&scd_lock))
146     {
147       log_error ("failed to release the SCD lock\n");
148       if (!rc)
149         rc = gpg_error (GPG_ERR_INTERNAL);
150     }
151 #endif
152   return rc;
153 }
154
155 /* Fork off the SCdaemon if this has not already been done */
156 static int
157 start_scd (void)
158 {
159   int rc;
160   const char *pgmname;
161   ASSUAN_CONTEXT ctx;
162   const char *argv[3];
163   int no_close_list[3];
164   int i;
165
166 #ifdef USE_GNU_PTH
167   if (!pth_mutex_acquire (&scd_lock, 0, NULL))
168     {
169       log_error ("failed to acquire the SCD lock\n");
170       return gpg_error (GPG_ERR_INTERNAL);
171     }
172 #endif
173
174   if (scd_ctx)
175     return 0; /* No need to serialize things because the agent is
176                  expected to tun as a single-thread (or may be in
177                  future using libpth) */
178
179   if (opt.verbose)
180     log_info ("no running SCdaemon - starting it\n");
181       
182   if (fflush (NULL))
183     {
184       gpg_error_t tmperr = gpg_error (gpg_err_code_from_errno (errno));
185       log_error ("error flushing pending output: %s\n", strerror (errno));
186       return unlock_scd (tmperr);
187     }
188
189   if (!opt.scdaemon_program || !*opt.scdaemon_program)
190     opt.scdaemon_program = GNUPG_DEFAULT_SCDAEMON;
191   if ( !(pgmname = strrchr (opt.scdaemon_program, '/')))
192     pgmname = opt.scdaemon_program;
193   else
194     pgmname++;
195
196   argv[0] = pgmname;
197   argv[1] = "--server";
198   argv[2] = NULL;
199
200   i=0;
201   if (!opt.running_detached)
202     {
203       if (log_get_fd () != -1)
204         no_close_list[i++] = log_get_fd ();
205       no_close_list[i++] = fileno (stderr);
206     }
207   no_close_list[i] = -1;
208
209   /* connect to the pinentry and perform initial handshaking */
210   rc = assuan_pipe_connect (&ctx, opt.scdaemon_program, (char**)argv,
211                             no_close_list);
212   if (rc)
213     {
214       log_error ("can't connect to the SCdaemon: %s\n",
215                  assuan_strerror (rc));
216       return unlock_scd (gpg_error (GPG_ERR_NO_SCDAEMON));
217     }
218   scd_ctx = ctx;
219   
220   if (DBG_ASSUAN)
221     log_debug ("connection to SCdaemon established\n");
222   return 0;
223 }
224
225
226 \f
227 static AssuanError
228 learn_status_cb (void *opaque, const char *line)
229 {
230   struct learn_parm_s *parm = opaque;
231   const char *keyword = line;
232   int keywordlen;
233
234   for (keywordlen=0; *line && !spacep (line); line++, keywordlen++)
235     ;
236   while (spacep (line))
237     line++;
238   if (keywordlen == 8 && !memcmp (keyword, "CERTINFO", keywordlen))
239     {
240       parm->certinfo_cb (parm->certinfo_cb_arg, line);
241     }
242   else if (keywordlen == 11 && !memcmp (keyword, "KEYPAIRINFO", keywordlen))
243     {
244       parm->kpinfo_cb (parm->kpinfo_cb_arg, line);
245     }
246   else if (keywordlen && *line)
247     {
248       parm->sinfo_cb (parm->sinfo_cb_arg, keyword, keywordlen, line);
249     }
250   
251   return 0;
252 }
253
254 /* Perform the learn command and return a list of all private keys
255    stored on the card. */
256 int
257 agent_card_learn (void (*kpinfo_cb)(void*, const char *),
258                   void *kpinfo_cb_arg,
259                   void (*certinfo_cb)(void*, const char *),
260                   void *certinfo_cb_arg,
261                   void (*sinfo_cb)(void*, const char *, size_t, const char *),
262                   void *sinfo_cb_arg)
263 {
264   int rc;
265   struct learn_parm_s parm;
266
267   rc = start_scd ();
268   if (rc)
269     return rc;
270
271   memset (&parm, 0, sizeof parm);
272   parm.kpinfo_cb = kpinfo_cb;
273   parm.kpinfo_cb_arg = kpinfo_cb_arg;
274   parm.certinfo_cb = certinfo_cb;
275   parm.certinfo_cb_arg = certinfo_cb_arg;
276   parm.sinfo_cb = sinfo_cb;
277   parm.sinfo_cb_arg = sinfo_cb_arg;
278   rc = assuan_transact (scd_ctx, "LEARN --force",
279                         NULL, NULL, NULL, NULL,
280                         learn_status_cb, &parm);
281   if (rc)
282     return unlock_scd (map_assuan_err (rc));
283
284   return unlock_scd (0);
285 }
286
287
288 \f
289 static AssuanError
290 get_serialno_cb (void *opaque, const char *line)
291 {
292   char **serialno = opaque;
293   const char *keyword = line;
294   const char *s;
295   int keywordlen, n;
296
297   for (keywordlen=0; *line && !spacep (line); line++, keywordlen++)
298     ;
299   while (spacep (line))
300     line++;
301
302   if (keywordlen == 8 && !memcmp (keyword, "SERIALNO", keywordlen))
303     {
304       if (*serialno)
305         return ASSUAN_Unexpected_Status;
306       for (n=0,s=line; hexdigitp (s); s++, n++)
307         ;
308       if (!n || (n&1)|| !(spacep (s) || !*s) )
309         return ASSUAN_Invalid_Status;
310       *serialno = xtrymalloc (n+1);
311       if (!*serialno)
312         return ASSUAN_Out_Of_Core;
313       memcpy (*serialno, line, n);
314       (*serialno)[n] = 0;
315     }
316   
317   return 0;
318 }
319
320 /* Return the serial number of the card or an appropriate error.  The
321    serial number is returned as a hexstring. */
322 int
323 agent_card_serialno (char **r_serialno)
324 {
325   int rc;
326   char *serialno = NULL;
327
328   rc = start_scd ();
329   if (rc)
330     return rc;
331
332   /* Hmm, do we really need this reset - scddaemon should do this or
333      we can do this if we for some reason figure out that the
334      operation might have failed due to a missing RESET.  Hmmm, I feel
335      this is really SCdaemon's duty */
336 /*    rc = assuan_transact (scd_ctx, "RESET", NULL, NULL, NULL, NULL, NULL, NULL); */
337 /*    if (rc) */
338 /*      return unlock_scd (map_assuan_err (rc)); */
339
340   rc = assuan_transact (scd_ctx, "SERIALNO",
341                         NULL, NULL, NULL, NULL,
342                         get_serialno_cb, &serialno);
343   if (rc)
344     {
345       xfree (serialno);
346       return unlock_scd (map_assuan_err (rc));
347     }
348   *r_serialno = serialno;
349   return unlock_scd (0);
350 }
351
352 \f
353 static AssuanError
354 membuf_data_cb (void *opaque, const void *buffer, size_t length)
355 {
356   struct membuf *data = opaque;
357
358   if (buffer)
359     put_membuf (data, buffer, length);
360   return 0;
361 }
362   
363 /* Handle the NEEDPIN inquiry. */
364 static AssuanError
365 inq_needpin (void *opaque, const char *line)
366 {
367   struct inq_needpin_s *parm = opaque;
368   char *pin;
369   size_t pinlen;
370   int rc;
371
372   if (!(!strncmp (line, "NEEDPIN", 7) && (line[7] == ' ' || !line[7])))
373     {
374       log_error ("unsupported inquiry `%s'\n", line);
375       return ASSUAN_Inquire_Unknown;
376     }
377   line += 7;
378
379   pinlen = 90;
380   pin = gcry_malloc_secure (pinlen);
381   if (!pin)
382     return ASSUAN_Out_Of_Core;
383
384   rc = parm->getpin_cb (parm->getpin_cb_arg, line, pin, pinlen);
385   if (rc)
386     rc = ASSUAN_Canceled;
387   if (!rc)
388     rc = assuan_send_data (parm->ctx, pin, pinlen);
389   xfree (pin);
390
391   return rc;
392 }
393
394
395
396 /* Create a signature using the current card */
397 int
398 agent_card_pksign (const char *keyid,
399                    int (*getpin_cb)(void *, const char *, char*, size_t),
400                    void *getpin_cb_arg,
401                    const unsigned char *indata, size_t indatalen,
402                    char **r_buf, size_t *r_buflen)
403 {
404   int rc, i;
405   char *p, line[ASSUAN_LINELENGTH];
406   struct membuf data;
407   struct inq_needpin_s inqparm;
408   size_t len;
409   unsigned char *sigbuf;
410   size_t sigbuflen;
411
412   *r_buf = NULL;
413   rc = start_scd ();
414   if (rc)
415     return rc;
416
417   if (indatalen*2 + 50 > DIM(line))
418     return unlock_scd (gpg_error (GPG_ERR_GENERAL));
419
420   sprintf (line, "SETDATA ");
421   p = line + strlen (line);
422   for (i=0; i < indatalen ; i++, p += 2 )
423     sprintf (p, "%02X", indata[i]);
424   rc = assuan_transact (scd_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
425   if (rc)
426     return unlock_scd (map_assuan_err (rc));
427
428   init_membuf (&data, 1024);
429   inqparm.ctx = scd_ctx;
430   inqparm.getpin_cb = getpin_cb;
431   inqparm.getpin_cb_arg = getpin_cb_arg;
432   snprintf (line, DIM(line)-1, "PKSIGN %s", keyid);
433   line[DIM(line)-1] = 0;
434   rc = assuan_transact (scd_ctx, line,
435                         membuf_data_cb, &data,
436                         inq_needpin, &inqparm,
437                         NULL, NULL);
438   if (rc)
439     {
440       xfree (get_membuf (&data, &len));
441       return unlock_scd (map_assuan_err (rc));
442     }
443   sigbuf = get_membuf (&data, &sigbuflen);
444
445   /* create an S-expression from it which is formatted like this:
446      "(7:sig-val(3:rsa(1:sSIGBUFLEN:SIGBUF)))" */
447   *r_buflen = 21 + 11 + sigbuflen + 4;
448   *r_buf = xtrymalloc (*r_buflen);
449   if (!*r_buf)
450     {
451       gpg_error_t tmperr = out_of_core ();
452       xfree (*r_buf);
453       return unlock_scd (tmperr);
454     }
455   p = stpcpy (*r_buf, "(7:sig-val(3:rsa(1:s" );
456   sprintf (p, "%u:", (unsigned int)sigbuflen);
457   p += strlen (p);
458   memcpy (p, sigbuf, sigbuflen);
459   p += sigbuflen;
460   strcpy (p, ")))");
461   xfree (sigbuf);
462
463   assert (gcry_sexp_canon_len (*r_buf, *r_buflen, NULL, NULL));
464   return unlock_scd (0);
465 }
466
467 /* Decipher INDATA using the current card. Note that the returned value is */
468 int
469 agent_card_pkdecrypt (const char *keyid,
470                    int (*getpin_cb)(void *, const char *, char*, size_t),
471                    void *getpin_cb_arg,
472                    const unsigned char *indata, size_t indatalen,
473                    char **r_buf, size_t *r_buflen)
474 {
475   int rc, i;
476   char *p, line[ASSUAN_LINELENGTH];
477   struct membuf data;
478   struct inq_needpin_s inqparm;
479   size_t len;
480
481   *r_buf = NULL;
482   rc = start_scd ();
483   if (rc)
484     return rc;
485
486   /* FIXME: use secure memory where appropriate */
487   if (indatalen*2 + 50 > DIM(line))
488     return unlock_scd (gpg_error (GPG_ERR_GENERAL));
489
490   sprintf (line, "SETDATA ");
491   p = line + strlen (line);
492   for (i=0; i < indatalen ; i++, p += 2 )
493     sprintf (p, "%02X", indata[i]);
494   rc = assuan_transact (scd_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
495   if (rc)
496     return unlock_scd (map_assuan_err (rc));
497
498   init_membuf (&data, 1024);
499   inqparm.ctx = scd_ctx;
500   inqparm.getpin_cb = getpin_cb;
501   inqparm.getpin_cb_arg = getpin_cb_arg;
502   snprintf (line, DIM(line)-1, "PKDECRYPT %s", keyid);
503   line[DIM(line)-1] = 0;
504   rc = assuan_transact (scd_ctx, line,
505                         membuf_data_cb, &data,
506                         inq_needpin, &inqparm,
507                         NULL, NULL);
508   if (rc)
509     {
510       xfree (get_membuf (&data, &len));
511       return unlock_scd (map_assuan_err (rc));
512     }
513   *r_buf = get_membuf (&data, r_buflen);
514   if (!*r_buf)
515     return unlock_scd (gpg_error (GPG_ERR_ENOMEM));
516
517   return unlock_scd (0);
518 }
519
520
521 \f
522 /* Read a certificate with ID into R_BUF and R_BUFLEN. */
523 int
524 agent_card_readcert (const char *id, char **r_buf, size_t *r_buflen)
525 {
526   int rc;
527   char line[ASSUAN_LINELENGTH];
528   struct membuf data;
529   size_t len;
530
531   *r_buf = NULL;
532   rc = start_scd ();
533   if (rc)
534     return rc;
535
536   init_membuf (&data, 1024);
537   snprintf (line, DIM(line)-1, "READCERT %s", id);
538   line[DIM(line)-1] = 0;
539   rc = assuan_transact (scd_ctx, line,
540                         membuf_data_cb, &data,
541                         NULL, NULL,
542                         NULL, NULL);
543   if (rc)
544     {
545       xfree (get_membuf (&data, &len));
546       return unlock_scd (map_assuan_err (rc));
547     }
548   *r_buf = get_membuf (&data, r_buflen);
549   if (!*r_buf)
550     return unlock_scd (gpg_error (GPG_ERR_ENOMEM));
551
552   return unlock_scd (0);
553 }
554
555
556 \f
557 /* Read a key with ID and return it in an allocate buffer pointed to
558    by r_BUF as a valid S-expression. */
559 int
560 agent_card_readkey (const char *id, unsigned char **r_buf)
561 {
562   int rc;
563   char line[ASSUAN_LINELENGTH];
564   struct membuf data;
565   size_t len, buflen;
566
567   *r_buf = NULL;
568   rc = start_scd ();
569   if (rc)
570     return rc;
571
572   init_membuf (&data, 1024);
573   snprintf (line, DIM(line)-1, "READKEY %s", id);
574   line[DIM(line)-1] = 0;
575   rc = assuan_transact (scd_ctx, line,
576                         membuf_data_cb, &data,
577                         NULL, NULL,
578                         NULL, NULL);
579   if (rc)
580     {
581       xfree (get_membuf (&data, &len));
582       return unlock_scd (map_assuan_err (rc));
583     }
584   *r_buf = get_membuf (&data, &buflen);
585   if (!*r_buf)
586     return unlock_scd (gpg_error (GPG_ERR_ENOMEM));
587
588   if (!gcry_sexp_canon_len (*r_buf, buflen, NULL, NULL))
589     {
590       xfree (*r_buf); *r_buf = NULL;
591       return unlock_scd (gpg_error (GPG_ERR_INV_VALUE));
592     }
593
594   return unlock_scd (0);
595 }
596
597
598
599 \f
600 static AssuanError
601 pass_status_thru (void *opaque, const char *line)
602 {
603   ASSUAN_CONTEXT ctx = opaque;
604   char keyword[200];
605   int i;
606
607   for (i=0; *line && !spacep (line) && i < DIM(keyword)-1; line++, i++)
608     keyword[i] = *line;
609   keyword[i] = 0;
610   /* truncate any remaining keyword stuff. */
611   for (; *line && !spacep (line); line++)
612     ;
613   while (spacep (line))
614     line++;
615
616   assuan_write_status (ctx, keyword, line);
617   return 0;
618 }
619
620 static AssuanError
621 pass_data_thru (void *opaque, const void *buffer, size_t length)
622 {
623   ASSUAN_CONTEXT ctx = opaque;
624
625   assuan_send_data (ctx, buffer, length);
626   return 0;
627 }
628
629
630 /* Send the line CMDLINE with command for the SCDdaemon to it and send
631    all status messages back.  This command is used as a general quoting
632    mechanism to pass everything verbatim to SCDAEMOPN.  The PIN
633    inquirey is handled inside gpg-agent. */
634 int
635 agent_card_scd (const char *cmdline,
636                 int (*getpin_cb)(void *, const char *, char*, size_t),
637                 void *getpin_cb_arg, void *assuan_context)
638 {
639   int rc;
640   struct inq_needpin_s inqparm;
641
642   rc = start_scd ();
643   if (rc)
644     return rc;
645
646   inqparm.ctx = scd_ctx;
647   inqparm.getpin_cb = getpin_cb;
648   inqparm.getpin_cb_arg = getpin_cb_arg;
649   rc = assuan_transact (scd_ctx, cmdline,
650                         pass_data_thru, assuan_context,
651                         inq_needpin, &inqparm,
652                         pass_status_thru, assuan_context);
653   if (rc)
654     {
655       return unlock_scd (map_assuan_err (rc));
656     }
657
658   return unlock_scd (0);
659 }
660
661