Statistics
| Branch: | Revision:

root / libcacard / card_7816t.h @ 26ca8c06

History | View | Annotate | Download (6.9 kB)

1 111a38b0 Robert Relyea
/*
2 111a38b0 Robert Relyea
 * Implement the 7816 portion of the card spec
3 111a38b0 Robert Relyea
 *
4 111a38b0 Robert Relyea
 * This work is licensed under the terms of the GNU LGPL, version 2.1 or later.
5 111a38b0 Robert Relyea
 * See the COPYING.LIB file in the top-level directory.
6 111a38b0 Robert Relyea
 */
7 111a38b0 Robert Relyea
#ifndef CARD_7816T_H
8 111a38b0 Robert Relyea
#define CARD_7816T_H 1
9 111a38b0 Robert Relyea
10 111a38b0 Robert Relyea
typedef unsigned short vcard_7816_status_t;
11 111a38b0 Robert Relyea
12 111a38b0 Robert Relyea
struct VCardResponseStruct {
13 111a38b0 Robert Relyea
    unsigned char *b_data;
14 111a38b0 Robert Relyea
    vcard_7816_status_t b_status;
15 111a38b0 Robert Relyea
    unsigned char b_sw1;
16 111a38b0 Robert Relyea
    unsigned char b_sw2;
17 111a38b0 Robert Relyea
    int b_len;
18 111a38b0 Robert Relyea
    int b_total_len;
19 111a38b0 Robert Relyea
    enum VCardResponseBufferType {
20 111a38b0 Robert Relyea
        VCARD_MALLOC,
21 111a38b0 Robert Relyea
        VCARD_MALLOC_DATA,
22 111a38b0 Robert Relyea
        VCARD_MALLOC_STRUCT,
23 111a38b0 Robert Relyea
        VCARD_STATIC
24 111a38b0 Robert Relyea
    } b_type;
25 111a38b0 Robert Relyea
};
26 111a38b0 Robert Relyea
27 111a38b0 Robert Relyea
#define VCARD_RESPONSE_NEW_STATIC_STATUS(stat) \
28 111a38b0 Robert Relyea
static const VCardResponse VCardResponse##stat = \
29 111a38b0 Robert Relyea
        {(unsigned char *)&VCardResponse##stat.b_sw1, (stat), ((stat) >> 8), \
30 111a38b0 Robert Relyea
         ((stat) & 0xff), 0, 2, VCARD_STATIC};
31 111a38b0 Robert Relyea
32 111a38b0 Robert Relyea
#define VCARD_RESPONSE_NEW_STATIC_STATUS_BYTES(sw1, sw2) \
33 111a38b0 Robert Relyea
static const VCardResponse VCARDResponse##sw1 = \
34 111a38b0 Robert Relyea
        {(unsigned char *)&VCardResponse##name.b_sw1, ((sw1) << 8 | (sw2)), \
35 111a38b0 Robert Relyea
         (sw1), (sw2), 0, 2, VCARD_STATIC};
36 111a38b0 Robert Relyea
37 111a38b0 Robert Relyea
/* cast away the const, callers need may need to 'free' the
38 111a38b0 Robert Relyea
 * result, and const implies that they don't */
