sim.h

Go to the documentation of this file.

 
#pragma once
 
#include <osmocom/core/msgb.h>
#include <osmocom/core/linuxlist.h>
 
#define APDU_HDR_LEN    5
#define MAX_AID_LEN     16 /* Table 13.2 of TS 102 221 */
 
 
#define OSIM_MAX_ATR_LEN 33
 
enum osim_apdu_case {
        APDU_CASE_1, 
        APDU_CASE_2S, 
        APDU_CASE_2E, 
        APDU_CASE_3S, 
        APDU_CASE_3E, 
        APDU_CASE_4S, 
        APDU_CASE_4E 
};
 
struct osim_apdu_cmd_hdr {
        uint8_t cla; 
        uint8_t ins; 
        uint8_t p1; 
        uint8_t p2; 
        uint8_t p3; 
} __attribute__ ((packed));
 
#define msgb_apdu_dr(__x)
 
struct osim_msgb_cb {
        enum osim_apdu_case apduc; 
        uint16_t lc; 
        uint16_t le; 
        uint16_t sw; 
} __attribute__((__may_alias__));
#define OSIM_MSGB_CB(__msgb)    ((struct osim_msgb_cb *)&((__msgb)->cb[0]))
#define msgb_apdu_case(__x)     OSIM_MSGB_CB(__x)->apduc
#define msgb_apdu_lc(__x)       OSIM_MSGB_CB(__x)->lc
#define msgb_apdu_le(__x)       OSIM_MSGB_CB(__x)->le
#define msgb_apdu_sw(__x)       OSIM_MSGB_CB(__x)->sw
#define msgb_apdu_h(__x)        ((struct osim_apdu_cmd_hdr *)(__x)->l2h)
 
#define msgb_apdu_dc(__x)       ((__x)->l2h + sizeof(struct osim_apdu_cmd_hdr))
#define msgb_apdu_de(__x)       ((__x)->l2h + sizeof(struct osim_apdu_cmd_hdr) + msgb_apdu_lc(__x))
 
int osim_init(void *ctx);
 
/* FILES */
 
struct osim_file;
struct osim_file_desc;
struct osim_decoded_data;
 
struct osim_file_ops {
        int (*parse)(struct osim_decoded_data *dd,
                     const struct osim_file_desc *desc,
                     int len, uint8_t *data);
        struct msgb * (*encode)(const struct osim_file_desc *desc,
                                const struct osim_decoded_data *decoded);
};
 
enum osim_element_type {
        ELEM_T_NONE,
        ELEM_T_BOOL,    
        ELEM_T_UINT8,   
        ELEM_T_UINT16,  
        ELEM_T_UINT32,  
        ELEM_T_STRING,  
        ELEM_T_BCD,     
        ELEM_T_BYTES,   
        ELEM_T_GROUP,   
};
 
enum osim_element_repr {
        ELEM_REPR_NONE,
        ELEM_REPR_DEC,
        ELEM_REPR_HEX,
};
 
struct osim_decoded_element {
        struct llist_head list;
 
        enum osim_element_type type;
        enum osim_element_repr representation;
        const char *name;
 
        unsigned int length;
        union {
                uint8_t u8;
                uint16_t u16;
                uint32_t u32;
                uint8_t *buf;
                struct llist_head siblings;
        } u;
};
 
struct osim_decoded_data {
        const struct osim_file *file;
        struct llist_head decoded_elements;
};
 
 
enum osim_file_type {
        TYPE_NONE,
        TYPE_DF,        
        TYPE_ADF,       
        TYPE_EF,        
        TYPE_EF_INT,    
        TYPE_MF,        
};
 
enum osim_ef_type {
        EF_TYPE_TRANSP,         
        EF_TYPE_RECORD_FIXED,   
        EF_TYPE_RECORD_CYCLIC,  
        EF_TYPE_KEY,            
};
 
#define F_OPTIONAL              0x0001
 
#define SFI_NONE                0xFF
 
struct osim_file_desc {
        struct llist_head list;         
        struct llist_head child_list;   
        struct osim_file_desc *parent;  
        enum osim_file_type type;       
        enum osim_ef_type ef_type;      
        uint16_t fid;                   
        uint8_t sfid;                   
        const uint8_t *df_name;
        uint8_t df_name_len;
 
        const char *short_name;         
        const char *long_name;          
        unsigned int flags;
 
        struct osim_file_ops ops;       
        struct {
                size_t min;             
                size_t rec;             
        } size;
};
 
