summaryrefslogtreecommitdiffstats
path: root/src/stkutil.h
blob: b67bbefe9045fedd45717285244003d61bbe3be4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
/*
 *
 *  oFono - Open Source Telephony
 *
 *  Copyright (C) 2008-2010  Intel Corporation. All rights reserved.
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License version 2 as
 *  published by the Free Software Foundation.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 *
 */

/*
 * TS 101.220, Section 7.2, Card Application Toolkit assigned templates,
 * These are the same as 3GPP 11.14 Sections 13.1 and 13.2 
 */
enum stk_envelope_type {
	STK_ENVELOPE_TYPE_SMS_PP_DOWNLOAD = 0xD1,
	STK_ENVELOPE_TYPE_CBS_PP_DOWNLOAD = 0xD2,
	STK_ENVELOPE_TYPE_MENU_SELECTION = 0xD3,
	STK_ENVELOPE_TYPE_CALL_CONTROL = 0xD4,
	STK_ENVELOPE_TYPE_MO_SMS_CONTROL = 0xD5,
	STK_ENVELOPE_TYPE_EVENT_DOWNLOAD = 0xD6,
	STK_ENVELOPE_TYPE_TIMER_EXPIRATION = 0xD7,
	STK_ENVELOPE_TYPE_USSD_DOWNLOAD = 0xD9,
};

/* TS 102.223 Section 9.4 */
enum stk_command_type {
	STK_COMMAND_TYPE_REFRESH = 0x01,
	STK_COMMAND_TYPE_POLL_INTERVAL = 0x02,
	STK_COMMAND_TYPE_POLLING_OFF = 0x03,
	STK_COMMAND_TYPE_SETUP_EVENT_LIST = 0x05,
	STK_COMMAND_TYPE_SETUP_CALL = 0x10,
	STK_COMMAND_TYPE_SEND_SS = 0x11,
	STK_COMMAND_TYPE_SEND_USSD = 0x12,
	STK_COMMAND_TYPE_SEND_SMS = 0x13,
	STK_COMMAND_TYPE_SEND_DTMF = 0x14,
	STK_COMMAND_TYPE_LAUNCH_BROWSER = 0x15,
	STK_COMMAND_TYPE_GEOGRAPICAL_LOCATION_REQUEST = 0x16,
	STK_COMMAND_TYPE_PLAY_TONE = 0x20,
	STK_COMMAND_TYPE_DISPLAY_TEXT = 0x21,
	STK_COMMAND_TYPE_GET_INKEY = 0x22,
	STK_COMMAND_TYPE_GET_INPUT = 0x23,
	STK_COMMAND_TYPE_SELECT_ITEM = 0x24,
	STK_COMMAND_TYPE_SETUP_MENU = 0x25,
	STK_COMMAND_TYPE_PROVIDE_LOCAL_INFORMATION = 0x26,
	STK_COMMAND_TYPE_TIMER_MANAGEMENT = 0x27,
	STK_COMMAND_TYPE_SETUP_IDLE_MODE_TEXT = 0x28,
	STK_COMMAND_TYPE_PERFORM_CARD_APDU = 0x30,
	STK_COMMAND_TYPE_POWER_ON_CARD = 0x31,
	STK_COMMAND_TYPE_POWER_OFF_CARD = 0x32,
	STK_COMMAND_TYPE_GET_READER_STATUS = 0x33,
	STK_COMMAND_TYPE_RUN_AT_COMMAND = 0x34,
	STK_COMMAND_TYPE_LANGUAGE_NOTIFICATION = 0x35,
	STK_COMMAND_TYPE_OPEN_CHANNEL = 0x40,
	STK_COMMAND_TYPE_CLOSE_CHANNEL = 0x41,
	STK_COMMAND_TYPE_RECEIVE_DATA = 0x42,
	STK_COMMAND_TYPE_SEND_DATA = 0x43,
	STK_COMMAND_TYPE_GET_CHANNEL_STATUS = 0x44,
	STK_COMMAND_TYPE_SERVICE_SEARCH = 0x45,
	STK_COMMAND_TYPE_GET_SERVICE_INFORMATION = 0x46,
	STK_COMMAND_TYPE_DECLARE_SERVICE = 0x47,
	STK_COMMAND_TYPE_SET_FRAMES = 0x50,
	STK_COMMAND_TYPE_GET_FRAMES_STATUS = 0x51,
	STK_COMMAND_TYPE_RETRIEVE_MMS = 0x60,
	STK_COMMAND_TYPE_SUBMIT_MMS = 0x61,
	STK_COMMAND_TYPE_DISPLAY_MMS = 0x62,
	STK_COMMAND_TYPE_ACTIVATE = 0x70,
	STK_COMMAND_TYPE_END_SESSION = 0x81,
};

