scd: Introduce a virtual reader table.
[gnupg.git] / scd / iso7816.h
1 /* iso7816.h - 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 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
20 #ifndef ISO7816_H
21 #define ISO7816_H
22
23 #if GNUPG_MAJOR_VERSION == 1
24 #include "cardglue.h"
25 #endif
26
27 /* Command codes used by iso7816_check_keypad. */
28 #define ISO7816_VERIFY                0x20
29 #define ISO7816_CHANGE_REFERENCE_DATA 0x24
30 #define ISO7816_RESET_RETRY_COUNTER   0x2C
31
32
33 /* Information to be passed to keypad equipped readers.  See
34    ccid-driver.c for details. */
35 struct iso7816_pininfo_s
36 {
37   int mode;    /* A mode of 0 means: Do not use the keypad. */
38   int minlen;
39   int maxlen;
40   int padlen;
41   int padchar;
42 };
43 typedef struct iso7816_pininfo_s iso7816_pininfo_t;
44
45
46 gpg_error_t iso7816_map_sw (int sw);
47
48 gpg_error_t iso7816_select_application (int slot,
49                                         const char *aid, size_t aidlen,
50                                         unsigned int flags);
51 gpg_error_t iso7816_select_file (int slot, int tag, int is_dir,
52                                  unsigned char **result, size_t *resultlen);
53 gpg_error_t iso7816_select_path (int slot,
54                                  const unsigned short *path, size_t pathlen,
55                                  unsigned char **result, size_t *resultlen);
56 gpg_error_t iso7816_list_directory (int slot, int list_dirs,
57                                     unsigned char **result, size_t *resultlen);
58 gpg_error_t iso7816_apdu_direct (int slot,
59                                  const void *apdudata, size_t apdudatalen,
60                                  int handle_more,
61                                  unsigned char **result, size_t *resultlen);
62 gpg_error_t iso7816_check_keypad (int slot, int command,
63                                   iso7816_pininfo_t *pininfo);
64 gpg_error_t iso7816_verify (int slot,
65                             int chvno, const char *chv, size_t chvlen);
66 gpg_error_t iso7816_verify_kp (int slot, int chvno, iso7816_pininfo_t *pininfo);
67 gpg_error_t iso7816_change_reference_data (int slot, int chvno,
68                                const char *oldchv, size_t oldchvlen,
69                                const char *newchv, size_t newchvlen);
70 gpg_error_t iso7816_change_reference_data_kp (int slot, int chvno,
71                                               int is_exchange,
72                                               iso7816_pininfo_t *pininfo);
73 gpg_error_t iso7816_reset_retry_counter (int slot, int chvno,
74                                          const char *newchv, size_t newchvlen);
75 gpg_error_t iso7816_reset_retry_counter_with_rc (int slot, int chvno,
76                                                  const char *data,
77                                                  size_t datalen);
78 gpg_error_t iso7816_get_data (int slot, int extended_mode, int tag,
79                               unsigned char **result, size_t *resultlen);
80 gpg_error_t iso7816_put_data (int slot, int extended_mode, int tag,
81                               const void *data, size_t datalen);
82 gpg_error_t iso7816_put_data_odd (int slot, int extended_mode, int tag,
83                                   const void *data, size_t datalen);
84 gpg_error_t iso7816_manage_security_env (int slot, int p1, int p2,
85                                          const unsigned char *data,
86                                          size_t datalen);
87 gpg_error_t iso7816_compute_ds (int slot, int extended_mode,
88                                 const unsigned char *data, size_t datalen,
89                                 int le,
90                                 unsigned char **result, size_t *resultlen);
91 gpg_error_t iso7816_decipher (int slot, int extended_mode,
92                               const unsigned char *data, size_t datalen,
93                               int le, int padind,
94                               unsigned char **result, size_t *resultlen);
95 gpg_error_t iso7816_internal_authenticate (int slot, int extended_mode,
96                                    const unsigned char *data, size_t datalen,
97                                    int le,
98                                    unsigned char **result, size_t *resultlen);
99 gpg_error_t iso7816_generate_keypair (int slot, int extended_mode,
100                                     const unsigned char *data, size_t datalen,
101                                     int le,
102                                     unsigned char **result, size_t *resultlen);
103 gpg_error_t iso7816_read_public_key (int slot, int extended_mode,
104                                     const unsigned char *data, size_t datalen,
105                                     int le,
106                                     unsigned char **result, size_t *resultlen);
107 gpg_error_t iso7816_get_challenge (int slot,
108                                    int length, unsigned char *buffer);
109
110 gpg_error_t iso7816_read_binary (int slot, size_t offset, size_t nmax,
111                                  unsigned char **result, size_t *resultlen);
112 gpg_error_t iso7816_read_record (int slot, int recno, int reccount,
113                                  int short_ef,
114                                  unsigned char **result, size_t *resultlen);
115
116 #endif /*ISO7816_H*/