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