sm/
[gnupg.git] / scd / command.c
1 /* command.c - SCdaemon command handler
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 #include <config.h>
22 #include <errno.h>
23 #include <stdio.h>
24 #include <stdlib.h>
25 #include <string.h>
26 #include <ctype.h>
27 #include <unistd.h>
28 #include <ksba.h>
29
30 #include "scdaemon.h"
31 #include "../assuan/assuan.h"
32
33 /* maximum length aloowed as a PIN; used for INQUIRE NEEDPIN */
34 #define MAXLEN_PIN 100
35
36 #define set_error(e,t) assuan_set_error (ctx, ASSUAN_ ## e, (t))
37
38 /* Data used to associate an Assuan context with local server data */
39 struct server_local_s {
40   ASSUAN_CONTEXT assuan_ctx;
41 };
42
43
44 /* Check whether the option NAME appears in LINE */
45 static int
46 has_option (const char *line, const char *name)
47 {
48   const char *s;
49   int n = strlen (name);
50
51   s = strstr (line, name);
52   return (s && (s == line || spacep (s-1)) && (!s[n] || spacep (s+n)));
53 }
54
55
56
57 \f
58 /* Note, that this reset_notify is also used for cleanup purposes. */
59 static void
60 reset_notify (ASSUAN_CONTEXT ctx)
61 {
62   CTRL ctrl = assuan_get_pointer (ctx); 
63
64   if (ctrl->card_ctx)
65     {
66       card_close (ctrl->card_ctx);
67       ctrl->card_ctx = NULL;
68       xfree (ctrl->in_data.value);
69       ctrl->in_data.value = NULL;
70     }
71 }
72
73
74 static int
75 option_handler (ASSUAN_CONTEXT ctx, const char *key, const char *value)
76 {
77   return 0;
78 }
79
80
81 /* If the card has not yet been opened, do it.  Note that this
82    function returns an Assuan error, so don't map the error a second
83    time */
84 static AssuanError
85 open_card (CTRL ctrl)
86 {
87   if (!ctrl->card_ctx)
88     {
89       int rc = card_open (&ctrl->card_ctx);
90       if (rc)
91         return map_to_assuan_status (rc);
92     }
93   return 0;
94 }
95
96
97 /* SERIALNO 
98
99    Return the serial number of the card using a status reponse.  This
100    functon should be used to check for the presence of a card.
101
102    This function is special in that it can be used to reset the card.
103    Most other functions will return an error when a card change has
104    been detected and the use of this function is therefore required.
105
106    Background: We want to keep the client clear of handling card
107    changes between operations; i.e. the client can assume that all
108    operations are doneon the same card unless he call this function.
109  */
110 static int
111 cmd_serialno (ASSUAN_CONTEXT ctx, char *line)
112 {
113   CTRL ctrl = assuan_get_pointer (ctx);
114   int rc = 0;
115   char *serial_and_stamp;
116   char *serial;
117   time_t stamp;
118
119   if ((rc = open_card (ctrl)))
120     return rc;
121
122   rc = card_get_serial_and_stamp (ctrl->card_ctx, &serial, &stamp);
123   if (rc)
124     return map_to_assuan_status (rc);
125   rc = asprintf (&serial_and_stamp, "%s %lu", serial, (unsigned long)stamp);
126   xfree (serial);
127   if (rc < 0)
128     return ASSUAN_Out_Of_Core;
129   rc = 0;
130   assuan_write_status (ctx, "SERIALNO", serial_and_stamp);
131   free (serial_and_stamp);
132   return 0;
133 }
134
135
136
137
138 /* LEARN [--force]
139
140    Learn all useful information of the currently inserted card.  When
141    used without the force options, the command might do an INQUIRE
142    like this:
143
144       INQUIRE KNOWNCARDP <hexstring_with_serialNumber> <timestamp>
145
146    The client should just send an "END" if the processing should go on
147    or a "CANCEL" to force the function to terminate with a Cancel
148    error message.  The response of this command is a list of status
149    lines formatted as this:
150
151      S KEYPAIRINFO <hexstring_with_keygrip> <hexstring_with_id>
152
153    If there is no certificate yet stored on the card a single "X" is
154    returned as the keygrip.
155
156 */
157 static int
158 cmd_learn (ASSUAN_CONTEXT ctx, char *line)
159 {
160   CTRL ctrl = assuan_get_pointer (ctx);
161   int rc = 0;
162   int idx;
163
164   if ((rc = open_card (ctrl)))
165     return rc;
166
167   /* Unless the force option is used we try a shortcut by identifying
168      the card using a serial number and inquiring the client with
169      that. The client may choose to cancel the operation if he already
170      knows about this card */
171   {
172     char *serial_and_stamp;
173     char *serial;
174     time_t stamp;
175    
176     rc = card_get_serial_and_stamp (ctrl->card_ctx, &serial, &stamp);
177     if (rc)
178       return map_to_assuan_status (rc);
179     rc = asprintf (&serial_and_stamp, "%s %lu", serial, (unsigned long)stamp);
180     xfree (serial);
181     if (rc < 0)
182       return ASSUAN_Out_Of_Core;
183     rc = 0;
184     assuan_write_status (ctx, "SERIALNO", serial_and_stamp);
185
186     if (!has_option (line, "--force"))
187       {
188         char *command;
189
190         rc = asprintf (&command, "KNOWNCARDP %s", serial_and_stamp);
191         if (rc < 0)
192           {
193             free (serial_and_stamp);
194             return ASSUAN_Out_Of_Core;
195           }
196         rc = 0;
197         rc = assuan_inquire (ctx, command, NULL, NULL, 0); 
198         free (command);  /* (must use standard free here) */
199         if (rc)
200           {
201             if (rc != ASSUAN_Canceled)
202               log_error ("inquire KNOWNCARDP failed: %s\n",
203                          assuan_strerror (rc));
204             free (serial_and_stamp);
205             return rc; 
206           }
207         /* not canceled, so we have to proceeed */
208       }
209     free (serial_and_stamp);
210   }
211
212   for (idx=0; !rc; idx++)
213     {
214       unsigned char keygrip[20];
215       unsigned char *keyid;
216       size_t nkeyid;
217       int no_cert = 0;
218
219       rc = card_enum_keypairs (ctrl->card_ctx, idx, 
220                                keygrip, &keyid, &nkeyid);
221       if (rc == GNUPG_Missing_Certificate && keyid)
222         {
223           /* this does happen with an incomplete personalized
224              card; i.e. during the time we have stored the key on the
225              card but not stored the certificate; probably becuase it
226              has not yet been received back from the CA.  Note that we
227              must release KEYID in this case. */
228           rc = 0; 
229           no_cert = 1;
230         }
231       if (!rc)
232         {
233           char *buf, *p;
234
235           buf = p = xtrymalloc (40+1+9+2*nkeyid+1);
236           if (!buf)
237             rc = GNUPG_Out_Of_Core;
238           else
239             {
240               int i;
241               
242               if (no_cert)
243                 *p++ = 'X';
244               else
245                 {
246                   for (i=0; i < 20; i++, p += 2)
247                     sprintf (p, "%02X", keygrip[i]);
248                 }
249               *p++ = ' ';
250               /* fixme: we need to get the pkcs-15 DF from the card function */
251               p = stpcpy (p, "3F005015.");
252               for (i=0; i < nkeyid; i++, p += 2)
253                 sprintf (p, "%02X", keyid[i]);
254               *p = 0;
255               assuan_write_status (ctx, "KEYPAIRINFO", buf);
256               xfree (buf);
257             }
258         }
259       xfree (keyid);
260     }
261   if (rc == -1)
262     rc = 0;
263
264
265   return map_to_assuan_status (rc);
266 }
267
268
269 \f
270 /* READCERT <hexified_certid>
271
272  */
273 static int
274 cmd_readcert (ASSUAN_CONTEXT ctx, char *line)
275 {
276   CTRL ctrl = assuan_get_pointer (ctx);
277   int rc;
278   unsigned char *cert;
279   size_t ncert;
280
281   if ((rc = open_card (ctrl)))
282     return rc;
283
284   rc = card_read_cert (ctrl->card_ctx, line, &cert, &ncert);
285   if (rc)
286     {
287       log_error ("card_read_cert failed: %s\n", gnupg_strerror (rc));
288     }
289   if (!rc)
290     {
291       rc = assuan_send_data (ctx, cert, ncert);
292       xfree (cert);
293       if (rc)
294         return rc;
295     }
296
297   return map_to_assuan_status (rc);
298 }
299
300
301 /* READKEY <hexified_certid>
302
303    Return the public key for the given cert or key ID as an standard
304    S-Expression.  */
305 static int
306 cmd_readkey (ASSUAN_CONTEXT ctx, char *line)
307 {
308   CTRL ctrl = assuan_get_pointer (ctx);
309   int rc;
310   unsigned char *cert = NULL;
311   size_t ncert, n;
312   KsbaCert kc = NULL;
313   KsbaSexp p;
314
315   if ((rc = open_card (ctrl)))
316     return rc;
317
318   rc = card_read_cert (ctrl->card_ctx, line, &cert, &ncert);
319   if (rc)
320     {
321       log_error ("card_read_cert failed: %s\n", gnupg_strerror (rc));
322       goto leave;
323     }
324       
325   kc = ksba_cert_new ();
326   if (!kc)
327     {
328       xfree (cert);
329       rc = GNUPG_Out_Of_Core;
330       goto leave;
331     }
332   rc = ksba_cert_init_from_mem (kc, cert, ncert);
333   if (rc)
334     {
335       log_error ("failed to parse the certificate: %s\n", ksba_strerror (rc));
336       rc = map_ksba_err (rc);
337       goto leave;
338     }
339
340   p = ksba_cert_get_public_key (kc);
341   if (!p)
342     {
343       rc = GNUPG_No_Public_Key;
344       goto leave;
345     }
346
347   n = gcry_sexp_canon_len (p, 0, NULL, NULL);
348   rc = assuan_send_data (ctx, p, n);
349   rc = map_assuan_err (rc);
350   xfree (p);
351
352
353  leave:
354   ksba_cert_release (kc);
355   xfree (cert);
356   return map_to_assuan_status (rc);
357 }
358
359
360 \f
361
362 /* SETDATA <hexstring> 
363
364    The client should use this command to tell us the data he want to
365    sign.  */
366 static int
367 cmd_setdata (ASSUAN_CONTEXT ctx, char *line)
368 {
369   CTRL ctrl = assuan_get_pointer (ctx);
370   int n;
371   char *p;
372   unsigned char *buf;
373
374   /* parse the hexstring */
375   for (p=line,n=0; hexdigitp (p); p++, n++)
376     ;
377   if (*p)
378     return set_error (Parameter_Error, "invalid hexstring");
379   if ((n&1))
380     return set_error (Parameter_Error, "odd number of digits");
381   n /= 2;
382   buf = xtrymalloc (n);
383   if (!buf)
384     return ASSUAN_Out_Of_Core;
385
386   ctrl->in_data.value = buf;
387   ctrl->in_data.valuelen = n;
388   for (p=line, n=0; n < ctrl->in_data.valuelen; p += 2, n++)
389     buf[n] = xtoi_2 (p);
390   return 0;
391 }
392
393
394
395 static int 
396 pin_cb (void *opaque, const char *info, char **retstr)
397 {
398   ASSUAN_CONTEXT ctx = opaque;
399   char *command;
400   int rc;
401   char *value;
402   size_t valuelen;
403
404   *retstr = NULL;
405   log_debug ("asking for PIN '%s'\n", info);
406
407   rc = asprintf (&command, "NEEDPIN %s", info);
408   if (rc < 0)
409     return GNUPG_Out_Of_Core;
410
411   /* FIXME: Write an inquire function which returns the result in
412      secure memory */
413   rc = assuan_inquire (ctx, command, &value, &valuelen, MAXLEN_PIN); 
414   free (command);  
415   if (rc)
416     return map_assuan_err (rc);
417
418   if (!valuelen || value[valuelen-1])
419     {
420       /* We require that the returned value is an UTF-8 string */
421       xfree (value);
422       return GNUPG_Invalid_Response;
423     }
424   *retstr = value;
425   return 0;
426 }
427
428
429 /* PKSIGN <hexified_id>
430
431  */
432 static int
433 cmd_pksign (ASSUAN_CONTEXT ctx, char *line)
434 {
435   CTRL ctrl = assuan_get_pointer (ctx);
436   int rc;
437   void *outdata;
438   size_t outdatalen;
439
440   if ((rc = open_card (ctrl)))
441     return rc;
442
443   rc = card_create_signature (ctrl->card_ctx,
444                               line, GCRY_MD_SHA1,
445                               pin_cb, ctx,
446                               ctrl->in_data.value, ctrl->in_data.valuelen,
447                               &outdata, &outdatalen);
448   if (rc)
449     {
450       log_error ("card_create_signature failed: %s\n", gnupg_strerror (rc));
451     }
452   else
453     {
454       rc = assuan_send_data (ctx, outdata, outdatalen);
455       xfree (outdata);
456       if (rc)
457         return rc; /* that is already an assuan error code */
458     }
459
460   return map_to_assuan_status (rc);
461 }
462
463 /* PKDECRYPT <hexified_id>
464
465  */
466 static int
467 cmd_pkdecrypt (ASSUAN_CONTEXT ctx, char *line)
468 {
469   CTRL ctrl = assuan_get_pointer (ctx);
470   int rc;
471   void *outdata;
472   size_t outdatalen;
473
474   if ((rc = open_card (ctrl)))
475     return rc;
476
477   rc = card_decipher (ctrl->card_ctx,
478                       line, 
479                       pin_cb, ctx,
480                       ctrl->in_data.value, ctrl->in_data.valuelen,
481                       &outdata, &outdatalen);
482   if (rc)
483     {
484       log_error ("card_create_signature failed: %s\n", gnupg_strerror (rc));
485     }
486   else
487     {
488       rc = assuan_send_data (ctx, outdata, outdatalen);
489       xfree (outdata);
490       if (rc)
491         return rc; /* that is already an assuan error code */
492     }
493
494   return map_to_assuan_status (rc);
495 }
496
497
498
499 \f
500 /* Tell the assuan library about our commands */
501 static int
502 register_commands (ASSUAN_CONTEXT ctx)
503 {
504   static struct {
505     const char *name;
506     int cmd_id;
507     int (*handler)(ASSUAN_CONTEXT, char *line);
508   } table[] = {
509     { "SERIALNO", 0, cmd_serialno },
510     { "LEARN", 0, cmd_learn },
511     { "READCERT", 0, cmd_readcert },
512     { "READKEY", 0,  cmd_readkey },
513     { "SETDATA", 0,  cmd_setdata },
514     { "PKSIGN", 0,   cmd_pksign },
515     { "PKDECRYPT", 0,cmd_pkdecrypt },
516     { "",     ASSUAN_CMD_INPUT, NULL }, 
517     { "",     ASSUAN_CMD_OUTPUT, NULL }, 
518     { NULL }
519   };
520   int i, j, rc;
521
522   for (i=j=0; table[i].name; i++)
523     {
524       rc = assuan_register_command (ctx,
525                                     table[i].cmd_id? table[i].cmd_id
526                                                    : (ASSUAN_CMD_USER + j++),
527                                     table[i].name, table[i].handler);
528       if (rc)
529         return rc;
530     } 
531   assuan_set_hello_line (ctx, "GNU Privacy Guard's Smartcard server ready");
532
533   assuan_register_reset_notify (ctx, reset_notify);
534   assuan_register_option_handler (ctx, option_handler);
535   return 0;
536 }
537
538
539 /* Startup the server.  If LISTEN_FD is given as -1, this is simple
540    piper server, otherwise it is a regular server */
541 void
542 scd_command_handler (int listen_fd)
543 {
544   int rc;
545   ASSUAN_CONTEXT ctx;
546   struct server_control_s ctrl;
547
548   memset (&ctrl, 0, sizeof ctrl);
549   scd_init_default_ctrl (&ctrl);
550   
551   if (listen_fd == -1)
552     {
553       int filedes[2];
554
555       filedes[0] = 0;
556       filedes[1] = 1;
557       rc = assuan_init_pipe_server (&ctx, filedes);
558     }
559   else
560     {
561       rc = assuan_init_socket_server (&ctx, listen_fd);
562     }
563   if (rc)
564     {
565       log_error ("failed to initialize the server: %s\n",
566                  assuan_strerror(rc));
567       scd_exit (2);
568     }
569   rc = register_commands (ctx);
570   if (rc)
571     {
572       log_error ("failed to register commands with Assuan: %s\n",
573                  assuan_strerror(rc));
574       scd_exit (2);
575     }
576   assuan_set_pointer (ctx, &ctrl);
577   ctrl.server_local = xcalloc (1, sizeof *ctrl.server_local);
578   ctrl.server_local->assuan_ctx = ctx;
579
580   if (DBG_ASSUAN)
581     assuan_set_log_stream (ctx, log_get_stream ());
582
583   for (;;)
584     {
585       rc = assuan_accept (ctx);
586       if (rc == -1)
587         {
588           break;
589         }
590       else if (rc)
591         {
592           log_info ("Assuan accept problem: %s\n", assuan_strerror (rc));
593           break;
594         }
595       
596       rc = assuan_process (ctx);
597       if (rc)
598         {
599           log_info ("Assuan processing failed: %s\n", assuan_strerror (rc));
600           continue;
601         }
602     }
603   reset_notify (ctx); /* used for cleanup */
604
605   assuan_deinit_server (ctx);
606 }