39 111a38b0 Robert Relyea
#define VCARD_RESPONSE_GET_STATIC(name) \
40 111a38b0 Robert Relyea
        ((VCardResponse *)(&VCardResponse##name))
41 111a38b0 Robert Relyea
42 111a38b0 Robert Relyea
typedef enum {
43 111a38b0 Robert Relyea
    VCARD_7816_ISO,
44 111a38b0 Robert Relyea
    VCARD_7816_RFU,
45 111a38b0 Robert Relyea
    VCARD_7816_PTS,
46 111a38b0 Robert Relyea
    VCARD_7816_PROPIETARY
47 111a38b0 Robert Relyea
} VCardAPDUType;
48 111a38b0 Robert Relyea
49 111a38b0 Robert Relyea
50 111a38b0 Robert Relyea
/*
51 111a38b0 Robert Relyea
 * 7816 header. All APDU's have this header.
52 111a38b0 Robert Relyea
 * They must be laid out in this order.
53 111a38b0 Robert Relyea
 */
54 111a38b0 Robert Relyea
struct VCardAPDUHeader {
55 111a38b0 Robert Relyea
    unsigned char ah_cla;
56 111a38b0 Robert Relyea
    unsigned char ah_ins;
57 111a38b0 Robert Relyea
    unsigned char ah_p1;
58 111a38b0 Robert Relyea
    unsigned char ah_p2;
59 111a38b0 Robert Relyea
    unsigned char ah_Le;
60 111a38b0 Robert Relyea
    unsigned char ah_body[1]; /* indefinate length */
61 111a38b0 Robert Relyea
};
62 111a38b0 Robert Relyea
63 111a38b0 Robert Relyea
/*
64 111a38b0 Robert Relyea
 * 7816 APDU structure. The raw bytes are stored in the union and can be
65 111a38b0 Robert Relyea
 * accessed directly through u.data (which is aliased as a_data).
66 111a38b0 Robert Relyea
 *
67 111a38b0 Robert Relyea
 * Names of the fields match the 7816 documentation.
68 111a38b0 Robert Relyea
 */
69 111a38b0 Robert Relyea
struct VCardAPDUStruct {
70 111a38b0 Robert Relyea
    int a_len;                /* length of the whole buffer, including header */
71 111a38b0 Robert Relyea
    int a_Lc;                 /* 7816 Lc (parameter length) value */
72 111a38b0 Robert Relyea
    int a_Le;                 /* 7816 Le (expected result length) value */
73 111a38b0 Robert Relyea
    unsigned char *a_body;    /* pointer to the parameter */
74 111a38b0 Robert Relyea
    int a_channel;            /* decoded channel */
75 111a38b0 Robert Relyea
    int a_secure_messaging;   /* decoded secure messaging type */
76 111a38b0 Robert Relyea
    int a_type;               /* decoded type from cla (top nibble of class) */
77 111a38b0 Robert Relyea
    VCardAPDUType a_gen_type; /* generic type (7816, PROPRIETARY, RFU, etc) */
78 111a38b0 Robert Relyea
    union {
79 111a38b0 Robert Relyea
        struct VCardAPDUHeader *header;
80 111a38b0 Robert Relyea
        unsigned char   *data;
81 111a38b0 Robert Relyea
    } u;
82 111a38b0 Robert Relyea
/* give the subfields a unified look */
83 111a38b0 Robert Relyea
#define a_header u.header
84 111a38b0 Robert Relyea
#define a_data u.data
85 111a38b0 Robert Relyea
#define a_cla a_header->ah_cla /* class */
86 111a38b0 Robert Relyea
#define a_ins a_header->ah_ins /* instruction */
87 111a38b0 Robert Relyea
#define a_p1 a_header->ah_p1   /* parameter 1 */
88 111a38b0 Robert Relyea
#define a_p2 a_header->ah_p2   /* parameter 2 */
89 111a38b0 Robert Relyea
};
90 111a38b0 Robert Relyea
91 111a38b0 Robert Relyea
/* 7816 status codes */
92 111a38b0 Robert Relyea
#define VCARD7816_STATUS_SUCCESS                              0x9000
93 111a38b0 Robert Relyea
#define VCARD7816_STATUS_WARNING                              0x6200
94 111a38b0 Robert Relyea
#define VCARD7816_STATUS_WARNING_RET_CORUPT                   0x6281
95 111a38b0 Robert Relyea
#define VCARD7816_STATUS_WARNING_BUF_END_BEFORE_LE            0x6282
96 111a38b0 Robert Relyea
#define VCARD7816_STATUS_WARNING_INVALID_FILE_SELECTED        0x6283
97 111a38b0 Robert Relyea
#define VCARD7816_STATUS_WARNING_FCI_FORMAT_INVALID           0x6284
98 111a38b0 Robert Relyea
#define VCARD7816_STATUS_WARNING_CHANGE                       0x6300
99 111a38b0 Robert Relyea
#define VCARD7816_STATUS_WARNING_FILE_FILLED                  0x6381
100 111a38b0 Robert Relyea
#define VCARD7816_STATUS_EXC_ERROR                            0x6400
101 111a38b0 Robert Relyea
#define VCARD7816_STATUS_EXC_ERROR_CHANGE                     0x6500
102 111a38b0 Robert Relyea
#define VCARD7816_STATUS_EXC_ERROR_MEMORY_FAILURE             0x6581
103 111a38b0 Robert Relyea
#define VCARD7816_STATUS_ERROR_WRONG_LENGTH                   0x6700
104 111a38b0 Robert Relyea
#define VCARD7816_STATUS_ERROR_CLA_NOT_SUPPORTED              0x6800
105 111a38b0 Robert Relyea
#define VCARD7816_STATUS_ERROR_CHANNEL_NOT_SUPPORTED          0x6881
106 111a38b0 Robert Relyea
#define VCARD7816_STATUS_ERROR_SECURE_NOT_SUPPORTED           0x6882
107 111a38b0 Robert Relyea
#define VCARD7816_STATUS_ERROR_COMMAND_NOT_SUPPORTED          0x6900
108 111a38b0 Robert Relyea
#define VCARD7816_STATUS_ERROR_COMMAND_INCOMPATIBLE_WITH_FILE 0x6981
109 111a38b0 Robert Relyea
#define VCARD7816_STATUS_ERROR_SECURITY_NOT_SATISFIED         0x6982
110 111a38b0 Robert Relyea
#define VCARD7816_STATUS_ERROR_AUTHENTICATION_BLOCKED         0x6983
111 111a38b0 Robert Relyea
#define VCARD7816_STATUS_ERROR_DATA_INVALID                   0x6984
112 111a38b0 Robert Relyea
#define VCARD7816_STATUS_ERROR_CONDITION_NOT_SATISFIED        0x6985
113 111a38b0 Robert Relyea
#define VCARD7816_STATUS_ERROR_DATA_NO_EF                     0x6986
114 111a38b0 Robert Relyea
#define VCARD7816_STATUS_ERROR_SM_OBJECT_MISSING              0x6987
115 111a38b0 Robert Relyea
#define VCARD7816_STATUS_ERROR_SM_OBJECT_INCORRECT            0x6988
116 111a38b0 Robert Relyea
#define VCARD7816_STATUS_ERROR_WRONG_PARAMETERS               0x6a00
117 111a38b0 Robert Relyea
#define VCARD7816_STATUS_ERROR_WRONG_PARAMETERS_IN_DATA       0x6a80
118 111a38b0 Robert Relyea
#define VCARD7816_STATUS_ERROR_FUNCTION_NOT_SUPPORTED         0x6a81
119 111a38b0 Robert Relyea
#define VCARD7816_STATUS_ERROR_FILE_NOT_FOUND                 0x6a82
120 111a38b0 Robert Relyea
#define VCARD7816_STATUS_ERROR_RECORD_NOT_FOUND               0x6a83
121 111a38b0 Robert Relyea
#define VCARD7816_STATUS_ERROR_NO_SPACE_FOR_FILE              0x6a84
122 111a38b0 Robert Relyea
#define VCARD7816_STATUS_ERROR_LC_TLV_INCONSISTENT            0x6a85
123 111a38b0 Robert Relyea
#define VCARD7816_STATUS_ERROR_P1_P2_INCORRECT                0x6a86
124 111a38b0 Robert Relyea
#define VCARD7816_STATUS_ERROR_LC_P1_P2_INCONSISTENT          0x6a87
125 111a38b0 Robert Relyea
#define VCARD7816_STATUS_ERROR_DATA_NOT_FOUND                 0x6a88
126 111a38b0 Robert Relyea
#define VCARD7816_STATUS_ERROR_WRONG_PARAMETERS_2             0x6b00
127 111a38b0 Robert Relyea
#define VCARD7816_STATUS_ERROR_INS_CODE_INVALID               0x6d00
128 111a38b0 Robert Relyea
#define VCARD7816_STATUS_ERROR_CLA_INVALID                    0x6e00
129 111a38b0 Robert Relyea
#define VCARD7816_STATUS_ERROR_GENERAL                        0x6f00
130 111a38b0 Robert Relyea
/* 7816 sw1 codes */
131 111a38b0 Robert Relyea
#define VCARD7816_SW1_SUCCESS               0x90
132 111a38b0 Robert Relyea
#define VCARD7816_SW1_RESPONSE_BYTES        0x61
133 111a38b0 Robert Relyea
#define VCARD7816_SW1_WARNING               0x62
134 111a38b0 Robert Relyea
#define VCARD7816_SW1_WARNING_CHANGE        0x63
135 111a38b0 Robert Relyea
#define VCARD7816_SW1_EXC_ERROR             0x64
136 111a38b0 Robert Relyea
#define VCARD7816_SW1_EXC_ERROR_CHANGE      0x65
137 111a38b0 Robert Relyea
#define VCARD7816_SW1_ERROR_WRONG_LENGTH    0x67
138 111a38b0 Robert Relyea
#define VCARD7816_SW1_CLA_ERROR             0x68
139 111a38b0 Robert Relyea
#define VCARD7816_SW1_COMMAND_ERROR         0x69
140 111a38b0 Robert Relyea
#define VCARD7816_SW1_P1_P2_ERROR           0x6a
141 111a38b0 Robert Relyea
#define VCARD7816_SW1_LE_ERROR              0x6c
142 111a38b0 Robert Relyea
#define VCARD7816_SW1_INS_ERROR             0x6d
143 111a38b0 Robert Relyea
#define VCARD7816_SW1_CLA_NOT_SUPPORTED     0x6e
144 111a38b0 Robert Relyea
145 111a38b0 Robert Relyea
/* 7816 Instructions */
146 111a38b0 Robert Relyea
#define VCARD7816_INS_MANAGE_CHANNEL        0x70
147 111a38b0 Robert Relyea
#define VCARD7816_INS_EXTERNAL_AUTHENTICATE 0x82
148 111a38b0 Robert Relyea
#define VCARD7816_INS_GET_CHALLENGE         0x84
149 111a38b0 Robert Relyea
#define VCARD7816_INS_INTERNAL_AUTHENTICATE 0x88
150 111a38b0 Robert Relyea
#define VCARD7816_INS_ERASE_BINARY          0x0e
151 111a38b0 Robert Relyea
#define VCARD7816_INS_READ_BINARY           0xb0
152 111a38b0 Robert Relyea
#define VCARD7816_INS_WRITE_BINARY          0xd0
153 111a38b0 Robert Relyea
#define VCARD7816_INS_UPDATE_BINARY         0xd6
154 111a38b0 Robert Relyea
#define VCARD7816_INS_READ_RECORD           0xb2
155 111a38b0 Robert Relyea
#define VCARD7816_INS_WRITE_RECORD          0xd2
156 111a38b0 Robert Relyea
#define VCARD7816_INS_UPDATE_RECORD         0xdc
157 111a38b0 Robert Relyea
#define VCARD7816_INS_APPEND_RECORD         0xe2
158 111a38b0 Robert Relyea
#define VCARD7816_INS_ENVELOPE              0xc2
159 111a38b0 Robert Relyea
#define VCARD7816_INS_PUT_DATA              0xda
160 111a38b0 Robert Relyea
#define VCARD7816_INS_GET_DATA              0xca
161 111a38b0 Robert Relyea
#define VCARD7816_INS_SELECT_FILE           0xa4
162 111a38b0 Robert Relyea
#define VCARD7816_INS_VERIFY                0x20
163 111a38b0 Robert Relyea
#define VCARD7816_INS_GET_RESPONSE          0xc0
164 111a38b0 Robert Relyea
165 111a38b0 Robert Relyea
#endif