Detect non operational readers.
[gnupg.git] / scd / apdu.h
1 /* apdu.h - ISO 7816 APDU functions and low level I/O
2  * Copyright (C) 2003, 2008 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_TERM_STATE     = 0x6285, /* Selected file is in termination state.  */
33   SW_EEPROM_FAILURE = 0x6581,
34   SW_WRONG_LENGTH   = 0x6700,
35   SW_SM_NOT_SUP     = 0x6882, /* Secure Messaging is not supported.  */
36   SW_CC_NOT_SUP     = 0x6884, /* Command Chaining is not supported.  */
37   SW_CHV_WRONG      = 0x6982,
38   SW_CHV_BLOCKED    = 0x6983,
39   SW_USE_CONDITIONS = 0x6985,
40   SW_BAD_PARAMETER  = 0x6a80, /* (in the data field) */
41   SW_NOT_SUPPORTED  = 0x6a81,
42   SW_FILE_NOT_FOUND = 0x6a82,
43   SW_RECORD_NOT_FOUND = 0x6a83,
44   SW_BAD_LC         = 0x6a87, /* Lc does not match command or p1/p2.  */
45   SW_REF_NOT_FOUND  = 0x6a88,
46   SW_BAD_P0_P1      = 0x6b00,
47   SW_EXACT_LENGTH   = 0x6c00,
48   SW_INS_NOT_SUP    = 0x6d00,
49   SW_CLA_NOT_SUP    = 0x6e00,
50   SW_SUCCESS        = 0x9000,
51
52   /* The follwoing statuswords are no real ones but used to map host
53      OS errors into status words.  A status word is 16 bit so that
54      those values can't be issued by a card. */
55   SW_HOST_OUT_OF_CORE = 0x10001,  /* No way yet to differentiate
56                                      between errnos on a failed malloc. */
57   SW_HOST_INV_VALUE     = 0x10002,
58   SW_HOST_INCOMPLETE_CARD_RESPONSE = 0x10003,
59   SW_HOST_NO_DRIVER     = 0x10004,
60   SW_HOST_NOT_SUPPORTED = 0x10005,
61   SW_HOST_LOCKING_FAILED= 0x10006,
62   SW_HOST_BUSY          = 0x10007,
63   SW_HOST_NO_CARD       = 0x10008,
64   SW_HOST_CARD_INACTIVE = 0x10009,
65   SW_HOST_CARD_IO_ERROR = 0x1000a,
66   SW_HOST_GENERAL_ERROR = 0x1000b,
67   SW_HOST_NO_READER     = 0x1000c,
68   SW_HOST_ABORTED       = 0x1000d,
69   SW_HOST_NO_KEYPAD     = 0x1000e,
70   SW_HOST_ALREADY_CONNECTED = 0x1000f
71 };
72
73
74 #define SW_EXACT_LENGTH_P(a) (((a)&~0xff) == SW_EXACT_LENGTH)
75
76
77 /* Bit flags for the card status.  */
78 #define APDU_CARD_USABLE   (1)    /* Card is present and ready for use.  */
79 #define APDU_CARD_PRESENT  (2)    /* Card is just present.  */
80 #define APDU_CARD_ACTIVE   (4)    /* Card is active.  */
81
82
83 /* Note, that apdu_open_reader returns no status word but -1 on error. */
84 int apdu_open_reader (const char *portstr, int *r_no_service);
85 int apdu_open_remote_reader (const char *portstr,
86                              const unsigned char *cookie, size_t length,
87                              int (*readfnc) (void *opaque,
88                                              void *buffer, size_t size),
89                              void *readfnc_value,
90                              int (*writefnc) (void *opaque,
91                                               const void *buffer, size_t size),
92                              void *writefnc_value,
93                              void (*closefnc) (void *opaque),
94                              void *closefnc_value);
95 int apdu_shutdown_reader (int slot);
96 int apdu_close_reader (int slot);
97 void apdu_prepare_exit (void);
98 int apdu_enum_reader (int slot, int *used);
99 unsigned char *apdu_get_atr (int slot, size_t *atrlen);
100
101 const char *apdu_strerror (int rc);
102
103
104 /* These APDU functions return status words. */
105
106 int apdu_connect (int slot);
107 int apdu_disconnect (int slot);
108
109 int apdu_set_progress_cb (int slot, gcry_handler_progress_t cb, void *cb_arg);
110
111 int apdu_activate (int slot);
112 int apdu_reset (int slot);
113 int apdu_get_status (int slot, int hang,
114                      unsigned int *status, unsigned int *changed);
115 int apdu_check_keypad (int slot, int command, int pin_mode,
116                        int pinlen_min, int pinlen_max, int pin_padlen);
117 int apdu_send_simple (int slot, int extended_mode,
118                       int class, int ins, int p0, int p1,
119                       int lc, const char *data);
120 int apdu_send_simple_kp (int slot, int class, int ins, int p0, int p1,
121                          int lc, const char *data,  
122                          int pin_mode,
123                          int pinlen_min, int pinlen_max, int pin_padlen);
124 int apdu_send (int slot, int extended_mode, 
125                int class, int ins, int p0, int p1, int lc, const char *data,
126                unsigned char **retbuf, size_t *retbuflen);
127 int apdu_send_le (int slot, int extended_mode, 
128                   int class, int ins, int p0, int p1,
129                   int lc, const char *data, int le,
130                   unsigned char **retbuf, size_t *retbuflen);
131 int apdu_send_direct (int slot, size_t extended_length,
132                       const unsigned char *apdudata, size_t apdudatalen,
133                       int handle_more,
134                       unsigned char **retbuf, size_t *retbuflen);
135
136
137 #endif /*APDU_H*/
138
139
140