Add CVE number.
[gnupg.git] / scd / apdu.h
1 /* apdu.h - ISO 7816 APDU functions and low level I/O
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 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 #ifndef APDU_H
23 #define APDU_H
24
25 /* ISO 7816 values for the statusword are defined here because they
26    should not be visible to the users of the actual ISO command
27    API. */
28 enum {
29   SW_MORE_DATA      = 0x6100, /* Note: that the low byte must be
30                                  masked of.*/
31   SW_EOF_REACHED    = 0x6282,
32   SW_EEPROM_FAILURE = 0x6581,
33   SW_WRONG_LENGTH   = 0x6700,
34   SW_CHV_WRONG      = 0x6982,
35   SW_CHV_BLOCKED    = 0x6983,
36   SW_USE_CONDITIONS = 0x6985,
37   SW_BAD_PARAMETER  = 0x6a80, /* (in the data field) */
38   SW_NOT_SUPPORTED  = 0x6a81,
39   SW_FILE_NOT_FOUND = 0x6a82,
40   SW_RECORD_NOT_FOUND = 0x6a83,
41   SW_REF_NOT_FOUND  = 0x6a88,
42   SW_BAD_P0_P1      = 0x6b00,
43   SW_EXACT_LENGTH   = 0x6c00,
44   SW_INS_NOT_SUP    = 0x6d00,
45   SW_CLA_NOT_SUP    = 0x6e00,
46   SW_SUCCESS        = 0x9000,
47
48   /* The follwoing statuswords are no real ones but used to map host
49      OS errors into status words.  A status word is 16 bit so that
50      those values can't be issued by a card. */
51   SW_HOST_OUT_OF_CORE = 0x10001,  /* No way yet to differentiate
52                                      between errnos on a failed malloc. */
53   SW_HOST_INV_VALUE     = 0x10002,
54   SW_HOST_INCOMPLETE_CARD_RESPONSE = 0x10003,
55   SW_HOST_NO_DRIVER     = 0x10004,
56   SW_HOST_NOT_SUPPORTED = 0x10005,
57   SW_HOST_LOCKING_FAILED= 0x10006,
58   SW_HOST_BUSY          = 0x10007,
59   SW_HOST_NO_CARD       = 0x10008,
60   SW_HOST_CARD_INACTIVE = 0x10009,
61   SW_HOST_CARD_IO_ERROR = 0x1000a,
62   SW_HOST_GENERAL_ERROR = 0x1000b,
63   SW_HOST_NO_READER     = 0x1000c,
64   SW_HOST_ABORTED       = 0x1000d,
65   SW_HOST_NO_KEYPAD     = 0x1000e
66 };
67
68
69 #define SW_EXACT_LENGTH_P(a) (((a)&~0xff) == SW_EXACT_LENGTH)
70
71
72 /* Note , that apdu_open_reader returns no status word but -1 on error. */
73 int apdu_open_reader (const char *portstr);
74 int apdu_open_remote_reader (const char *portstr,
75                              const unsigned char *cookie, size_t length,
76                              int (*readfnc) (void *opaque,
77                                              void *buffer, size_t size),
78                              void *readfnc_value,
79                              int (*writefnc) (void *opaque,
80                                               const void *buffer, size_t size),
81                              void *writefnc_value,
82                              void (*closefnc) (void *opaque),
83                              void *closefnc_value);
84 int apdu_shutdown_reader (int slot);
85 int apdu_close_reader (int slot);
86 int apdu_enum_reader (int slot, int *used);
87 unsigned char *apdu_get_atr (int slot, size_t *atrlen);
88
89 const char *apdu_strerror (int rc);
90
91
92 /* These apdu functions do return status words. */
93
94 int apdu_activate (int slot);
95 int apdu_reset (int slot);
96 int apdu_get_status (int slot, int hang,
97                      unsigned int *status, unsigned int *changed);
98 int apdu_check_keypad (int slot, int command, int pin_mode,
99                        int pinlen_min, int pinlen_max, int pin_padlen);
100 int apdu_send_simple (int slot, int class, int ins, int p0, int p1,
101                       int lc, const char *data);
102 int apdu_send_simple_kp (int slot, int class, int ins, int p0, int p1,
103                          int lc, const char *data,  
104                          int pin_mode,
105                          int pinlen_min, int pinlen_max, int pin_padlen);
106 int apdu_send (int slot, int class, int ins, int p0, int p1,
107                int lc, const char *data,
108                unsigned char **retbuf, size_t *retbuflen);
109 int apdu_send_le (int slot, int class, int ins, int p0, int p1,
110                   int lc, const char *data, int le,
111                   unsigned char **retbuf, size_t *retbuflen);
112 int apdu_send_direct (int slot,
113                       const unsigned char *apdudata, size_t apdudatalen,
114                       int handle_more,
115                       unsigned char **retbuf, size_t *retbuflen);
116
117
118 #endif /*APDU_H*/
119
120
121