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