(reader_table_s): Add function pointers for the backends.
[gnupg.git] / scd / iso7816.c
1 /* iso7816.c - ISO 7816 commands
2  *      Copyright (C) 2003, 2004 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
27 #if defined(GNUPG_SCD_MAIN_HEADER)
28 #include GNUPG_SCD_MAIN_HEADER
29 #elif GNUPG_MAJOR_VERSION == 1
30 /* This is used with GnuPG version < 1.9.  The code has been source
31    copied from the current GnuPG >= 1.9  and is maintained over
32    there. */
33 #include "options.h"
34 #include "errors.h"
35 #include "memory.h"
36 #include "util.h"
37 #include "i18n.h"
38 #else /* GNUPG_MAJOR_VERSION != 1 */
39 #include "scdaemon.h"
40 #endif /* GNUPG_MAJOR_VERSION != 1 */
41
42 #include "iso7816.h"
43 #include "apdu.h"
44
45
46 #define CMD_SELECT_FILE 0xA4
47 #define CMD_VERIFY      0x20
48 #define CMD_CHANGE_REFERENCE_DATA 0x24
49 #define CMD_RESET_RETRY_COUNTER   0x2C
50 #define CMD_GET_DATA    0xCA
51 #define CMD_PUT_DATA    0xDA
52 #define CMD_MSE         0x22
53 #define CMD_PSO         0x2A
54 #define CMD_INTERNAL_AUTHENTICATE 0x88
55 #define CMD_GENERATE_KEYPAIR      0x47
56 #define CMD_GET_CHALLENGE         0x84
57 #define CMD_READ_BINARY 0xB0
58 #define CMD_READ_RECORD 0xB2
59
60 static gpg_error_t
61 map_sw (int sw)
62 {
63   gpg_err_code_t ec;
64
65   switch (sw)
66     {
67     case SW_EEPROM_FAILURE: ec = GPG_ERR_HARDWARE; break;
68     case SW_WRONG_LENGTH:   ec = GPG_ERR_INV_VALUE; break;
69     case SW_CHV_WRONG:      ec = GPG_ERR_BAD_PIN; break;
70     case SW_CHV_BLOCKED:    ec = GPG_ERR_PIN_BLOCKED; break;
71     case SW_USE_CONDITIONS: ec = GPG_ERR_USE_CONDITIONS; break;
72     case SW_NOT_SUPPORTED:  ec = GPG_ERR_NOT_SUPPORTED; break;
73     case SW_BAD_PARAMETER:  ec = GPG_ERR_INV_VALUE; break;
74     case SW_FILE_NOT_FOUND: ec = GPG_ERR_ENOENT; break;
75     case SW_RECORD_NOT_FOUND:ec= GPG_ERR_NOT_FOUND; break;
76     case SW_REF_NOT_FOUND:  ec = GPG_ERR_NO_OBJ; break;
77     case SW_BAD_P0_P1:      ec = GPG_ERR_INV_VALUE; break;
78     case SW_INS_NOT_SUP:    ec = GPG_ERR_CARD; break;
79     case SW_CLA_NOT_SUP:    ec = GPG_ERR_CARD; break;
80     case SW_SUCCESS:        ec = 0; break;
81
82     case SW_HOST_OUT_OF_CORE: ec = GPG_ERR_ENOMEM; break;
83     case SW_HOST_INV_VALUE:   ec = GPG_ERR_INV_VALUE; break;
84     case SW_HOST_INCOMPLETE_CARD_RESPONSE: ec = GPG_ERR_CARD; break;
85     case SW_HOST_NOT_SUPPORTED: ec = GPG_ERR_NOT_SUPPORTED; break;
86     case SW_HOST_LOCKING_FAILED: ec = GPG_ERR_BUG; break;
87     case SW_HOST_BUSY:           ec = GPG_ERR_EBUSY; break;
88     case SW_HOST_NO_CARD:        ec = GPG_ERR_CARD_NOT_PRESENT; break;
89     case SW_HOST_CARD_INACTIVE:  ec = GPG_ERR_CARD_RESET; break;
90     case SW_HOST_CARD_IO_ERROR:  ec = GPG_ERR_EIO; break;
91     case SW_HOST_GENERAL_ERROR:  ec = GPG_ERR_GENERAL; break;
92     case SW_HOST_NO_READER:      ec = GPG_ERR_ENODEV; break;
93
94     default:
95       if ((sw & 0x010000))
96         ec = GPG_ERR_GENERAL; /* Should not happen. */
97       else if ((sw & 0xff00) == SW_MORE_DATA)
98         ec = 0; /* This should actually never been seen here. */
99       else
100         ec = GPG_ERR_CARD;
101     }
102   return gpg_error (ec);
103 }
104
105 /* This function is specialized version of the SELECT FILE command.
106    SLOT is the card and reader as created for example by
107    apdu_open_reader (), AID is a buffer of size AIDLEN holding the
108    requested application ID.  The function can't be used to enumerate
109    AIDs and won't return the AID on success.  The return value is 0
110    for okay or a GPG error code.  Note that ISO error codes are
111    internally mapped. */
112 gpg_error_t
113 iso7816_select_application (int slot, const char *aid, size_t aidlen)
114 {
115   static char const openpgp_aid[] = { 0xD2, 0x76, 0x00, 0x01, 0x24, 0x01 };
116   int sw;
117   int p1 = 0x0C; /* No FCI to be returned. */
118   
119   if (aidlen == sizeof openpgp_aid
120       && !memcmp (aid, openpgp_aid, sizeof openpgp_aid))
121     p1 = 0; /* The current openpgp cards don't allow 0x0c. */
122
123   sw = apdu_send_simple (slot, 0x00, CMD_SELECT_FILE, 4, p1, aidlen, aid);
124   return map_sw (sw);
125 }
126
127
128 gpg_error_t
129 iso7816_select_file (int slot, int tag, int is_dir,
130                      unsigned char **result, size_t *resultlen)
131 {
132   int sw, p0, p1;
133   unsigned char tagbuf[2];
134
135   tagbuf[0] = (tag >> 8) & 0xff;
136   tagbuf[1] = tag & 0xff;
137
138   if (result || resultlen)
139     {
140       *result = NULL;
141       *resultlen = 0;
142       return gpg_error (GPG_ERR_NOT_IMPLEMENTED);
143     }
144   else
145     {
146       p0 = (tag == 0x3F00)? 0: is_dir? 1:2;
147       p1 = 0x0c; /* No FC return. */
148       sw = apdu_send_simple (slot, 0x00, CMD_SELECT_FILE,
149                              p0, p1, 2, tagbuf );
150       return map_sw (sw);
151     }
152
153   return 0;
154 }
155
156
157 /* This is a private command currently only working for TCOS cards. */
158 gpg_error_t
159 iso7816_list_directory (int slot, int list_dirs,
160                         unsigned char **result, size_t *resultlen)
161 {
162   int sw;
163
164   if (!result || !resultlen)
165     return gpg_error (GPG_ERR_INV_VALUE);
166   *result = NULL;
167   *resultlen = 0;
168
169   sw = apdu_send (slot, 0x80, 0xAA, list_dirs? 1:2, 0, -1, NULL,
170                   result, resultlen);
171   if (sw != SW_SUCCESS)
172     {
173       /* Make sure that pending buffers are released. */
174       xfree (*result);
175       *result = NULL;
176       *resultlen = 0;
177     }
178   return map_sw (sw);
179 }
180
181
182
183 /* Perform a VERIFY command on SLOT using the card holder verification
184    vector CHVNO with a CHV of lenght CHVLEN.  Returns 0 on success. */
185 gpg_error_t
186 iso7816_verify (int slot, int chvno, const char *chv, size_t chvlen)
187 {
188   int sw;
189
190   sw = apdu_send_simple (slot, 0x00, CMD_VERIFY, 0, chvno, chvlen, chv);
191   return map_sw (sw);
192 }
193
194 /* Perform a CHANGE_REFERENCE_DATA command on SLOT for the card holder
195    verification vector CHVNO.  If the OLDCHV is NULL (and OLDCHVLEN
196    0), a "change reference data" is done, otherwise an "exchange
197    reference data".  The new reference data is expected in NEWCHV of
198    length NEWCHVLEN.  */
199 gpg_error_t
200 iso7816_change_reference_data (int slot, int chvno,
201                                const char *oldchv, size_t oldchvlen,
202                                const char *newchv, size_t newchvlen)
203 {
204   int sw;
205   char *buf;
206
207   if ((!oldchv && oldchvlen)
208       || (oldchv && !oldchvlen)
209       || !newchv || !newchvlen )
210     return gpg_error (GPG_ERR_INV_VALUE);
211
212   buf = xtrymalloc (oldchvlen + newchvlen);
213   if (!buf)
214     return gpg_error (gpg_err_code_from_errno (errno));
215   if (oldchvlen)
216     memcpy (buf, oldchv, oldchvlen);
217   memcpy (buf+oldchvlen, newchv, newchvlen);
218
219   sw = apdu_send_simple (slot, 0x00, CMD_CHANGE_REFERENCE_DATA,
220                          oldchvlen? 0 : 1, chvno, oldchvlen+newchvlen, buf);
221   xfree (buf);
222   return map_sw (sw);
223
224 }
225
226 gpg_error_t
227 iso7816_reset_retry_counter (int slot, int chvno,
228                              const char *newchv, size_t newchvlen)
229 {
230   int sw;
231
232   if (!newchv || !newchvlen )
233     return gpg_error (GPG_ERR_INV_VALUE);
234
235   sw = apdu_send_simple (slot, 0x00, CMD_RESET_RETRY_COUNTER,
236                          2, chvno, newchvlen, newchv);
237   return map_sw (sw);
238 }
239
240
241 /* Perform a GET DATA command requesting TAG and storing the result in
242    a newly allocated buffer at the address passed by RESULT.  Return
243    the length of this data at the address of RESULTLEN. */
244 gpg_error_t
245 iso7816_get_data (int slot, int tag,
246                   unsigned char **result, size_t *resultlen)
247 {
248   int sw;
249
250   if (!result || !resultlen)
251     return gpg_error (GPG_ERR_INV_VALUE);
252   *result = NULL;
253   *resultlen = 0;
254
255   sw = apdu_send (slot, 0x00, CMD_GET_DATA,
256                   ((tag >> 8) & 0xff), (tag & 0xff), -1, NULL,
257                   result, resultlen);
258   if (sw != SW_SUCCESS)
259     {
260       /* Make sure that pending buffers are released. */
261       xfree (*result);
262       *result = NULL;
263       *resultlen = 0;
264       return map_sw (sw);
265     }
266
267   return 0;
268 }
269
270
271 /* Perform a PUT DATA command on card in SLOT.  Write DATA of length
272    DATALEN to TAG. */
273 gpg_error_t
274 iso7816_put_data (int slot, int tag,
275                   const unsigned char *data, size_t datalen)
276 {
277   int sw;
278
279   sw = apdu_send_simple (slot, 0x00, CMD_PUT_DATA,
280                          ((tag >> 8) & 0xff), (tag & 0xff),
281                          datalen, data);
282   return map_sw (sw);
283 }
284
285 /* Manage Security Environment.  This is a weird operation and there
286    is no easy abstraction for it.  Furthermore, some card seem to have
287    a different interpreation of 7816-8 and thus we resort to let the
288    caller decide what to do. */
289 gpg_error_t
290 iso7816_manage_security_env (int slot, int p1, int p2,
291                              const unsigned char *data, size_t datalen)
292 {
293   int sw;
294
295   if (p1 < 0 || p1 > 255 || p2 < 0 || p2 > 255 || !data || !datalen)
296     return gpg_error (GPG_ERR_INV_VALUE);
297
298   sw = apdu_send_simple (slot, 0x00, CMD_MSE, p1, p2, datalen, data);
299   return map_sw (sw);
300 }
301
302
303 /* Perform the security operation COMPUTE DIGITAL SIGANTURE.  On
304    success 0 is returned and the data is availavle in a newly
305    allocated buffer stored at RESULT with its length stored at
306    RESULTLEN. */
307 gpg_error_t
308 iso7816_compute_ds (int slot, const unsigned char *data, size_t datalen,
309                     unsigned char **result, size_t *resultlen)
310 {
311   int sw;
312
313   if (!data || !datalen || !result || !resultlen)
314     return gpg_error (GPG_ERR_INV_VALUE);
315   *result = NULL;
316   *resultlen = 0;
317
318   sw = apdu_send (slot, 0x00, CMD_PSO, 0x9E, 0x9A, datalen, data,
319                   result, resultlen);
320   if (sw != SW_SUCCESS)
321     {
322       /* Make sure that pending buffers are released. */
323       xfree (*result);
324       *result = NULL;
325       *resultlen = 0;
326       return map_sw (sw);
327     }
328
329   return 0;
330 }
331
332
333 /* Perform the security operation DECIPHER.  PADIND is the padding
334    indicator to be used.  It should be 0 if no padding is required, a
335    value of -1 suppresses the padding byte.  On success 0 is returned
336    and the plaintext is available in a newly allocated buffer stored
337    at RESULT with its length stored at RESULTLEN. */
338 gpg_error_t
339 iso7816_decipher (int slot, const unsigned char *data, size_t datalen,
340                   int padind, unsigned char **result, size_t *resultlen)
341 {
342   int sw;
343   unsigned char *buf;
344
345   if (!data || !datalen || !result || !resultlen)
346     return gpg_error (GPG_ERR_INV_VALUE);
347   *result = NULL;
348   *resultlen = 0;
349
350   if (padind >= 0)
351     {
352       /* We need to prepend the padding indicator. */
353       buf = xtrymalloc (datalen + 1);
354       if (!buf)
355         return gpg_error (gpg_err_code_from_errno (errno));
356
357       *buf = padind; /* Padding indicator. */
358       memcpy (buf+1, data, datalen);
359       sw = apdu_send (slot, 0x00, CMD_PSO, 0x80, 0x86, datalen+1, buf,
360                       result, resultlen);
361       xfree (buf);
362     }
363   else
364     {
365       sw = apdu_send (slot, 0x00, CMD_PSO, 0x80, 0x86, datalen, data,
366                       result, resultlen);
367     }
368   if (sw != SW_SUCCESS)
369     {
370       /* Make sure that pending buffers are released. */
371       xfree (*result);
372       *result = NULL;
373       *resultlen = 0;
374       return map_sw (sw);
375     }
376
377   return 0;
378 }
379
380
381 gpg_error_t
382 iso7816_internal_authenticate (int slot,
383                                const unsigned char *data, size_t datalen,
384                                unsigned char **result, size_t *resultlen)
385 {
386   int sw;
387
388   if (!data || !datalen || !result || !resultlen)
389     return gpg_error (GPG_ERR_INV_VALUE);
390   *result = NULL;
391   *resultlen = 0;
392
393   sw = apdu_send (slot, 0x00, CMD_INTERNAL_AUTHENTICATE, 0, 0,
394                   datalen, data,  result, resultlen);
395   if (sw != SW_SUCCESS)
396     {
397       /* Make sure that pending buffers are released. */
398       xfree (*result);
399       *result = NULL;
400       *resultlen = 0;
401       return map_sw (sw);
402     }
403
404   return 0;
405 }
406
407
408 static gpg_error_t
409 do_generate_keypair (int slot, int readonly,
410                   const unsigned char *data, size_t datalen,
411                   unsigned char **result, size_t *resultlen)
412 {
413   int sw;
414
415   if (!data || !datalen || !result || !resultlen)
416     return gpg_error (GPG_ERR_INV_VALUE);
417   *result = NULL;
418   *resultlen = 0;
419
420   sw = apdu_send (slot, 0x00, CMD_GENERATE_KEYPAIR, readonly? 0x81:0x80, 0,
421                   datalen, data,  result, resultlen);
422   if (sw != SW_SUCCESS)
423     {
424       /* Make sure that pending buffers are released. */
425       xfree (*result);
426       *result = NULL;
427       *resultlen = 0;
428       return map_sw (sw);
429     }
430
431   return 0;
432 }
433
434
435 gpg_error_t
436 iso7816_generate_keypair (int slot,
437                           const unsigned char *data, size_t datalen,
438                           unsigned char **result, size_t *resultlen)
439 {
440   return do_generate_keypair (slot, 0, data, datalen, result, resultlen);
441 }
442
443
444 gpg_error_t
445 iso7816_read_public_key (int slot,
446                           const unsigned char *data, size_t datalen,
447                           unsigned char **result, size_t *resultlen)
448 {
449   return do_generate_keypair (slot, 1, data, datalen, result, resultlen);
450 }
451
452
453
454 gpg_error_t
455 iso7816_get_challenge (int slot, int length, unsigned char *buffer)
456 {
457   int sw;
458   unsigned char *result;
459   size_t resultlen, n;
460
461   if (!buffer || length < 1)
462     return gpg_error (GPG_ERR_INV_VALUE);
463
464   do
465     {
466       result = NULL;
467       n = length > 254? 254 : length;
468       sw = apdu_send_le (slot, 0x00, CMD_GET_CHALLENGE, 0, 0, -1, NULL,
469                          n,
470                          &result, &resultlen);
471       if (sw != SW_SUCCESS)
472         {
473           /* Make sure that pending buffers are released. */
474           xfree (result);
475           return map_sw (sw);
476         }
477       if (resultlen > n)
478         resultlen = n;
479       memcpy (buffer, result, resultlen);
480       buffer += resultlen;
481       length -= resultlen;
482       xfree (result);
483     }
484   while (length > 0);
485
486   return 0;
487 }
488
489 /* Perform a READ BINARY command requesting a maximum of NMAX bytes
490    from OFFSET.  With NMAX = 0 the entire file is read. The result is
491    stored in a newly allocated buffer at the address passed by RESULT.
492    Returns the length of this data at the address of RESULTLEN. */
493 gpg_error_t
494 iso7816_read_binary (int slot, size_t offset, size_t nmax,
495                      unsigned char **result, size_t *resultlen)
496 {
497   int sw;
498   unsigned char *buffer;
499   size_t bufferlen;
500   int read_all = !nmax;
501   size_t n;
502
503   if (!result || !resultlen)
504     return gpg_error (GPG_ERR_INV_VALUE);
505   *result = NULL;
506   *resultlen = 0;
507
508   /* We can only encode 15 bits in p0,p1 to indicate an offset. Thus
509      we check for this limit. */
510   if (offset > 32767)
511     return gpg_error (GPG_ERR_INV_VALUE);
512
513   do
514     {
515       buffer = NULL;
516       bufferlen = 0;
517       /* Fixme: Either the ccid driver or the TCOS cards have problems
518          with an Le of 0. */
519       if (read_all || nmax > 254)
520         n = 254;
521       else
522         n = nmax;
523       sw = apdu_send_le (slot, 0x00, CMD_READ_BINARY,
524                          ((offset>>8) & 0xff), (offset & 0xff) , -1, NULL,
525                          n, &buffer, &bufferlen);
526
527       if (sw != SW_SUCCESS && sw != SW_EOF_REACHED)
528         {
529           /* Make sure that pending buffers are released. */
530           xfree (buffer);
531           xfree (*result);
532           *result = NULL;
533           *resultlen = 0;
534           return map_sw (sw);
535         }
536       if (*result) /* Need to extend the buffer. */
537         {
538           unsigned char *p = xtryrealloc (*result, *resultlen + bufferlen);
539           if (!p)
540             {
541               gpg_error_t err = gpg_error_from_errno (errno);
542               xfree (buffer);
543               xfree (*result);
544               *result = NULL;
545               *resultlen = 0;
546               return err;
547             }
548           *result = p;
549           memcpy (*result + *resultlen, buffer, bufferlen);
550           *resultlen += bufferlen;
551           xfree (buffer);
552           buffer = NULL;
553         }
554       else /* Transfer the buffer into our result. */
555         {
556           *result = buffer;
557           *resultlen = bufferlen;
558         }
559       offset += bufferlen;
560       if (offset > 32767)
561         break; /* We simply truncate the result for too large
562                   files. */
563       if (nmax > bufferlen)
564         nmax -= bufferlen;
565       else
566         nmax = 0;
567     }
568   while ((read_all && sw != SW_EOF_REACHED) || (!read_all && nmax));
569   
570   return 0;
571 }
572
573 /* Perform a READ RECORD command. RECNO gives the record number to
574    read with 0 indicating the current record.  RECCOUNT must be 1 (not
575    all cards support reading of more than one record).  SHORT_EF
576    should be 0 to read the current EF or contain a short EF. The
577    result is stored in a newly allocated buffer at the address passed
578    by RESULT.  Returns the length of this data at the address of
579    RESULTLEN. */
580 gpg_error_t
581 iso7816_read_record (int slot, int recno, int reccount, int short_ef,
582                      unsigned char **result, size_t *resultlen)
583 {
584   int sw;
585   unsigned char *buffer;
586   size_t bufferlen;
587
588   if (!result || !resultlen)
589     return gpg_error (GPG_ERR_INV_VALUE);
590   *result = NULL;
591   *resultlen = 0;
592
593   /* We can only encode 15 bits in p0,p1 to indicate an offset. Thus
594      we check for this limit. */
595   if (recno < 0 || recno > 255 || reccount != 1
596       || short_ef < 0 || short_ef > 254 )
597     return gpg_error (GPG_ERR_INV_VALUE);
598
599   buffer = NULL;
600   bufferlen = 0;
601   /* Fixme: Either the ccid driver of the TCOS cards have problems
602      with an Le of 0. */
603   sw = apdu_send_le (slot, 0x00, CMD_READ_RECORD,
604                      recno, 
605                      short_ef? short_ef : 0x04,
606                      -1, NULL,
607                      254, &buffer, &bufferlen);
608
609   if (sw != SW_SUCCESS && sw != SW_EOF_REACHED)
610     {
611       /* Make sure that pending buffers are released. */
612       xfree (buffer);
613       xfree (*result);
614       *result = NULL;
615       *resultlen = 0;
616       return map_sw (sw);
617     }
618   *result = buffer;
619   *resultlen = bufferlen;
620   
621   return 0;
622 }
623