1
|
/* Copyright 2020 sysmocom s.f.m.c. GmbH
|
2
|
* SPDX-License-Identifier: Apache-2.0 */
|
3
|
package org.osmocom.IMSIPseudo;
|
4
|
|
5
|
import sim.access.*;
|
6
|
import sim.toolkit.*;
|
7
|
import javacard.framework.*;
|
8
|
|
9
|
public class IMSIPseudo extends Applet implements ToolkitInterface, ToolkitConstants {
|
10
|
// DON'T DECLARE USELESS INSTANCE VARIABLES! They get saved to the EEPROM,
|
11
|
// which has a limited number of write cycles.
|
12
|
|
13
|
private byte STKServicesMenuId;
|
14
|
private SIMView gsmFile;
|
15
|
static byte[] LUCounter = new byte[] { '0', 'x', ' ', 'L', 'U' };
|
16
|
|
17
|
/* Main menu */
|
18
|
static byte[] title = new byte[] { 'I', 'M', 'S', 'I', ' ', 'P', 's', 'e', 'u', 'd', 'o', 'n', 'y', 'm',
|
19
|
'i', 'z', 'a', 't', 'i', 'o', 'n'};
|
20
|
static byte[] showLU = new byte[] {'S', 'h', 'o', 'w', ' ', 'L', 'U', ' ', 'c', 'o', 'u', 'n', 't', 'e', 'r'};
|
21
|
static byte[] showIMSI = new byte[] {'S', 'h', 'o', 'w', ' ', 'I', 'M', 'S', 'I'};
|
22
|
static byte[] changeIMSI = new byte[] {'C', 'h', 'a', 'n', 'g', 'e', ' ', 'I', 'M', 'S', 'I', ' '};
|
23
|
private Object[] itemListMain = {title, showLU, showIMSI, changeIMSI};
|
24
|
|
25
|
/* Change IMSI menu */
|
26
|
static byte[] setDigit1 = new byte[] {'S', 'e', 't', ' ', '1', ' ', 'a', 's', ' ', 'l', 'a', 's', 't', ' ',
|
27
|
'd', 'i', 'g', 'i', 't'};
|
28
|
static byte[] setDigit2 = new byte[] {'S', 'e', 't', ' ', '2', ' ', 'a', 's', ' ', 'l', 'a', 's', 't', ' ',
|
29
|
'd', 'i', 'g', 'i', 't'};
|
30
|
private Object[] itemListChangeIMSI = {changeIMSI, setDigit1, setDigit2};
|
31
|
|
32
|
private IMSIPseudo() {
|
33
|
gsmFile = SIMSystem.getTheSIMView();
|
34
|
|
35
|
/* Register menu and trigger on location updates */
|
36
|
ToolkitRegistry reg = ToolkitRegistry.getEntry();
|
37
|
STKServicesMenuId = reg.initMenuEntry(title, (short)0, (short)title.length, PRO_CMD_SELECT_ITEM, false,
|
38
|
(byte)0, (short)0);
|
39
|
reg.setEvent(EVENT_EVENT_DOWNLOAD_LOCATION_STATUS);
|
40
|
}
|
41
|
|
42
|
public static void install(byte[] bArray, short bOffset, byte bLength) {
|
43
|
IMSIPseudo applet = new IMSIPseudo();
|
44
|
applet.register();
|
45
|
}
|
46
|
|
47
|
public void process(APDU arg0) throws ISOException {
|
48
|
if (selectingApplet())
|
49
|
return;
|
50
|
}
|
51
|
|
52
|
public void processToolkit(byte event) throws ToolkitException {
|
53
|
EnvelopeHandler envHdlr = EnvelopeHandler.getTheHandler();
|
54
|
|
55
|
if (event == EVENT_MENU_SELECTION) {
|
56
|
byte selectedItemId = envHdlr.getItemIdentifier();
|
57
|
|
58
|
if (selectedItemId == STKServicesMenuId) {
|
59
|
showMenu(itemListMain, (byte)4);
|
60
|
handleMenuResponseMain();
|
61
|
}
|
62
|
}
|
63
|
|
64
|
if (event == EVENT_EVENT_DOWNLOAD_LOCATION_STATUS) {
|
65
|
LUCounter[0]++;
|
66
|
showMsg(LUCounter);
|
67
|
}
|
68
|
}
|
69
|
|
70
|
private void showMenu(Object[] itemList, byte itemCount) {
|
71
|
ProactiveHandler proHdlr = ProactiveHandler.getTheHandler();
|
72
|
proHdlr.init((byte) PRO_CMD_SELECT_ITEM,(byte)0,DEV_ID_ME);
|
73
|
|
74
|
for (byte i=(byte)0;i<itemCount;i++) {
|
75
|
if (i == 0) {
|
76
|
/* Title */
|
77
|
proHdlr.appendTLV((byte)(TAG_ALPHA_IDENTIFIER | TAG_SET_CR), (byte[])itemList[i],
|
78
|
(short)0, (short)((byte[])itemList[i]).length);
|
79
|
|
80
|
} else {
|
81
|
/* Menu entry */
|
82
|
proHdlr.appendTLV((byte)(TAG_ITEM | TAG_SET_CR), (byte)i, (byte[])itemList[i], (short)0,
|
83
|
(short)((byte[])itemList[i]).length);
|
84
|
}
|
85
|
}
|
86
|
proHdlr.send();
|
87
|
}
|
88
|
|
89
|
private void showMsg(byte[] msg) {
|
90
|
ProactiveHandler proHdlr = ProactiveHandler.getTheHandler();
|
91
|
proHdlr.initDisplayText((byte)0, DCS_8_BIT_DATA, msg, (short)0, (short)(msg.length));
|
92
|
proHdlr.send();
|
93
|
}
|
94
|
|
95
|
private void showError(short code) {
|
96
|
byte[] msg = new byte[] {'E', '?', '?'};
|
97
|
msg[1] = (byte)('0' + code / 10);
|
98
|
msg[2] = (byte)('0' + code % 10);
|
99
|
showMsg(msg);
|
100
|
}
|
101
|
|
102
|
/* Convert BCD-encoded digit into printable character
|
103
|
* \param[in] bcd A single BCD-encoded digit
|
104
|
* \returns single printable character
|
105
|
*/
|
106
|
private byte bcd2char(byte bcd)
|
107
|
{
|
108
|
if (bcd < 0xa)
|
109
|
return (byte)('0' + bcd);
|
110
|
else
|
111
|
return (byte)('A' + (bcd - 0xa));
|
112
|
}
|
113
|
|
114
|
/* Convert BCD to string.
|
115
|
* The given nibble offsets are interpreted in BCD order, i.e. nibble 0 is bcd[0] & 0xf, nibble 1 is bcd[0] >> 4, nibble
|
116
|
* 3 is bcd[1] & 0xf, etc..
|
117
|
* \param[out] dst Output byte array.
|
118
|
* \param[in] dst_ofs Where to start writing in dst.
|
119
|
* \param[in] dst_len How many bytes are available at dst_ofs.
|
120
|
* \param[in] bcd Binary coded data buffer.
|
121
|
* \param[in] start_nibble Offset to start from, in nibbles.
|
122
|
* \param[in] end_nibble Offset to stop before, in nibbles.
|
123
|
* \param[in] allow_hex If false, return false if there are digits other than 0-9.
|
124
|
* \returns true on success, false otherwise
|
125
|
*/
|
126
|
private boolean bcd2str(byte dst[], byte dst_ofs, byte dst_len,
|
127
|
byte bcd[], byte start_nibble, byte end_nibble, boolean allow_hex)
|
128
|
{
|
129
|
byte nibble_i;
|
130
|
byte dst_i = dst_ofs;
|
131
|
byte dst_end = (byte)(dst_ofs + dst_len);
|
132
|
boolean rc = true;
|
133
|
|
134
|
for (nibble_i = start_nibble; nibble_i < end_nibble && dst_i < dst_end; nibble_i++, dst_i++) {
|
135
|
byte nibble = bcd[(byte)nibble_i >> 1];
|
136
|
if ((nibble_i & 1) != 0)
|
137
|
nibble >>= 4;
|
138
|
nibble &= 0xf;
|
139
|
|
140
|
if (!allow_hex && nibble > 9)
|
141
|
rc = false;
|
142
|
|
143
|
dst[dst_i] = bcd2char(nibble);
|
144
|
}
|
145
|
|
146
|
return rc;
|
147
|
}
|
148
|
|
149
|
private boolean mi2str(byte dst[], byte dst_ofs, byte dst_len,
|
150
|
byte mi[], boolean allow_hex)
|
151
|
{
|
152
|
/* The IMSI byte array by example:
|
153
|
* 08 99 10 07 00 00 10 74 90
|
154
|
*
|
155
|
* This is encoded according to 3GPP TS 24.008 10.5.1.4 Mobile
|
156
|
* Identity, short the Mobile Identity IEI:
|
157
|
*
|
158
|
* 08 length for the following MI, in bytes.
|
159
|
* 9 = 0b1001
|
160
|
* 1 = odd nr of digits
|
161
|
* 001 = MI type = IMSI
|
162
|
* 9 first IMSI digit (BCD)
|
163
|
* 0 second digit
|
164
|
* 1 third
|
165
|
* ...
|
166
|
* 0 14th digit
|
167
|
* 9 15th and last digit
|
168
|
*
|
169
|
* If the IMSI had an even number of digits:
|
170
|
*
|
171
|
* 08 98 10 07 00 00 10 74 f0
|
172
|
*
|
173
|
* 08 length for the following MI, in bytes.
|
174
|
* 8 = 0b0001
|
175
|
* 0 = even nr of digits
|
176
|
* 001 = MI type = IMSI
|
177
|
* 9 first IMSI digit
|
178
|
* 0 second digit
|
179
|
* 1 third
|
180
|
* ...
|
181
|
* 0 14th and last digit
|
182
|
* f filler
|
183
|
*/
|
184
|
byte bytelen = mi[0];
|
185
|
byte mi_type = (byte)(mi[1] & 0xf);
|
186
|
boolean odd_nr_of_digits = ((mi_type & 0x08) != 0);
|
187
|
byte start_nibble = 2 + 1; // 2 to skip the bytelen, 1 to skip the mi_type
|
188
|
byte end_nibble = (byte)(2 + bytelen * 2 - (odd_nr_of_digits ? 0 : 1));
|
189
|
return bcd2str(dst, dst_ofs, dst_len, mi, start_nibble, end_nibble, allow_hex);
|
190
|
}
|
191
|
|
192
|
private void showIMSI() {
|
193
|
/* 3GPP TS 31.102 4.2.2: IMSI */
|
194
|
byte[] IMSI = new byte[9];
|
195
|
byte[] msg = {'C', 'u', 'r', 'r', 'e', 'n', 't', ' ', 'I', 'M', 'S', 'I', ':', ' ',
|
196
|
' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' '};
|
197
|
|
198
|
gsmFile.select((short) SIMView.FID_DF_GSM);
|
199
|
gsmFile.select((short) SIMView.FID_EF_IMSI);
|
200
|
|
201
|
try {
|
202
|
gsmFile.readBinary((short)0, IMSI, (short)0, (short)9);
|
203
|
} catch (SIMViewException e) {
|
204
|
showError(e.getReason());
|
205
|
return;
|
206
|
}
|
207
|
|
208
|
mi2str(msg, (byte)14, (byte)16, IMSI, false);
|
209
|
showMsg(msg);
|
210
|
}
|
211
|
|
212
|
private void handleMenuResponseMain() {
|
213
|
ProactiveResponseHandler rspHdlr = ProactiveResponseHandler.getTheHandler();
|
214
|
|
215
|
switch (rspHdlr.getItemIdentifier()) {
|
216
|
case 1: /* Show LU counter */
|
217
|
showMsg(LUCounter);
|
218
|
break;
|
219
|
case 2: /* Show IMSI */
|
220
|
showIMSI();
|
221
|
break;
|
222
|
case 3: /* Change IMSI */
|
223
|
showMenu(itemListChangeIMSI, (byte)3);
|
224
|
handleMenuResponseChangeIMSI();
|
225
|
break;
|
226
|
}
|
227
|
}
|
228
|
|
229
|
private void handleMenuResponseChangeIMSI() {
|
230
|
/* TODO */
|
231
|
}
|
232
|
}
|