enum stk_data_object_type {
	STK_DATA_OBJECT_TYPE_INVALID = 0x00,
	STK_DATA_OBJECT_TYPE_COMMAND_DETAILS = 0x01,
	STK_DATA_OBJECT_TYPE_DEVICE_IDENTITIES = 0x02,
	STK_DATA_OBJECT_TYPE_RESULT = 0x03,
	STK_DATA_OBJECT_TYPE_DURATION = 0x04,
	STK_DATA_OBJECT_TYPE_ALPHA_ID = 0x05,
	STK_DATA_OBJECT_TYPE_ADDRESS = 0x06,
	STK_DATA_OBJECT_TYPE_CAPABILITY_CONFIGURATION_PARAMETERS = 0x07,
	STK_DATA_OBJECT_TYPE_SUBADDRESS = 0x08,
	STK_DATA_OBJECT_TYPE_SS_STRING = 0x09,
	STK_DATA_OBJECT_TYPE_USSD_STRING = 0x0A,
	STK_DATA_OBJECT_TYPE_SMS_TPDU = 0x0B,
	STK_DATA_OBJECT_TYPE_CBS_PAGE = 0x0C,
	STK_DATA_OBJECT_TYPE_TEXT = 0x0D,
	STK_DATA_OBJECT_TYPE_TONE = 0x0E,
	STK_DATA_OBJECT_TYPE_ITEM = 0x0F,
	STK_DATA_OBJECT_TYPE_ITEM_ID = 0x10,
	STK_DATA_OBJECT_TYPE_RESPONSE_LENGTH = 0x11,
	STK_DATA_OBJECT_TYPE_FILE_LIST = 0x12,
	STK_DATA_OBJECT_TYPE_LOCATION_INFO = 0x13,
	STK_DATA_OBJECT_TYPE_IMEI = 0x14,
	STK_DATA_OBJECT_TYPE_HELP_REQUEST = 0x15,
	STK_DATA_OBJECT_TYPE_NETWORK_MEASUREMENT_RESULTS = 0x16,
	STK_DATA_OBJECT_TYPE_DEFAULT_TEXT = 0x17,
	STK_DATA_OBJECT_TYPE_ITEMS_NEXT_ACTION_INDICATOR = 0x18,
	STK_DATA_OBJECT_TYPE_EVENT_LIST = 0x19,
	STK_DATA_OBJECT_TYPE_CAUSE = 0x1A,
	STK_DATA_OBJECT_TYPE_LOCATION_STATUS = 0x1B,
	STK_DATA_OBJECT_TYPE_TRANSACTION_ID = 0x1C,
	STK_DATA_OBJECT_TYPE_ICON_ID = 0x1E,
	STK_DATA_OBJECT_TYPE_ITEM_ICON_ID_LIST = 0x1F,
	STK_DATA_OBJECT_TYPE_CARD_READER_STATUS = 0x20,
	STK_DATA_OBJECT_TYPE_CARD_ATR = 0x21,
	STK_DATA_OBJECT_TYPE_C_APDU = 0x22,
	STK_DATA_OBJECT_TYPE_R_APDU = 0x23,
	STK_DATA_OBJECT_TYPE_TIMER_ID = 0x24,
	STK_DATA_OBJECT_TYPE_TIMER_VALUE = 0x25,
	STK_DATA_OBJECT_TYPE_DATETIME_TIMEZONE = 0x26,
	STK_DATA_OBJECT_TYPE_CALL_CONTROL_REQUESTED_ACTION = 0x27,
	STK_DATA_OBJECT_TYPE_AT_COMMAND = 0x28,
	STK_DATA_OBJECT_TYPE_AT_RESPONSE = 0x29,
	STK_DATA_OBJECT_TYPE_BC_REPEAT_INDICATOR = 0x2A,
	STK_DATA_OBJECT_TYPE_IMMEDIATE_RESPONSE = 0x2B,
	STK_DATA_OBJECT_TYPE_DTMF_STRING = 0x2C,
	STK_DATA_OBJECT_TYPE_LANGUAGE = 0x2D,
	STK_DATA_OBJECT_TYPE_TIMING_ADVANCE = 0x2E,
	STK_DATA_OBJECT_TYPE_AID = 0x2F,
	STK_DATA_OBJECT_TYPE_BROWSER_ID = 0x30,
	STK_DATA_OBJECT_TYPE_URL = 0x31,
	STK_DATA_OBJECT_TYPE_BEARER = 0x32,
	STK_DATA_OBJECT_TYPE_PROVISIONING_REFERENCE_FILE = 0x33,
	STK_DATA_OBJECT_TYPE_BROWSER_TERMINATION_CAUSE = 0x34,
	STK_DATA_OBJECT_TYPE_BEARER_DESCRIPTION = 0x35,
	STK_DATA_OBJECT_TYPE_CHANNEL_DATA = 0x36,
	STK_DATA_OBJECT_TYPE_CHANNEL_DATA_LENGTH = 0x37,
	STK_DATA_OBJECT_TYPE_CHANNEL_STATUS = 0x38,
	STK_DATA_OBJECT_TYPE_BUFFER_SIZE = 0x39,
	STK_DATA_OBJECT_TYPE_CARD_READER_ID = 0x3A,
	STK_DATA_OBJECT_TYPE_FILE_UPDATE_INFO = 0x3B,
	STK_DATA_OBJECT_TYPE_UICC_TE_INTERFACE = 0x3C,
	STK_DATA_OBJECT_TYPE_OTHER_ADDRESS = 0x3E,
	STK_DATA_OBJECT_TYPE_ACCESS_TECHNOLOGY = 0x3F,
	STK_DATA_OBJECT_TYPE_DISPLAY_PARAMETERS = 0x40,
	STK_DATA_OBJECT_TYPE_SERVICE_RECORD = 0x41,
	STK_DATA_OBJECT_TYPE_DEVICE_FILTER = 0x42,
	STK_DATA_OBJECT_TYPE_SERVICE_SEARCH = 0x43,
	STK_DATA_OBJECT_TYPE_ATTRIBUTE_INFO = 0x44,
	STK_DATA_OBJECT_TYPE_SERVICE_AVAILABILITY = 0x45,
	STK_DATA_OBJECT_TYPE_ESN = 0x46,
	STK_DATA_OBJECT_TYPE_NETWORK_ACCESS_NAME = 0x47,
	STK_DATA_OBJECT_TYPE_REMOTE_ENTITY_ADDRESS = 0x49,
	STK_DATA_OBJECT_TYPE_TEXT_ATTRIBUTE = 0x50,
	STK_DATA_OBJECT_TYPE_ITEM_TEXT_ATTRIBUTE_LIST = 0x51,
	STK_DATA_OBJECT_TYPE_PDP_ACTIVATION_PARAMETER = 0x52,
	STK_DATA_OBJECT_TYPE_IMEISV = 0x62,
	STK_DATA_OBJECT_TYPE_BATTERY_STATE = 0x63,
	STK_DATA_OBJECT_TYPE_BROWSING_STATUS = 0x64,
	STK_DATA_OBJECT_TYPE_NETWORK_SEARCH_MODE = 0x65,
	STK_DATA_OBJECT_TYPE_FRAME_LAYOUT = 0x66,
	STK_DATA_OBJECT_TYPE_FRAMES_INFO = 0x67,
	STK_DATA_OBJECT_TYPE_FRAME_ID = 0x68,
	STK_DATA_OBJECT_TYPE_MMS_REFERENCE = 0x6A,
	STK_DATA_OBJECT_TYPE_MMS_ID = 0x6B,
	STK_DATA_OBJECT_TYPE_MMS_TRANSFER_STATUS = 0x6C,
	STK_DATA_OBJECT_TYPE_MEID = 0x6D,
	STK_DATA_OBJECT_TYPE_CONTENT_ID = 0x6E,
	STK_DATA_OBJECT_TYPE_MMS_NOTIFICATION = 0x6F,
	STK_DATA_OBJECT_TYPE_LAST_ENVELOPE = 0x70,
	STK_DATA_OBJECT_TYPE_REGISTRY_APPLICATION_DATA = 0x71,
	STK_DATA_OBJECT_TYPE_ROUTING_AREA_INFO = 0x73,
	STK_DATA_OBJECT_TYPE_UPDATE_ATTACH_TYPE = 0x74,
	STK_DATA_OBJECT_TYPE_NMEA_SENTENCE = 0x78,
	STK_DATA_OBJECT_TYPE_PLMN_LIST = 0x79,
	STK_DATA_OBJECT_TYPE_BROADCAST_NETWORK_INFO = 0x7A,
	STK_DATA_OBJECT_TYPE_ACTIVATE_DESCRIPTOR = 0x7B,
};

