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