struct osim_file {
        const struct osim_file_desc *desc;
 
        struct msgb *encoded_data;
        struct osim_decoded_data *decoded_data;
};
 
#define EF(pfid, sfi, pns, pflags, pnl, ptype, smin, srec, pdec, penc)  \
        {                                                               \
                .fid            = pfid,                                 \
                .sfid           = sfi,                                  \
                .type           = TYPE_EF,                              \
                .ef_type        = ptype,                                \
                .short_name     = pns,                                  \
                .long_name      = pnl,                                  \
                .flags          = pflags,                               \
                .ops            = { .encode = penc, .parse = pdec },    \
                .size           = { .min = smin, .rec = srec},          \
        }
 
 
#define EF_TRANSP(fid, sfi, ns, flags, smin, srec, nl, dec, enc)        \
                EF(fid, sfi, ns, flags, nl, EF_TYPE_TRANSP,             \
                   smin, srec, dec, enc)
#define EF_TRANSP_N(fid, sfi, ns, flags, smin, srec, nl)                \
                EF_TRANSP(fid, sfi, ns, flags, smin, srec,              \
                          nl, &default_decode, NULL)
 
#define EF_CYCLIC(fid, sfi, ns, flags, smin, srec, nl, dec, enc)        \
                EF(fid, sfi, ns, flags, nl, EF_TYPE_RECORD_CYCLIC,      \
                   smin, srec, dec, enc)
#define EF_CYCLIC_N(fid, sfi, ns, flags, smin, srec, nl)                \
                EF_CYCLIC(fid, sfi, ns, flags, smin, srec, nl,          \
                          &default_decode, NULL)
 
#define EF_LIN_FIX(fid, sfi, ns, flags, smin, srec, nl, dec, enc)       \
                EF(fid, sfi, ns, flags, nl, EF_TYPE_RECORD_FIXED,       \
                   smin, srec, dec, enc)
#define EF_LIN_FIX_N(fid, sfi, ns, flags, smin, srec, nl)               \
                EF_LIN_FIX(fid, sfi, ns, flags, smin, srec, nl,         \
                           &default_decode, NULL)
 
#define EF_KEY(fid, sfi, ns, flags, smin, srec, nl, dec, enc)           \
                EF(fid, sfi, ns, flags, nl, EF_TYPE_KEY,                \
                   smin, srec, dec, enc)
#define EF_KEY_N(fid, sfi, ns, flags, smin, srec, nl)                   \
                EF_KEY(fid, sfi, ns, flags, smin, srec, nl,             \
                       &default_decode, NULL)
 
 
struct osim_file_desc *
osim_file_desc_find_name(struct osim_file_desc *parent, const char *name);
 
struct osim_file_desc *
osim_file_desc_find_aid(struct osim_file_desc *parent, const uint8_t *aid, uint8_t aid_len);
 
struct osim_file_desc *
osim_file_desc_find_fid(struct osim_file_desc *parent, uint16_t fid);
 
struct osim_file_desc *
osim_file_desc_find_sfid(struct osim_file_desc *parent, uint8_t sfid);
 
/* STATUS WORDS */
 
enum osim_card_sw_type {
        SW_TYPE_NONE,
        SW_TYPE_STR,
};
 
enum osim_card_sw_class {
        SW_CLS_NONE,
        SW_CLS_OK,
        SW_CLS_POSTP,
        SW_CLS_WARN,
        SW_CLS_ERROR,
};
 
struct osim_card_sw {
        uint16_t code;
        uint16_t mask;
        enum osim_card_sw_type type;
        enum osim_card_sw_class class;
        union {
                const char *str;
        } u;
};
 
#define OSIM_CARD_SW_LAST       {                       \
        .code = 0, .mask = 0, .type = SW_TYPE_NONE,     \
        .class = SW_CLS_NONE, .u.str = NULL             \
}
 
struct osim_card_app_profile {
        struct llist_head list;
        const char *name;
        uint8_t aid[MAX_AID_LEN];
        uint8_t aid_len;
        struct osim_file_desc *adf;
        const struct osim_card_sw *sw;
};
 
const struct osim_card_app_profile *
osim_app_profile_find_by_name(const char *name);
 
const struct osim_card_app_profile *
osim_app_profile_find_by_aid(const uint8_t *aid, uint8_t aid_len);
 
const struct osim_card_sw *osim_app_profile_find_sw(const struct osim_card_app_profile *ap, uint16_t sw_in);
 