enum stk_device_identity_type {
	STK_DEVICE_IDENTITY_TYPE_KEYPAD = 0x01,
	STK_DEVICE_IDENTITY_TYPE_DISPLAY = 0x02,
	STK_DEVICE_IDENTITY_TYPE_EARPIECE = 0x03,
	STK_DEVICE_IDENTITY_TYPE_UICC = 0x81,
	STK_DEVICE_IDENTITY_TYPE_TERMINAL = 0x82,
	STK_DEVICE_IDENTITY_TYPE_NETWORK = 0x83,
};

enum stk_duration_type {
	STK_DURATION_TYPE_MINUTES = 0x00,
	STK_DURATION_TYPE_SECONDS = 0x01,
	STK_DURATION_TYPE_SECOND_TENTHS = 0x02,
};

/* Defined in TS 102.223 Section 8.1 */
struct stk_address {
	unsigned char ton_npi;
	char *number;
};

/* Defined in TS 102.223 Section 8.3 */
struct stk_subaddress {
	unsigned int subaddr_len;
	unsigned char *subaddr;
};

/* Defined in TS 102.223 Section 8.4 */
struct stk_capability_configuration_parameters {
	unsigned int ccp_len;
	unsigned char *ccp;
};

/*
 * Icon ID denotes a file on the SIM filesystem.  Since EF cannot have record
 * ids of 0, we use icon_id with 0 to denote empty icon_identifier objects
 */
