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