Oliver Smith | 05b1332 | 2020-02-24 14:18:20 +0100 | [diff] [blame] | 1 | /* Copyright 2020 sysmocom s.f.m.c. GmbH |
| 2 | * SPDX-License-Identifier: Apache-2.0 */ |
Oliver Smith | 4e5e516 | 2020-02-21 08:47:36 +0100 | [diff] [blame] | 3 | package org.osmocom.IMSIPseudo; |
Neels Hofmeyr | d20f93a | 2020-02-24 22:42:22 +0100 | [diff] [blame] | 4 | import org.osmocom.IMSIPseudo.MobileIdentity; |
Oliver Smith | 4e5e516 | 2020-02-21 08:47:36 +0100 | [diff] [blame] | 5 | |
Oliver Smith | 4eee13d | 2020-02-24 11:28:39 +0100 | [diff] [blame] | 6 | import sim.access.*; |
| 7 | import sim.toolkit.*; |
| 8 | import javacard.framework.*; |
Oliver Smith | 4e5e516 | 2020-02-21 08:47:36 +0100 | [diff] [blame] | 9 | |
| 10 | public class IMSIPseudo extends Applet implements ToolkitInterface, ToolkitConstants { |
| 11 | // DON'T DECLARE USELESS INSTANCE VARIABLES! They get saved to the EEPROM, |
| 12 | // which has a limited number of write cycles. |
Oliver Smith | 4e5e516 | 2020-02-21 08:47:36 +0100 | [diff] [blame] | 13 | |
Oliver Smith | ca866fe | 2020-02-24 09:56:30 +0100 | [diff] [blame] | 14 | private byte STKServicesMenuId; |
Oliver Smith | 2259cb9 | 2020-02-24 11:36:31 +0100 | [diff] [blame] | 15 | private SIMView gsmFile; |
Neels Hofmeyr | cf04db0 | 2020-02-25 03:23:03 +0100 | [diff] [blame] | 16 | static byte[] LUCounter = { '0', 'x', ' ', 'L', 'U' }; |
Oliver Smith | ca866fe | 2020-02-24 09:56:30 +0100 | [diff] [blame] | 17 | |
| 18 | /* Main menu */ |
Neels Hofmeyr | cf04db0 | 2020-02-25 03:23:03 +0100 | [diff] [blame] | 19 | private static final byte[] title = { 'I', 'M', 'S', 'I', ' ', 'P', 's', 'e', 'u', 'd', 'o', 'n', 'y', 'm', |
Oliver Smith | 2dcbfab | 2020-02-21 15:40:21 +0100 | [diff] [blame] | 20 | 'i', 'z', 'a', 't', 'i', 'o', 'n'}; |
Neels Hofmeyr | cf04db0 | 2020-02-25 03:23:03 +0100 | [diff] [blame] | 21 | private static final byte[] showLU = {'S', 'h', 'o', 'w', ' ', 'L', 'U', ' ', 'c', 'o', 'u', 'n', 't', 'e', 'r'}; |
| 22 | private static final byte[] showIMSI = {'S', 'h', 'o', 'w', ' ', 'I', 'M', 'S', 'I'}; |
| 23 | private static final byte[] changeIMSI = {'C', 'h', 'a', 'n', 'g', 'e', ' ', 'I', 'M', 'S', 'I', ' '}; |
Neels Hofmeyr | 7d7e33f | 2020-02-24 21:24:02 +0100 | [diff] [blame] | 24 | private final Object[] itemListMain = {title, showLU, showIMSI, changeIMSI}; |
Oliver Smith | ca866fe | 2020-02-24 09:56:30 +0100 | [diff] [blame] | 25 | |
| 26 | /* Change IMSI menu */ |
Neels Hofmeyr | cf04db0 | 2020-02-25 03:23:03 +0100 | [diff] [blame] | 27 | private static final byte[] enterIMSI = {'E', 'n', 't', 'e', 'r', ' ', 'I', 'M', 'S', 'I' }; |
| 28 | private static final byte[] setDigit1 = {'S', 'e', 't', ' ', '1', ' ', 'a', 's', ' ', 'l', 'a', 's', 't', ' ', |
Oliver Smith | ca866fe | 2020-02-24 09:56:30 +0100 | [diff] [blame] | 29 | 'd', 'i', 'g', 'i', 't'}; |
Neels Hofmeyr | cf04db0 | 2020-02-25 03:23:03 +0100 | [diff] [blame] | 30 | private static final byte[] setDigit2 = {'S', 'e', 't', ' ', '2', ' ', 'a', 's', ' ', 'l', 'a', 's', 't', ' ', |
Oliver Smith | ca866fe | 2020-02-24 09:56:30 +0100 | [diff] [blame] | 31 | 'd', 'i', 'g', 'i', 't'}; |
Neels Hofmeyr | 0866f3a | 2020-02-24 21:30:42 +0100 | [diff] [blame] | 32 | private final Object[] itemListChangeIMSI = {changeIMSI, enterIMSI, setDigit1, setDigit2}; |
Oliver Smith | 4e5e516 | 2020-02-21 08:47:36 +0100 | [diff] [blame] | 33 | |
| 34 | private IMSIPseudo() { |
Oliver Smith | 2259cb9 | 2020-02-24 11:36:31 +0100 | [diff] [blame] | 35 | gsmFile = SIMSystem.getTheSIMView(); |
| 36 | |
Oliver Smith | ca866fe | 2020-02-24 09:56:30 +0100 | [diff] [blame] | 37 | /* Register menu and trigger on location updates */ |
Oliver Smith | 4e5e516 | 2020-02-21 08:47:36 +0100 | [diff] [blame] | 38 | ToolkitRegistry reg = ToolkitRegistry.getEntry(); |
Oliver Smith | ca866fe | 2020-02-24 09:56:30 +0100 | [diff] [blame] | 39 | STKServicesMenuId = reg.initMenuEntry(title, (short)0, (short)title.length, PRO_CMD_SELECT_ITEM, false, |
| 40 | (byte)0, (short)0); |
Oliver Smith | e28705a | 2020-02-21 10:06:14 +0100 | [diff] [blame] | 41 | reg.setEvent(EVENT_EVENT_DOWNLOAD_LOCATION_STATUS); |
Oliver Smith | 4e5e516 | 2020-02-21 08:47:36 +0100 | [diff] [blame] | 42 | } |
| 43 | |
Oliver Smith | 4e5e516 | 2020-02-21 08:47:36 +0100 | [diff] [blame] | 44 | public static void install(byte[] bArray, short bOffset, byte bLength) { |
| 45 | IMSIPseudo applet = new IMSIPseudo(); |
| 46 | applet.register(); |
| 47 | } |
| 48 | |
Oliver Smith | 4e5e516 | 2020-02-21 08:47:36 +0100 | [diff] [blame] | 49 | public void process(APDU arg0) throws ISOException { |
Oliver Smith | 4e5e516 | 2020-02-21 08:47:36 +0100 | [diff] [blame] | 50 | if (selectingApplet()) |
| 51 | return; |
| 52 | } |
| 53 | |
Oliver Smith | 4e5e516 | 2020-02-21 08:47:36 +0100 | [diff] [blame] | 54 | public void processToolkit(byte event) throws ToolkitException { |
| 55 | EnvelopeHandler envHdlr = EnvelopeHandler.getTheHandler(); |
| 56 | |
| 57 | if (event == EVENT_MENU_SELECTION) { |
| 58 | byte selectedItemId = envHdlr.getItemIdentifier(); |
| 59 | |
Oliver Smith | ca866fe | 2020-02-24 09:56:30 +0100 | [diff] [blame] | 60 | if (selectedItemId == STKServicesMenuId) { |
Neels Hofmeyr | 583bfec | 2020-02-25 03:10:38 +0100 | [diff] [blame] | 61 | showMenu(itemListMain); |
Oliver Smith | ca866fe | 2020-02-24 09:56:30 +0100 | [diff] [blame] | 62 | handleMenuResponseMain(); |
Oliver Smith | 4e5e516 | 2020-02-21 08:47:36 +0100 | [diff] [blame] | 63 | } |
| 64 | } |
Oliver Smith | e28705a | 2020-02-21 10:06:14 +0100 | [diff] [blame] | 65 | |
| 66 | if (event == EVENT_EVENT_DOWNLOAD_LOCATION_STATUS) { |
Oliver Smith | 1e5cc46 | 2020-02-21 15:39:14 +0100 | [diff] [blame] | 67 | LUCounter[0]++; |
Oliver Smith | 234ab54 | 2020-02-24 08:25:43 +0100 | [diff] [blame] | 68 | showMsg(LUCounter); |
Oliver Smith | e28705a | 2020-02-21 10:06:14 +0100 | [diff] [blame] | 69 | } |
Oliver Smith | 4e5e516 | 2020-02-21 08:47:36 +0100 | [diff] [blame] | 70 | } |
| 71 | |
Neels Hofmeyr | 583bfec | 2020-02-25 03:10:38 +0100 | [diff] [blame] | 72 | private void showMenu(Object[] itemList) { |
Oliver Smith | ca866fe | 2020-02-24 09:56:30 +0100 | [diff] [blame] | 73 | ProactiveHandler proHdlr = ProactiveHandler.getTheHandler(); |
| 74 | proHdlr.init((byte) PRO_CMD_SELECT_ITEM,(byte)0,DEV_ID_ME); |
| 75 | |
Neels Hofmeyr | 583bfec | 2020-02-25 03:10:38 +0100 | [diff] [blame] | 76 | for (byte i=(byte)0; i < itemList.length; i++) { |
Oliver Smith | ca866fe | 2020-02-24 09:56:30 +0100 | [diff] [blame] | 77 | if (i == 0) { |
| 78 | /* Title */ |
| 79 | proHdlr.appendTLV((byte)(TAG_ALPHA_IDENTIFIER | TAG_SET_CR), (byte[])itemList[i], |
| 80 | (short)0, (short)((byte[])itemList[i]).length); |
| 81 | |
| 82 | } else { |
| 83 | /* Menu entry */ |
| 84 | proHdlr.appendTLV((byte)(TAG_ITEM | TAG_SET_CR), (byte)i, (byte[])itemList[i], (short)0, |
| 85 | (short)((byte[])itemList[i]).length); |
| 86 | } |
| 87 | } |
| 88 | proHdlr.send(); |
| 89 | } |
| 90 | |
Oliver Smith | cef081c | 2020-02-24 10:02:14 +0100 | [diff] [blame] | 91 | private void showMsg(byte[] msg) { |
| 92 | ProactiveHandler proHdlr = ProactiveHandler.getTheHandler(); |
| 93 | proHdlr.initDisplayText((byte)0, DCS_8_BIT_DATA, msg, (short)0, (short)(msg.length)); |
| 94 | proHdlr.send(); |
Oliver Smith | cef081c | 2020-02-24 10:02:14 +0100 | [diff] [blame] | 95 | } |
| 96 | |
Neels Hofmeyr | ba7a6f2 | 2020-02-24 21:26:37 +0100 | [diff] [blame] | 97 | private byte[] getResponse() |
| 98 | { |
| 99 | ProactiveResponseHandler rspHdlr = ProactiveResponseHandler.getTheHandler(); |
| 100 | byte[] resp = new byte[rspHdlr.getTextStringLength()]; |
| 101 | rspHdlr.copyTextString(resp, (short)0); |
| 102 | return resp; |
| 103 | } |
| 104 | |
Neels Hofmeyr | 9a3428e | 2020-02-25 03:21:12 +0100 | [diff] [blame] | 105 | /* |
| 106 | This was used to find out that the first byte of a text field seems to be 4. |
| 107 | private byte[] getResponseDBG() |
| 108 | { |
| 109 | ProactiveResponseHandler rspHdlr; |
| 110 | byte resp[]; |
| 111 | byte strlen = -1; |
| 112 | rspHdlr = ProactiveResponseHandler.getTheHandler(); |
| 113 | |
| 114 | for (byte occurence = 1; occurence <= 3; occurence++) { |
| 115 | short len; |
| 116 | try { |
| 117 | if (rspHdlr.findTLV(TAG_TEXT_STRING, (byte)occurence) != TLV_NOT_FOUND) { |
| 118 | if ((len = rspHdlr.getValueLength()) > 1) { |
| 119 | len = 3; |
| 120 | resp = new byte[len]; |
| 121 | rspHdlr.copyValue((short)0, resp, (short)0, (short)(len)); |
| 122 | showMsg(resp); |
| 123 | showMsgAndWaitKey(Bytes.hexdump(resp)); |
| 124 | return resp; |
| 125 | } |
| 126 | } |
| 127 | } catch (Exception e) { |
| 128 | showError((short)(30 + occurence)); |
| 129 | return null; |
| 130 | } |
| 131 | } |
| 132 | showError((short)(39)); |
| 133 | return null; |
| 134 | } |
| 135 | */ |
| 136 | |
Neels Hofmeyr | ba7a6f2 | 2020-02-24 21:26:37 +0100 | [diff] [blame] | 137 | private byte[] showMsgAndWaitKey(byte[] msg) { |
Neels Hofmeyr | cfb476d | 2020-02-24 19:00:03 +0100 | [diff] [blame] | 138 | ProactiveHandler proHdlr = ProactiveHandler.getTheHandler(); |
| 139 | proHdlr.initGetInkey((byte)0, DCS_8_BIT_DATA, msg, (short)0, (short)(msg.length)); |
| 140 | proHdlr.send(); |
Neels Hofmeyr | ba7a6f2 | 2020-02-24 21:26:37 +0100 | [diff] [blame] | 141 | |
| 142 | return getResponse(); |
| 143 | } |
| 144 | |
Neels Hofmeyr | 9a3428e | 2020-02-25 03:21:12 +0100 | [diff] [blame] | 145 | private byte[] prompt(byte[] msg, byte[] prefillVal, short minLen, short maxLen) { |
Neels Hofmeyr | ba7a6f2 | 2020-02-24 21:26:37 +0100 | [diff] [blame] | 146 | /* if maxLen < 1, the applet crashes */ |
| 147 | if (maxLen < 1) |
| 148 | maxLen = 1; |
| 149 | |
| 150 | ProactiveHandler proHdlr = ProactiveHandler.getTheHandler(); |
| 151 | proHdlr.initGetInput((byte)0, DCS_8_BIT_DATA, msg, (short)0, (short)(msg.length), minLen, maxLen); |
Neels Hofmeyr | 9a3428e | 2020-02-25 03:21:12 +0100 | [diff] [blame] | 152 | if (prefillVal != null && prefillVal.length > 0) { |
| 153 | /* appendTLV() expects the first byte to be some header before the actual text. |
| 154 | * At first I thought it was the value's length, but turned out to only work for lengths under 8... |
| 155 | * In the end I reversed the value 4 from the first byte read by rspHdlr.copyValue() for |
| 156 | * TAG_TEXT_STRING fields. As long as we write 4 into the first byte, things just work out, |
| 157 | * apparently. |
| 158 | * Fucking well could have said so in the API docs, too; oh the brain damage, oh the hours wasted. |
| 159 | * This is the appendTLV() variant that writes one byte ahead of writing an array: */ |
| 160 | proHdlr.appendTLV((byte)(TAG_DEFAULT_TEXT), (byte)4, prefillVal, (short)0, |
| 161 | (short)(prefillVal.length)); |
| 162 | } |
Neels Hofmeyr | ba7a6f2 | 2020-02-24 21:26:37 +0100 | [diff] [blame] | 163 | proHdlr.send(); |
| 164 | |
| 165 | return getResponse(); |
Neels Hofmeyr | cfb476d | 2020-02-24 19:00:03 +0100 | [diff] [blame] | 166 | } |
| 167 | |
Oliver Smith | d7f1892 | 2020-02-24 12:24:38 +0100 | [diff] [blame] | 168 | private void showError(short code) { |
Neels Hofmeyr | cf04db0 | 2020-02-25 03:23:03 +0100 | [diff] [blame] | 169 | byte[] msg = {'E', '?', '?'}; |
Oliver Smith | d7f1892 | 2020-02-24 12:24:38 +0100 | [diff] [blame] | 170 | msg[1] = (byte)('0' + code / 10); |
| 171 | msg[2] = (byte)('0' + code % 10); |
| 172 | showMsg(msg); |
| 173 | } |
| 174 | |
Neels Hofmeyr | c0c9562 | 2020-02-24 21:29:23 +0100 | [diff] [blame] | 175 | |
Oliver Smith | 2259cb9 | 2020-02-24 11:36:31 +0100 | [diff] [blame] | 176 | private void showIMSI() { |
| 177 | /* 3GPP TS 31.102 4.2.2: IMSI */ |
Oliver Smith | 2259cb9 | 2020-02-24 11:36:31 +0100 | [diff] [blame] | 178 | byte[] msg = {'C', 'u', 'r', 'r', 'e', 'n', 't', ' ', 'I', 'M', 'S', 'I', ':', ' ', |
Neels Hofmeyr | b7a20e3 | 2020-02-24 18:58:56 +0100 | [diff] [blame] | 179 | ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' ', ' '}; |
Oliver Smith | 2259cb9 | 2020-02-24 11:36:31 +0100 | [diff] [blame] | 180 | |
Oliver Smith | d7f1892 | 2020-02-24 12:24:38 +0100 | [diff] [blame] | 181 | try { |
Neels Hofmeyr | c24fdd1 | 2020-02-24 21:31:01 +0100 | [diff] [blame] | 182 | byte IMSI[] = readIMSI(); |
Neels Hofmeyr | d20f93a | 2020-02-24 22:42:22 +0100 | [diff] [blame] | 183 | MobileIdentity.mi2str(msg, (byte)14, (byte)16, IMSI, false); |
Neels Hofmeyr | c24fdd1 | 2020-02-24 21:31:01 +0100 | [diff] [blame] | 184 | showMsgAndWaitKey(msg); |
Oliver Smith | d7f1892 | 2020-02-24 12:24:38 +0100 | [diff] [blame] | 185 | } catch (SIMViewException e) { |
| 186 | showError(e.getReason()); |
| 187 | } |
Oliver Smith | 2259cb9 | 2020-02-24 11:36:31 +0100 | [diff] [blame] | 188 | } |
| 189 | |
Oliver Smith | ca866fe | 2020-02-24 09:56:30 +0100 | [diff] [blame] | 190 | private void handleMenuResponseMain() { |
| 191 | ProactiveResponseHandler rspHdlr = ProactiveResponseHandler.getTheHandler(); |
| 192 | |
| 193 | switch (rspHdlr.getItemIdentifier()) { |
Neels Hofmeyr | c8e9641 | 2020-02-24 21:29:46 +0100 | [diff] [blame] | 194 | case 1: /* Show LU counter */ |
| 195 | showMsg(LUCounter); |
| 196 | break; |
| 197 | case 2: /* Show IMSI */ |
| 198 | showIMSI(); |
| 199 | break; |
| 200 | case 3: /* Change IMSI */ |
Neels Hofmeyr | 583bfec | 2020-02-25 03:10:38 +0100 | [diff] [blame] | 201 | showMenu(itemListChangeIMSI); |
Neels Hofmeyr | c8e9641 | 2020-02-24 21:29:46 +0100 | [diff] [blame] | 202 | handleMenuResponseChangeIMSI(); |
| 203 | break; |
Oliver Smith | ca866fe | 2020-02-24 09:56:30 +0100 | [diff] [blame] | 204 | } |
| 205 | } |
| 206 | |
| 207 | private void handleMenuResponseChangeIMSI() { |
Neels Hofmeyr | 0866f3a | 2020-02-24 21:30:42 +0100 | [diff] [blame] | 208 | ProactiveResponseHandler rspHdlr = ProactiveResponseHandler.getTheHandler(); |
| 209 | switch (rspHdlr.getItemIdentifier()) { |
| 210 | case 1: /* enter IMSI */ |
| 211 | promptIMSI(); |
| 212 | break; |
| 213 | case 2: /* set last digit to 1 */ |
| 214 | promptIMSI(); |
| 215 | break; |
| 216 | case 3: /* set last digit to 2 */ |
| 217 | promptIMSI(); |
| 218 | break; |
| 219 | } |
| 220 | } |
| 221 | |
| 222 | private void promptIMSI() |
| 223 | { |
| 224 | byte[] msg = {'N', 'e', 'w', ' ', 'I', 'M', 'S', 'I', '?'}; |
| 225 | byte imsi[] = prompt(msg, (short)0, (short)15); |
Neels Hofmeyr | d20f93a | 2020-02-24 22:42:22 +0100 | [diff] [blame] | 226 | /* The IMSI file should be 9 bytes long, even if the IMSI is shorter */ |
| 227 | byte mi[]; |
| 228 | try { |
| 229 | mi = MobileIdentity.str2mi(imsi, MobileIdentity.MI_IMSI, (byte)9); |
Neels Hofmeyr | 41b6f54 | 2020-02-24 23:00:30 +0100 | [diff] [blame] | 230 | writeIMSI(mi); |
Neels Hofmeyr | d20f93a | 2020-02-24 22:42:22 +0100 | [diff] [blame] | 231 | } catch (Exception e) { |
| 232 | byte err[] = {'E', 'R', 'R' }; |
| 233 | showMsgAndWaitKey(err); |
| 234 | } |
Oliver Smith | ca866fe | 2020-02-24 09:56:30 +0100 | [diff] [blame] | 235 | } |
Neels Hofmeyr | c24fdd1 | 2020-02-24 21:31:01 +0100 | [diff] [blame] | 236 | |
| 237 | private byte[] readIMSI() |
| 238 | { |
| 239 | gsmFile.select((short) SIMView.FID_DF_GSM); |
| 240 | gsmFile.select((short) SIMView.FID_EF_IMSI); |
| 241 | byte[] IMSI = new byte[9]; |
| 242 | gsmFile.readBinary((short)0, IMSI, (short)0, (short)9); |
| 243 | return IMSI; |
| 244 | } |
| 245 | |
Neels Hofmeyr | 2625694 | 2020-02-25 03:23:53 +0100 | [diff] [blame^] | 246 | private void writeIMSI(byte mi[]) throws Exception |
Neels Hofmeyr | c24fdd1 | 2020-02-24 21:31:01 +0100 | [diff] [blame] | 247 | { |
Neels Hofmeyr | 2625694 | 2020-02-25 03:23:53 +0100 | [diff] [blame^] | 248 | if (mi.length != 9) |
| 249 | throw new Exception(); |
Neels Hofmeyr | c24fdd1 | 2020-02-24 21:31:01 +0100 | [diff] [blame] | 250 | gsmFile.select((short) SIMView.FID_DF_GSM); |
| 251 | gsmFile.select((short) SIMView.FID_EF_IMSI); |
| 252 | gsmFile.updateBinary((short)0, mi, (short)0, (short)mi.length); |
| 253 | } |
Oliver Smith | 4e5e516 | 2020-02-21 08:47:36 +0100 | [diff] [blame] | 254 | } |