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