Harald Welte | d54c2ee | 2012-01-17 18:25:50 +0100 | [diff] [blame] | 1 | #ifndef _OSMOCOM_SIM_H |
| 2 | #define _OSMOCOM_SIM_H |
| 3 | |
| 4 | #include <osmocom/core/msgb.h> |
| 5 | #include <osmocom/core/linuxlist.h> |
| 6 | |
| 7 | #define APDU_HDR_LEN 5 |
| 8 | |
Kevin Redon | 43eabee | 2012-09-16 18:40:02 +0200 | [diff] [blame] | 9 | /*! |
| 10 | * \file sim.h |
| 11 | * \brief Routines for helping with SIM (ISO/IEC 7816-4 more generally) communication. |
| 12 | */ |
| 13 | |
| 14 | /*! \brief command-response pairs cases |
| 15 | * |
| 16 | * Enumeration used to identify the APDU structure based on command-response pair case , as specified in ISO/IEC 7816-3:2006(E) §12.1. |
| 17 | */ |
Harald Welte | d54c2ee | 2012-01-17 18:25:50 +0100 | [diff] [blame] | 18 | enum osim_apdu_case { |
Kevin Redon | 43eabee | 2012-09-16 18:40:02 +0200 | [diff] [blame] | 19 | APDU_CASE_1, /*!< command header, no command data field, no response data field */ |
| 20 | APDU_CASE_2S, /*!< command header, no command data field, response data field (short) */ |
| 21 | APDU_CASE_2E, /*!< command header, no command data field, response data field (extended) */ |
| 22 | APDU_CASE_3S, /*!< command header, command data field (short), no response data field */ |
| 23 | APDU_CASE_3E, /*!< command header, command data field (extended), no response data field */ |
| 24 | APDU_CASE_4S, /*!< command header, command data field (short), response data field (short) */ |
| 25 | APDU_CASE_4E /*!< command header, command data field (extended), response data field (extended) */ |
Harald Welte | d54c2ee | 2012-01-17 18:25:50 +0100 | [diff] [blame] | 26 | }; |
| 27 | |
Kevin Redon | 43eabee | 2012-09-16 18:40:02 +0200 | [diff] [blame] | 28 | /*! \brief APDU/TPDU command header |
| 29 | * |
| 30 | * This structure encode an APDU/TPDU command header, as specified in ISO/IEC 7816-3:2006(E) §12.2 and §12.3. |
| 31 | * The APDU (application layer) can be encoded as different TPDUs (transport layer), depending on the transport protocol used. |
| 32 | * The TPDU encoding by T=1 of the APDU command header is identical to the APDU. |
| 33 | * The TPDU encoding by T=0 of the APDU command header adds a Parameter 3 field, generally used instead of Lc/Le. |
| 34 | * |
| 35 | * @todo have different structures for APDU, TPDU by T=0, and TPDU by T=1. |
| 36 | */ |
Harald Welte | d54c2ee | 2012-01-17 18:25:50 +0100 | [diff] [blame] | 37 | struct osim_apdu_cmd_hdr { |
Kevin Redon | 43eabee | 2012-09-16 18:40:02 +0200 | [diff] [blame] | 38 | uint8_t cla; /*!< CLASS byte */ |
| 39 | uint8_t ins; /*!< INSTRUCTION byte */ |
| 40 | uint8_t p1; /*!< Parameter 1 byte */ |
| 41 | uint8_t p2; /*!< Parameter 2 byte */ |
| 42 | uint8_t p3; /*!< Parameter 3 byte, used for TPDU by T=0 */ |
Harald Welte | d54c2ee | 2012-01-17 18:25:50 +0100 | [diff] [blame] | 43 | } __attribute__ ((packed)); |
| 44 | |
| 45 | #define msgb_apdu_dr(__x) |
| 46 | |
Kevin Redon | 43eabee | 2012-09-16 18:40:02 +0200 | [diff] [blame] | 47 | /*! \brief APDU command body |
| 48 | * |
| 49 | * This structure encode a command body, as specified in ISO/IEC 7816-3:2006(E) §12.1. |
| 50 | * The data and response contents should be provided along with this structure. |
| 51 | */ |
Harald Welte | d54c2ee | 2012-01-17 18:25:50 +0100 | [diff] [blame] | 52 | struct osim_msgb_cb { |
Kevin Redon | 43eabee | 2012-09-16 18:40:02 +0200 | [diff] [blame] | 53 | enum osim_apdu_case apduc; /*!< command-response pair case, defining the encoding of Lc and Le */ |
| 54 | uint16_t lc; /*!< number of bytes in the command data field Nc, which will encoded in 0, 1 or 3 bytes into Lc, depending on the case */ |
| 55 | uint16_t le; /*!< maximum number of bytes expected in the response data field, which will encoded in 0, 1, 2 or 3 bytes into Le, depending on the case */ |
| 56 | uint16_t sw; /*!< status word, composed of SW1 and SW2 bytes */ |
Harald Welte | e8dd2bd | 2014-05-04 13:42:38 +0200 | [diff] [blame^] | 57 | } __attribute__((__may_alias__)); |
Harald Welte | d54c2ee | 2012-01-17 18:25:50 +0100 | [diff] [blame] | 58 | #define OSIM_MSGB_CB(__msgb) ((struct osim_msgb_cb *)&((__msgb)->cb[0])) |
| 59 | /*! \brief status word from msgb->cb */ |
| 60 | #define msgb_apdu_case(__x) OSIM_MSGB_CB(__x)->apduc |
| 61 | #define msgb_apdu_lc(__x) OSIM_MSGB_CB(__x)->lc |
| 62 | #define msgb_apdu_le(__x) OSIM_MSGB_CB(__x)->le |
| 63 | #define msgb_apdu_sw(__x) OSIM_MSGB_CB(__x)->sw |
| 64 | /*! \brief pointer to the command header of the APDU */ |
| 65 | #define msgb_apdu_h(__x) ((struct osim_apdu_cmd_hdr *)(__x)->l2h) |
| 66 | |
| 67 | #define msgb_apdu_dc(__x) ((__x)->l2h + sizeof(struct osim_apdu_cmd_hdr)) |
| 68 | #define msgb_apdu_de(__x) ((__x)->l2h + sizeof(struct osim_apdu_cmd_hdr) + msgb_apdu_lc(__x)) |
| 69 | |
| 70 | struct osim_file; |
| 71 | struct osim_file_desc; |
| 72 | struct osim_decoded_data; |
| 73 | |
| 74 | struct osim_file_ops { |
| 75 | int (*parse)(struct osim_decoded_data *dd, |
| 76 | const struct osim_file_desc *desc, |
| 77 | int len, uint8_t *data); |
| 78 | struct msgb * (*encode)(const struct osim_file *file, |
| 79 | const struct osim_decoded_data *decoded); |
| 80 | }; |
| 81 | |
| 82 | enum osim_element_type { |
| 83 | ELEM_T_NONE, |
| 84 | ELEM_T_BOOL, /*!< a boolean flag */ |
| 85 | ELEM_T_UINT8, /*!< unsigned integer */ |
| 86 | ELEM_T_UINT16, /*!< unsigned integer */ |
| 87 | ELEM_T_UINT32, /*!< unsigned integer */ |
| 88 | ELEM_T_STRING, /*!< generic string */ |
| 89 | ELEM_T_BCD, /*!< BCD encoded digits */ |
| 90 | ELEM_T_BYTES, /*!< BCD encoded digits */ |
| 91 | ELEM_T_GROUP, /*!< group container, has siblings */ |
| 92 | }; |
| 93 | |
| 94 | enum osim_element_repr { |
| 95 | ELEM_REPR_NONE, |
| 96 | ELEM_REPR_DEC, |
| 97 | ELEM_REPR_HEX, |
| 98 | }; |
| 99 | |
| 100 | struct osim_decoded_element { |
| 101 | struct llist_head list; |
| 102 | |
| 103 | enum osim_element_type type; |
| 104 | enum osim_element_repr representation; |
| 105 | const char *name; |
| 106 | |
| 107 | unsigned int length; |
| 108 | union { |
| 109 | uint8_t u8; |
| 110 | uint16_t u16; |
| 111 | uint32_t u32; |
| 112 | uint8_t *buf; |
| 113 | struct llist_head siblings; |
| 114 | } u; |
| 115 | }; |
| 116 | |
| 117 | struct osim_decoded_data { |
| 118 | /*! file to which we belong */ |
| 119 | const struct osim_file *file; |
| 120 | /*! list of 'struct decoded_element' */ |
| 121 | struct llist_head decoded_elements; |
| 122 | }; |
| 123 | |
| 124 | |
| 125 | enum osim_file_type { |
| 126 | TYPE_NONE, |
| 127 | TYPE_DF, |
| 128 | TYPE_ADF, |
| 129 | TYPE_EF, |
| 130 | TYPE_EF_INT, |
| 131 | }; |
| 132 | |
| 133 | enum osim_ef_type { |
| 134 | EF_TYPE_TRANSP, |
| 135 | EF_TYPE_RECORD_FIXED, |
| 136 | EF_TYPE_RECORD_CYCLIC, |
| 137 | }; |
| 138 | |
| 139 | #define F_OPTIONAL 0x0001 |
| 140 | |
Harald Welte | 2656e65 | 2014-05-03 14:23:44 +0200 | [diff] [blame] | 141 | #define SFI_NONE 0xFF |
| 142 | |
Harald Welte | d54c2ee | 2012-01-17 18:25:50 +0100 | [diff] [blame] | 143 | struct osim_file_desc { |
| 144 | struct llist_head list; /*!< local element in list */ |
| 145 | struct llist_head child_list; /*!< list of children EF in DF */ |
| 146 | struct osim_file_desc *parent; /*!< parent DF */ |
| 147 | |
| 148 | enum osim_file_type type; |
| 149 | enum osim_ef_type ef_type; |
| 150 | |
| 151 | uint16_t fid; /*!< File Identifier */ |
| 152 | uint8_t sfid; /*!< Short File IDentifier */ |
| 153 | const char *df_name; |
| 154 | uint8_t df_name_len; |
| 155 | |
| 156 | const char *short_name; /*!< Short Name (like EF.ICCID) */ |
| 157 | const char *long_name; /*!< Long / description */ |
| 158 | unsigned int flags; |
| 159 | |
| 160 | struct osim_file_ops ops; |
Harald Welte | 1e0dfda | 2014-05-03 14:22:12 +0200 | [diff] [blame] | 161 | |
| 162 | struct { |
| 163 | size_t min; /*!< Minimum size of the file |
| 164 | (transparent) or record in |
| 165 | cyclic / linear file */ |
| 166 | size_t rec; /*!< Recommended size */ |
| 167 | } size; |
Harald Welte | d54c2ee | 2012-01-17 18:25:50 +0100 | [diff] [blame] | 168 | }; |
| 169 | |
| 170 | struct osim_file { |
| 171 | const struct osim_file_desc *desc; |
| 172 | |
| 173 | struct msgb *encoded_data; |
| 174 | struct osim_decoded_data *decoded_data; |
| 175 | }; |
| 176 | |
Harald Welte | 2656e65 | 2014-05-03 14:23:44 +0200 | [diff] [blame] | 177 | #define EF(pfid, sfi, pns, pflags, pnl, ptype, smin, srec, pdec, penc) \ |
Harald Welte | d54c2ee | 2012-01-17 18:25:50 +0100 | [diff] [blame] | 178 | { \ |
| 179 | .fid = pfid, \ |
Harald Welte | 2656e65 | 2014-05-03 14:23:44 +0200 | [diff] [blame] | 180 | .sfid = sfi, \ |
Harald Welte | d54c2ee | 2012-01-17 18:25:50 +0100 | [diff] [blame] | 181 | .type = TYPE_EF, \ |
| 182 | .ef_type = ptype, \ |
| 183 | .short_name = pns, \ |
| 184 | .long_name = pnl, \ |
| 185 | .flags = pflags, \ |
| 186 | .ops = { .encode = penc, .parse = pdec }, \ |
Harald Welte | 1e0dfda | 2014-05-03 14:22:12 +0200 | [diff] [blame] | 187 | .size = { .min = smin, .rec = srec}, \ |
Harald Welte | d54c2ee | 2012-01-17 18:25:50 +0100 | [diff] [blame] | 188 | } |
| 189 | |
| 190 | |
Harald Welte | 2656e65 | 2014-05-03 14:23:44 +0200 | [diff] [blame] | 191 | #define EF_TRANSP(fid, sfi, ns, flags, smin, srec, nl, dec, enc) \ |
| 192 | EF(fid, sfi, ns, flags, nl, EF_TYPE_TRANSP, \ |
Harald Welte | 1e0dfda | 2014-05-03 14:22:12 +0200 | [diff] [blame] | 193 | smin, srec, dec, enc) |
Harald Welte | 2656e65 | 2014-05-03 14:23:44 +0200 | [diff] [blame] | 194 | #define EF_TRANSP_N(fid, sfi, ns, flags, smin, srec, nl) \ |
| 195 | EF_TRANSP(fid, sfi, ns, flags, smin, srec, \ |
Harald Welte | 1e0dfda | 2014-05-03 14:22:12 +0200 | [diff] [blame] | 196 | nl, &default_decode, NULL) |
Harald Welte | d54c2ee | 2012-01-17 18:25:50 +0100 | [diff] [blame] | 197 | |
Harald Welte | 2656e65 | 2014-05-03 14:23:44 +0200 | [diff] [blame] | 198 | #define EF_CYCLIC(fid, sfi, ns, flags, smin, srec, nl, dec, enc) \ |
| 199 | EF(fid, sfi, ns, flags, nl, EF_TYPE_RECORD_CYCLIC, \ |
Harald Welte | 1e0dfda | 2014-05-03 14:22:12 +0200 | [diff] [blame] | 200 | smin, srec, dec, enc) |
Harald Welte | 2656e65 | 2014-05-03 14:23:44 +0200 | [diff] [blame] | 201 | #define EF_CYCLIC_N(fid, sfi, ns, flags, smin, srec, nl) \ |
| 202 | EF_CYCLIC(fid, sfi, ns, flags, smin, srec, nl, \ |
Harald Welte | 1e0dfda | 2014-05-03 14:22:12 +0200 | [diff] [blame] | 203 | &default_decode, NULL) |
Harald Welte | d54c2ee | 2012-01-17 18:25:50 +0100 | [diff] [blame] | 204 | |
Harald Welte | 2656e65 | 2014-05-03 14:23:44 +0200 | [diff] [blame] | 205 | #define EF_LIN_FIX(fid, sfi, ns, flags, smin, srec, nl, dec, enc) \ |
| 206 | EF(fid, sfi, ns, flags, nl, EF_TYPE_RECORD_FIXED, \ |
Harald Welte | 1e0dfda | 2014-05-03 14:22:12 +0200 | [diff] [blame] | 207 | smin, srec, dec, enc) |
| 208 | #define EF_LIN_FIX_N(fid, sfi, ns, flags, smin, srec, nl) \ |
| 209 | EF_LIN_FIX(fid, sfi, ns, flags, smin, srec, nl, \ |
| 210 | &default_decode, NULL) |
Harald Welte | d54c2ee | 2012-01-17 18:25:50 +0100 | [diff] [blame] | 211 | |
| 212 | struct osim_file_desc * |
| 213 | osim_file_find_name(struct osim_file_desc *parent, const char *name); |
| 214 | |
| 215 | enum osim_card_sw_type { |
| 216 | SW_TYPE_NONE, |
| 217 | SW_TYPE_STR, |
| 218 | }; |
| 219 | |
| 220 | enum osim_card_sw_class { |
| 221 | SW_CLS_NONE, |
| 222 | SW_CLS_OK, |
| 223 | SW_CLS_POSTP, |
| 224 | SW_CLS_WARN, |
| 225 | SW_CLS_ERROR, |
| 226 | }; |
| 227 | |
| 228 | struct osim_card_sw { |
| 229 | uint16_t code; |
| 230 | uint16_t mask; |
| 231 | enum osim_card_sw_type type; |
| 232 | enum osim_card_sw_class class; |
| 233 | union { |
| 234 | const char *str; |
| 235 | } u; |
| 236 | }; |
| 237 | |
Harald Welte | 7674960 | 2012-09-19 20:55:54 +0200 | [diff] [blame] | 238 | #define OSIM_CARD_SW_LAST (const struct osim_card_sw) { \ |
Harald Welte | d54c2ee | 2012-01-17 18:25:50 +0100 | [diff] [blame] | 239 | .code = 0, .mask = 0, .type = SW_TYPE_NONE, \ |
| 240 | .class = SW_CLS_NONE, .u.str = NULL \ |
| 241 | } |
| 242 | |
| 243 | struct osim_card_profile { |
| 244 | const char *name; |
| 245 | struct osim_file_desc *mf; |
Harald Welte | 7674960 | 2012-09-19 20:55:54 +0200 | [diff] [blame] | 246 | const struct osim_card_sw **sws; |
Harald Welte | d54c2ee | 2012-01-17 18:25:50 +0100 | [diff] [blame] | 247 | }; |
| 248 | |
Harald Welte | 7674960 | 2012-09-19 20:55:54 +0200 | [diff] [blame] | 249 | const struct osim_card_sw *osim_find_sw(const struct osim_card_profile *cp, |
| 250 | uint16_t sw); |
Harald Welte | d83d296 | 2013-03-04 17:52:33 +0000 | [diff] [blame] | 251 | enum osim_card_sw_class osim_sw_class(const struct osim_card_profile *cp, |
| 252 | uint16_t sw_in); |
Harald Welte | 7674960 | 2012-09-19 20:55:54 +0200 | [diff] [blame] | 253 | |
| 254 | struct osim_card_hdl; |
| 255 | char *osim_print_sw(const struct osim_card_hdl *ch, uint16_t sw_in); |
| 256 | |
Harald Welte | d54c2ee | 2012-01-17 18:25:50 +0100 | [diff] [blame] | 257 | extern const struct tlv_definition ts102221_fcp_tlv_def; |
| 258 | const struct value_string ts102221_fcp_vals[14]; |
| 259 | |
| 260 | /* 11.1.1.3 */ |
| 261 | enum ts102221_fcp_tag { |
| 262 | UICC_FCP_T_FCP = 0x62, |
| 263 | UICC_FCP_T_FILE_SIZE = 0x80, |
| 264 | UICC_FCP_T_TOT_F_SIZE = 0x81, |
| 265 | UICC_FCP_T_FILE_DESC = 0x82, |
| 266 | UICC_FCP_T_FILE_ID = 0x83, |
| 267 | UICC_FCP_T_DF_NAME = 0x84, |
| 268 | UICC_FCP_T_SFID = 0x88, |
| 269 | UICC_FCP_T_LIFEC_STS = 0x8A, |
| 270 | UICC_FCP_T_SEC_ATTR_REFEXP= 0x8B, |
| 271 | UICC_FCP_T_SEC_ATTR_COMP= 0x8C, |
| 272 | UICC_FCP_T_PROPRIETARY = 0xA5, |
| 273 | UICC_FCP_T_SEC_ATTR_EXP = 0xAB, |
| 274 | UICC_FCP_T_PIN_STS_DO = 0xC6, |
| 275 | }; |
| 276 | |
| 277 | struct msgb *osim_new_apdumsg(uint8_t cla, uint8_t ins, uint8_t p1, |
| 278 | uint8_t p2, uint16_t lc, uint16_t le); |
| 279 | |
| 280 | struct osim_reader_ops; |
| 281 | |
| 282 | struct osim_reader_hdl { |
| 283 | /*! \brief member in global list of readers */ |
| 284 | struct llist_head list; |
| 285 | struct osim_reader_ops *ops; |
| 286 | void *priv; |
| 287 | /*! \brief current card, if any */ |
| 288 | struct osim_card_hdl *card; |
| 289 | }; |
| 290 | |
| 291 | struct osim_card_hdl { |
| 292 | /*! \brief member in global list of cards */ |
| 293 | struct llist_head list; |
| 294 | /*! \brief reader through which card is accessed */ |
| 295 | struct osim_reader_hdl *reader; |
| 296 | /*! \brief card profile */ |
| 297 | struct osim_card_profile *prof; |
| 298 | |
| 299 | /*! \brief list of channels for this card */ |
| 300 | struct llist_head channels; |
| 301 | }; |
| 302 | |
| 303 | struct osim_chan_hdl { |
| 304 | /*! \brief linked to card->channels */ |
| 305 | struct llist_head list; |
| 306 | /*! \brief card to which this channel belongs */ |
| 307 | struct osim_card_hdl *card; |
| 308 | const struct osim_file_desc *cwd; |
| 309 | }; |
| 310 | |
| 311 | /* reader.c */ |
| 312 | int osim_transceive_apdu(struct osim_chan_hdl *st, struct msgb *amsg); |
Harald Welte | d83d296 | 2013-03-04 17:52:33 +0000 | [diff] [blame] | 313 | struct osim_reader_hdl *osim_reader_open(int idx, const char *name, void *ctx); |
Harald Welte | d54c2ee | 2012-01-17 18:25:50 +0100 | [diff] [blame] | 314 | struct osim_card_hdl *osim_card_open(struct osim_reader_hdl *rh); |
| 315 | #endif /* _OSMOCOM_SIM_H */ |