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