* no-pth.c, Makefile.am: Removed.
[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/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 };
59
60 struct inq_needpin_s {
61   ASSUAN_CONTEXT ctx;
62   int (*getpin_cb)(void *, const char *, char*, size_t);
63   void *getpin_cb_arg;
64 };
65
66 struct membuf {
67   size_t len;
68   size_t size;
69   char *buf;
70   int out_of_core;
71 };
72
73
74 \f
75 /* A simple implementation of a dynamic buffer.  Use init_membuf() to
76    create a buffer, put_membuf to append bytes and get_membuf to
77    release and return the buffer.  Allocation errors are detected but
78    only returned at the final get_membuf(), this helps not to clutter
79    the code with out of core checks.  */
80
81 static void
82 init_membuf (struct membuf *mb, int initiallen)
83 {
84   mb->len = 0;
85   mb->size = initiallen;
86   mb->out_of_core = 0;
87   mb->buf = xtrymalloc (initiallen);
88   if (!mb->buf)
89       mb->out_of_core = 1;
90 }
91
92 static void
93 put_membuf (struct membuf *mb, const void *buf, size_t len)
94 {
95   if (mb->out_of_core)
96     return;
97
98   if (mb->len + len >= mb->size)
99     {
100       char *p;
101       
102       mb->size += len + 1024;
103       p = xtryrealloc (mb->buf, mb->size);
104       if (!p)
105         {
106           mb->out_of_core = 1;
107           return;
108         }
109       mb->buf = p;
110     }
111   memcpy (mb->buf + mb->len, buf, len);
112   mb->len += len;
113 }
114
115 static void *
116 get_membuf (struct membuf *mb, size_t *len)
117 {
118   char *p;
119
120   if (mb->out_of_core)
121     {
122       xfree (mb->buf);
123       mb->buf = NULL;
124       return NULL;
125     }
126
127   p = mb->buf;
128   *len = mb->len;
129   mb->buf = NULL;
130   mb->out_of_core = 1; /* don't allow a reuse */
131   return p;
132 }
133
134
135
136 \f
137 static int 
138 unlock_scd (int rc)
139 {
140 #ifdef USE_GNU_PTH
141   if (!pth_mutex_release (&scd_lock))
142     {
143       log_error ("failed to release the SCD lock\n");
144       if (!rc)
145         rc = GNUPG_Internal_Error;
146     }
147 #endif
148   return rc;
149 }
150
151 /* Fork off the SCdaemon if this has not already been done */
152 static int
153 start_scd (void)
154 {
155   int rc;
156   const char *pgmname;
157   ASSUAN_CONTEXT ctx;
158   const char *argv[3];
159
160 #ifdef USE_GNU_PTH
161   if (!pth_mutex_acquire (&scd_lock, 0, NULL))
162     {
163       log_error ("failed to acquire the SCD lock\n");
164       return GNUPG_Internal_Error;
165     }
166 #endif
167
168   if (scd_ctx)
169     return 0; /* No need to serialize things because the agent is
170                  expected to tun as a single-thread (or may be in
171                  future using libpth) */
172
173   if (opt.verbose)
174     log_info ("no running SCdaemon - starting it\n");
175       
176   if (fflush (NULL))
177     {
178       log_error ("error flushing pending output: %s\n", strerror (errno));
179       return unlock_scd (seterr (Write_Error));
180     }
181
182   /* FIXME: change the default location of the program */
183   if (!opt.scdaemon_program || !*opt.scdaemon_program)
184     opt.scdaemon_program = "../scd/scdaemon";
185   if ( !(pgmname = strrchr (opt.scdaemon_program, '/')))
186     pgmname = opt.scdaemon_program;
187   else
188     pgmname++;
189
190   argv[0] = pgmname;
191   argv[1] = "--server";
192   argv[2] = NULL;
193
194   /* connect to the pinentry and perform initial handshaking */
195   rc = assuan_pipe_connect (&ctx, opt.scdaemon_program, (char**)argv, 0);
196   if (rc)
197     {
198       log_error ("can't connect to the SCdaemon: %s\n",
199                  assuan_strerror (rc));
200       return unlock_scd (seterr (No_Scdaemon));
201     }
202   scd_ctx = ctx;
203   
204   if (DBG_ASSUAN)
205     log_debug ("connection to SCdaemon established\n");
206   return 0;
207 }
208
209
210 \f
211 static AssuanError
212 learn_status_cb (void *opaque, const char *line)
213 {
214   struct learn_parm_s *parm = opaque;
215   const char *keyword = line;
216   int keywordlen;
217
218   for (keywordlen=0; *line && !spacep (line); line++, keywordlen++)
219     ;
220   while (spacep (line))
221     line++;
222   if (keywordlen == 11 && !memcmp (keyword, "KEYPAIRINFO", keywordlen))
223     {
224       parm->kpinfo_cb (parm->kpinfo_cb_arg, line);
225     }
226   else if (keywordlen == 8 && !memcmp (keyword, "SERIALNO", keywordlen))
227     {
228       log_debug ("learn_status_cb: serialno `%s'\n", line);
229     }
230   else
231     log_debug ("learn_status_cb: ignoring `%.*s'\n", keywordlen, keyword);
232   
233   return 0;
234 }
235
236 /* Perform the learn command and return a list of all private keys
237    stored on the card. */
238 int
239 agent_card_learn (void (*kpinfo_cb)(void*, const char *), void *kpinfo_cb_arg)
240 {
241   int rc;
242   struct learn_parm_s parm;
243
244   rc = start_scd ();
245   if (rc)
246     return rc;
247
248   memset (&parm, 0, sizeof parm);
249   parm.kpinfo_cb = kpinfo_cb;
250   parm.kpinfo_cb_arg = kpinfo_cb_arg;
251   rc = assuan_transact (scd_ctx, "LEARN --force",
252                         NULL, NULL, NULL, NULL,
253                         learn_status_cb, &parm);
254   if (rc)
255     return unlock_scd (map_assuan_err (rc));
256
257   return unlock_scd (0);
258 }
259
260
261 \f
262 static AssuanError
263 get_serialno_cb (void *opaque, const char *line)
264 {
265   char **serialno = opaque;
266   const char *keyword = line;
267   const char *s;
268   int keywordlen, n;
269
270   for (keywordlen=0; *line && !spacep (line); line++, keywordlen++)
271     ;
272   while (spacep (line))
273     line++;
274
275   if (keywordlen == 8 && !memcmp (keyword, "SERIALNO", keywordlen))
276     {
277       if (*serialno)
278         return ASSUAN_Unexpected_Status;
279       for (n=0,s=line; hexdigitp (s); s++, n++)
280         ;
281       if (!n || (n&1)|| !(spacep (s) || !*s) )
282         return ASSUAN_Invalid_Status;
283       *serialno = xtrymalloc (n+1);
284       if (!*serialno)
285         return ASSUAN_Out_Of_Core;
286       memcpy (*serialno, line, n);
287       (*serialno)[n] = 0;
288     }
289   
290   return 0;
291 }
292
293 /* Return the serial number of the card or an appropriate error.  The
294    serial number is returned as a hexstring. */
295 int
296 agent_card_serialno (char **r_serialno)
297 {
298   int rc;
299   char *serialno = NULL;
300
301   rc = start_scd ();
302   if (rc)
303     return rc;
304
305   /* Hmm, do we really need this reset - scddaemon should do this or
306      we can do this if we for some reason figure out that the
307      operation might have failed due to a missing RESET.  Hmmm, I feel
308      this is really SCdaemon's duty */
309   rc = assuan_transact (scd_ctx, "RESET", NULL, NULL, NULL, NULL, NULL, NULL);
310   if (rc)
311     return unlock_scd (map_assuan_err (rc));
312
313   rc = assuan_transact (scd_ctx, "SERIALNO",
314                         NULL, NULL, NULL, NULL,
315                         get_serialno_cb, &serialno);
316   if (rc)
317     {
318       xfree (serialno);
319       return unlock_scd (map_assuan_err (rc));
320     }
321   *r_serialno = serialno;
322   return unlock_scd (0);
323 }
324
325 \f
326 static AssuanError
327 membuf_data_cb (void *opaque, const void *buffer, size_t length)
328 {
329   struct membuf *data = opaque;
330
331   if (buffer)
332     put_membuf (data, buffer, length);
333   return 0;
334 }
335   
336 /* Handle the NEEDPIN inquiry. */
337 static AssuanError
338 inq_needpin (void *opaque, const char *line)
339 {
340   struct inq_needpin_s *parm = opaque;
341   char *pin;
342   size_t pinlen;
343   int rc;
344
345   if (!(!strncmp (line, "NEEDPIN", 7) && (line[7] == ' ' || !line[7])))
346     {
347       log_error ("unsupported inquiry `%s'\n", line);
348       return ASSUAN_Inquire_Unknown;
349     }
350   line += 7;
351
352   pinlen = 90;
353   pin = gcry_malloc_secure (pinlen);
354   if (!pin)
355     return ASSUAN_Out_Of_Core;
356
357   rc = parm->getpin_cb (parm->getpin_cb_arg, line, pin, pinlen);
358   if (rc)
359     rc = ASSUAN_Canceled;
360   if (!rc)
361     rc = assuan_send_data (parm->ctx, pin, pinlen);
362   xfree (pin);
363
364   return rc;
365 }
366
367
368
369 /* Create a signature using the current card */
370 int
371 agent_card_pksign (const char *keyid,
372                    int (*getpin_cb)(void *, const char *, char*, size_t),
373                    void *getpin_cb_arg,
374                    const unsigned char *indata, size_t indatalen,
375                    char **r_buf, size_t *r_buflen)
376 {
377   int rc, i;
378   char *p, line[ASSUAN_LINELENGTH];
379   struct membuf data;
380   struct inq_needpin_s inqparm;
381   size_t len;
382   unsigned char *sigbuf;
383   size_t sigbuflen;
384
385   *r_buf = NULL;
386   rc = start_scd ();
387   if (rc)
388     return rc;
389
390   if (indatalen*2 + 50 > DIM(line))
391     return unlock_scd (seterr (General_Error));
392
393   sprintf (line, "SETDATA ");
394   p = line + strlen (line);
395   for (i=0; i < indatalen ; i++, p += 2 )
396     sprintf (p, "%02X", indata[i]);
397   rc = assuan_transact (scd_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
398   if (rc)
399     return unlock_scd (map_assuan_err (rc));
400
401   init_membuf (&data, 1024);
402   inqparm.ctx = scd_ctx;
403   inqparm.getpin_cb = getpin_cb;
404   inqparm.getpin_cb_arg = getpin_cb_arg;
405   snprintf (line, DIM(line)-1, "PKSIGN %s", keyid);
406   line[DIM(line)-1] = 0;
407   rc = assuan_transact (scd_ctx, line,
408                         membuf_data_cb, &data,
409                         inq_needpin, &inqparm,
410                         NULL, NULL);
411   if (rc)
412     {
413       xfree (get_membuf (&data, &len));
414       return unlock_scd (map_assuan_err (rc));
415     }
416   sigbuf = get_membuf (&data, &sigbuflen);
417
418   /* create an S-expression from it which is formatted like this:
419      "(7:sig-val(3:rsa(1:sSIGBUFLEN:SIGBUF)))" */
420   *r_buflen = 21 + 11 + sigbuflen + 4;
421   *r_buf = xtrymalloc (*r_buflen);
422   if (!*r_buf)
423     {
424       xfree (*r_buf);
425       return unlock_scd (GNUPG_Out_Of_Core);
426     }
427   p = stpcpy (*r_buf, "(7:sig-val(3:rsa(1:s" );
428   sprintf (p, "%u:", (unsigned int)sigbuflen);
429   p += strlen (p);
430   memcpy (p, sigbuf, sigbuflen);
431   p += sigbuflen;
432   strcpy (p, ")))");
433   xfree (sigbuf);
434
435   assert (gcry_sexp_canon_len (*r_buf, *r_buflen, NULL, NULL));
436   return unlock_scd (0);
437 }
438
439 /* Decipher INDATA using the current card. Note that the returned value is */
440 int
441 agent_card_pkdecrypt (const char *keyid,
442                    int (*getpin_cb)(void *, const char *, char*, size_t),
443                    void *getpin_cb_arg,
444                    const unsigned char *indata, size_t indatalen,
445                    char **r_buf, size_t *r_buflen)
446 {
447   int rc, i;
448   char *p, line[ASSUAN_LINELENGTH];
449   struct membuf data;
450   struct inq_needpin_s inqparm;
451   size_t len;
452
453   *r_buf = NULL;
454   rc = start_scd ();
455   if (rc)
456     return rc;
457
458   /* FIXME: use secure memory where appropriate */
459   if (indatalen*2 + 50 > DIM(line))
460     return unlock_scd (seterr (General_Error));
461
462   sprintf (line, "SETDATA ");
463   p = line + strlen (line);
464   for (i=0; i < indatalen ; i++, p += 2 )
465     sprintf (p, "%02X", indata[i]);
466   rc = assuan_transact (scd_ctx, line, NULL, NULL, NULL, NULL, NULL, NULL);
467   if (rc)
468     return unlock_scd (map_assuan_err (rc));
469
470   init_membuf (&data, 1024);
471   inqparm.ctx = scd_ctx;
472   inqparm.getpin_cb = getpin_cb;
473   inqparm.getpin_cb_arg = getpin_cb_arg;
474   snprintf (line, DIM(line)-1, "PKDECRYPT %s", keyid);
475   line[DIM(line)-1] = 0;
476   rc = assuan_transact (scd_ctx, line,
477                         membuf_data_cb, &data,
478                         inq_needpin, &inqparm,
479                         NULL, NULL);
480   if (rc)
481     {
482       xfree (get_membuf (&data, &len));
483       return unlock_scd (map_assuan_err (rc));
484     }
485   *r_buf = get_membuf (&data, r_buflen);
486   if (!*r_buf)
487     return unlock_scd (GNUPG_Out_Of_Core);
488
489   return unlock_scd (0);
490 }
491
492
493 \f
494 /* Read a certificate with ID into R_BUF and R_BUFLEN. */
495 int
496 agent_card_readcert (const char *id, char **r_buf, size_t *r_buflen)
497 {
498   int rc;
499   char line[ASSUAN_LINELENGTH];
500   struct membuf data;
501   size_t len;
502
503   *r_buf = NULL;
504   rc = start_scd ();
505   if (rc)
506     return rc;
507
508   init_membuf (&data, 1024);
509   snprintf (line, DIM(line)-1, "READCERT %s", id);
510   line[DIM(line)-1] = 0;
511   rc = assuan_transact (scd_ctx, line,
512                         membuf_data_cb, &data,
513                         NULL, NULL,
514                         NULL, NULL);
515   if (rc)
516     {
517       xfree (get_membuf (&data, &len));
518       return unlock_scd (map_assuan_err (rc));
519     }
520   *r_buf = get_membuf (&data, r_buflen);
521   if (!*r_buf)
522     return unlock_scd (GNUPG_Out_Of_Core);
523
524   return unlock_scd (0);
525 }
526
527
528 \f
529 /* Read a key with ID and return it in an allocate buffer pointed to
530    by r_BUF as a valid S-expression. */
531 int
532 agent_card_readkey (const char *id, unsigned char **r_buf)
533 {
534   int rc;
535   char line[ASSUAN_LINELENGTH];
536   struct membuf data;
537   size_t len, buflen;
538
539   *r_buf = NULL;
540   rc = start_scd ();
541   if (rc)
542     return rc;
543
544   init_membuf (&data, 1024);
545   snprintf (line, DIM(line)-1, "READKEY %s", id);
546   line[DIM(line)-1] = 0;
547   rc = assuan_transact (scd_ctx, line,
548                         membuf_data_cb, &data,
549                         NULL, NULL,
550                         NULL, NULL);
551   if (rc)
552     {
553       xfree (get_membuf (&data, &len));
554       return unlock_scd (map_assuan_err (rc));
555     }
556   *r_buf = get_membuf (&data, &buflen);
557   if (!*r_buf)
558     return unlock_scd (GNUPG_Out_Of_Core);
559
560   if (!gcry_sexp_canon_len (*r_buf, buflen, NULL, NULL))
561     {
562       xfree (*r_buf); *r_buf = NULL;
563       return unlock_scd (GNUPG_Invalid_Value);
564     }
565
566   return unlock_scd (0);
567 }
568
569
570