struct osim_card_profile {
        const char *name;
        struct osim_file_desc *mf;
        const struct osim_card_sw **sws;
};
 
const struct osim_card_sw *osim_cprof_find_sw(const struct osim_card_profile *cp, uint16_t sw_in);
 
struct osim_chan_hdl;
enum osim_card_sw_class osim_sw_class(const struct osim_chan_hdl *ch, uint16_t sw_in);
char *osim_print_sw_buf(char *buf, size_t buf_len, const struct osim_chan_hdl *ch, uint16_t sw_in);
char *osim_print_sw(const struct osim_chan_hdl *ch, uint16_t sw_in);
char *osim_print_sw_c(const void *ctx, const struct osim_chan_hdl *ch, uint16_t sw_in);
 
extern const struct tlv_definition ts102221_fcp_tlv_def;
extern const struct value_string ts102221_fcp_vals[14];
 
/* 11.1.1.3 */
enum ts102221_fcp_tag {
        UICC_FCP_T_FCP          = 0x62,
        UICC_FCP_T_FILE_SIZE    = 0x80,
        UICC_FCP_T_TOT_F_SIZE   = 0x81,
        UICC_FCP_T_FILE_DESC    = 0x82,
        UICC_FCP_T_FILE_ID      = 0x83,
        UICC_FCP_T_DF_NAME      = 0x84,
        UICC_FCP_T_SFID         = 0x88,
        UICC_FCP_T_LIFEC_STS    = 0x8A,
        UICC_FCP_T_SEC_ATTR_REFEXP= 0x8B,
        UICC_FCP_T_SEC_ATTR_COMP= 0x8C,
        UICC_FCP_T_PROPRIETARY  = 0xA5,
        UICC_FCP_T_SEC_ATTR_EXP = 0xAB,
        UICC_FCP_T_PIN_STS_DO   = 0xC6,
};
 
struct msgb *osim_new_apdumsg(uint8_t cla, uint8_t ins, uint8_t p1,
                              uint8_t p2, uint16_t lc, uint16_t le);
 
/* CARD READERS */
 
enum osim_proto {
        OSIM_PROTO_T0   = 0,
        OSIM_PROTO_T1   = 1,
};
 
enum osim_reader_driver {
        OSIM_READER_DRV_PCSC = 0,
        OSIM_READER_DRV_OPENCT = 1,
        OSIM_READER_DRV_SERIAL = 2,
};
 
struct osim_reader_ops {
        const char *name;
        struct osim_reader_hdl *(*reader_open)(int idx, const char *name, void *ctx);
        struct osim_card_hdl *(*card_open)(struct osim_reader_hdl *rh, enum osim_proto proto);
        int (*card_reset)(struct osim_card_hdl *card, bool cold_reset);
        int (*card_close)(struct osim_card_hdl *card);
        int (*transceive)(struct osim_reader_hdl *rh, struct msgb *msg);
};
 
struct osim_reader_hdl {
        struct llist_head list;
        const struct osim_reader_ops *ops;
        uint32_t proto_supported;
        void *priv;
        struct osim_card_hdl *card;
};
 
struct osim_card_app_hdl {
        struct llist_head list;
        uint8_t aid[MAX_AID_LEN];
        uint8_t aid_len;
        char *label;
        const struct osim_card_app_profile *prof;
};
 
struct osim_card_hdl {
        struct llist_head list;
        struct osim_reader_hdl *reader;
        struct osim_card_profile *prof;
        enum osim_proto proto;
 
        struct llist_head channels;
 
        struct llist_head apps;
 
        uint8_t atr[OSIM_MAX_ATR_LEN];
        unsigned int atr_len;
};
 
struct osim_chan_hdl {
        struct llist_head list;
        struct osim_card_hdl *card;
        const struct osim_file_desc *cwd;
        struct osim_card_app_hdl *cur_app;
};
 
int osim_card_hdl_add_app(struct osim_card_hdl *ch, const uint8_t *aid, uint8_t aid_len,
                          const char *label);
 
/* reader.c */
int osim_transceive_apdu(struct osim_chan_hdl *st, struct msgb *amsg);
struct osim_reader_hdl *osim_reader_open(enum osim_reader_driver drv, int idx,
                                         const char *name, void *ctx);
struct osim_card_hdl *osim_card_open(struct osim_reader_hdl *rh, enum osim_proto proto);
int osim_card_reset(struct osim_card_hdl *card, bool cold_reset);
int osim_card_close(struct osim_card_hdl *card);