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