struct stk_icon_identifier {
	unsigned char qualifier;
	unsigned char id;
};

/*
 * According to 102.223 Section 8.8 interval values of 0x00 are reserved.
 * We use this to denote empty duration objects.
 */
struct stk_duration {
	enum stk_duration_type unit;
	unsigned char interval;
};

/* Defined in TS 102.223 Section 8.9 */
struct stk_item {
	unsigned char id;
	char *text;
};

/* Defined in TS 102.223 Section 8.12 */
struct stk_result {
	unsigned char general;
	unsigned int additional_len;
	unsigned char *additional;
};

/* Defined in TS 102.223 Section 8.13 */
struct stk_sms_tpdu {
	unsigned int tpdu_len;
	unsigned char *tpdu;
};

/*
 * According to 102.223 Section 8.72 the length of text attribute CTLV is 1
 * byte.  This means that the maximum size is 127 according to the rules
 * of CTLVs.  Empty attribute options will have len of 0.
 */
struct stk_text_attribute {
	unsigned char attributes[127];
	unsigned char len;
};

/*
 * According to 102.223 Section 8.11, the maximum length should never be set
 * to 0.
 */
struct stk_response_length {
	unsigned char min;
	unsigned char max;
};

struct stk_command_display_text {
	char *text;
	struct stk_icon_identifier icon_id;
	ofono_bool_t immediate_response;
	struct stk_duration duration;
	struct stk_text_attribute text_attribute;
	unsigned char frame_id; /* Values 0x10 to 0xFF reserved */
};

struct stk_command_get_input {
	char *text;
	struct stk_response_length response_length;
	char *default_text;
	struct stk_icon_identifier icon_id;
	struct stk_text_attribute text_attribute;
	unsigned char frame_id; /* Values 0x10 to 0xFF reserved */
};

struct stk_command {
	unsigned char number;
	unsigned char type;
	unsigned char qualifier;
	enum stk_device_identity_type src;
	enum stk_device_identity_type dst;

	union {
		struct stk_command_display_text display_text;
		struct stk_command_display_text get_inkey;
		struct stk_command_get_input get_input;
	};

	void (*destructor)(struct stk_command *command);
};

struct stk_command *stk_command_new_from_pdu(const unsigned char *pdu,
						unsigned int len);
void stk_command_free(struct stk_command *command);