blob: a341b717f5f66e9a3d77ba6d741bcf21e3379438 [file] [log] [blame]
Sylvain Munaut76504e02010-12-07 00:24:32 +01001#!/usr/bin/env python
2# -*- coding: utf-8 -*-
3
4""" pySim: Card programmation logic
5"""
6
7#
8# Copyright (C) 2009-2010 Sylvain Munaut <tnt@246tNt.com>
Harald Welte3156d902011-03-22 21:48:19 +01009# Copyright (C) 2011 Harald Welte <laforge@gnumonks.org>
Alexander Chemeriseb6807d2017-07-18 17:04:38 +030010# Copyright (C) 2017 Alexander.Chemeris <Alexander.Chemeris@gmail.com>
Sylvain Munaut76504e02010-12-07 00:24:32 +010011#
12# This program is free software: you can redistribute it and/or modify
13# it under the terms of the GNU General Public License as published by
14# the Free Software Foundation, either version 2 of the License, or
15# (at your option) any later version.
16#
17# This program is distributed in the hope that it will be useful,
18# but WITHOUT ANY WARRANTY; without even the implied warranty of
19# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20# GNU General Public License for more details.
21#
22# You should have received a copy of the GNU General Public License
23# along with this program. If not, see <http://www.gnu.org/licenses/>.
24#
25
Alexander Chemeriseb6807d2017-07-18 17:04:38 +030026from pySim.ts_51_011 import EF, DF
27from pySim.utils import *
Alexander Chemeris8ad124a2018-01-10 14:17:55 +090028from smartcard.util import toBytes
Sylvain Munaut76504e02010-12-07 00:24:32 +010029
30class Card(object):
31
32 def __init__(self, scc):
33 self._scc = scc
Alexander Chemeriseb6807d2017-07-18 17:04:38 +030034 self._adm_chv_num = 4
Sylvain Munaut76504e02010-12-07 00:24:32 +010035
Sylvain Munaut76504e02010-12-07 00:24:32 +010036 def reset(self):
37 self._scc.reset_card()
38
Alexander Chemeriseb6807d2017-07-18 17:04:38 +030039 def verify_adm(self, key):
40 '''
41 Authenticate with ADM key
42 '''
43 (res, sw) = self._scc.verify_chv(self._adm_chv_num, key)
44 return sw
45
46 def read_iccid(self):
47 (res, sw) = self._scc.read_binary(EF['ICCID'])
48 if sw == '9000':
49 return (dec_iccid(res), sw)
50 else:
51 return (None, sw)
52
53 def read_imsi(self):
54 (res, sw) = self._scc.read_binary(EF['IMSI'])
55 if sw == '9000':
56 return (dec_imsi(res), sw)
57 else:
58 return (None, sw)
59
60 def update_imsi(self, imsi):
61 data, sw = self._scc.update_binary(EF['IMSI'], enc_imsi(imsi))
62 return sw
63
64 def update_acc(self, acc):
65 data, sw = self._scc.update_binary(EF['ACC'], lpad(acc, 4))
66 return sw
67
68 def update_hplmn_act(self, mcc, mnc, access_tech='FFFF'):
69 """
70 Update Home PLMN with access technology bit-field
71
72 See Section "10.3.37 EFHPLMNwAcT (HPLMN Selector with Access Technology)"
73 in ETSI TS 151 011 for the details of the access_tech field coding.
74 Some common values:
75 access_tech = '0080' # Only GSM is selected
76 access_tech = 'FFFF' # All technologues selected, even Reserved for Future Use ones
77 """
78 # get size and write EF.HPLMNwAcT
79 r = self._scc.select_file(EF['HPLMNwAcT'])
80 size = int(r[-1][4:8], 16)
81 hplmn = enc_plmn(mcc, mnc)
82 content = hplmn + access_tech
83 data, sw = self._scc.update_binary(EF['HPLMNwAcT'], content + 'ffffff0000' * (size/5-1))
84 return sw
85
Philipp Maierc8ce82a2018-07-04 17:57:20 +020086 def update_oplmn_act(self, mcc, mnc, access_tech='FFFF'):
87 """
88 See note in update_hplmn_act()
89 """
90 # get size and write EF.OPLMNwAcT
91 data = self._scc.read_binary(EF['OPLMNwAcT'], length=None, offset=0)
92 size = len(data[0])/2
93 hplmn = enc_plmn(mcc, mnc)
94 content = hplmn + access_tech
95 data, sw = self._scc.update_binary(EF['OPLMNwAcT'], content + 'ffffff0000' * (size/5-1))
96 return sw
97
98 def update_plmn_act(self, mcc, mnc, access_tech='FFFF'):
99 """
100 See note in update_hplmn_act()
101 """
102 # get size and write EF.PLMNwAcT
103 data = self._scc.read_binary(EF['PLMNwAcT'], length=None, offset=0)
104 size = len(data[0])/2
105 hplmn = enc_plmn(mcc, mnc)
106 content = hplmn + access_tech
107 data, sw = self._scc.update_binary(EF['PLMNwAcT'], content + 'ffffff0000' * (size/5-1))
108 return sw
109
Philipp Maier5bf42602018-07-11 23:23:40 +0200110 def update_plmnsel(self, mcc, mnc):
111 data = self._scc.read_binary(EF['PLMNsel'], length=None, offset=0)
112 size = len(data[0])/2
113 hplmn = enc_plmn(mcc, mnc)
Philipp Maieraf9ae8b2018-07-13 11:15:49 +0200114 data, sw = self._scc.update_binary(EF['PLMNsel'], hplmn + 'ff' * (size-3))
115 return sw
Philipp Maier5bf42602018-07-11 23:23:40 +0200116
Alexander Chemeriseb6807d2017-07-18 17:04:38 +0300117 def update_smsp(self, smsp):
118 data, sw = self._scc.update_record(EF['SMSP'], 1, rpad(smsp, 84))
119 return sw
120
Philipp Maieree908ae2019-03-21 16:21:12 +0100121 def update_ad(self, mnc):
122 #See also: 3GPP TS 31.102, chapter 4.2.18
123 mnclen = len(str(mnc))
124 if mnclen == 1:
125 mnclen = 2
126 if mnclen > 3:
127 raise RuntimeError('unable to calculate proper mnclen')
128
129 data = self._scc.read_binary(EF['AD'], length=None, offset=0)
130 size = len(data[0])/2
131 content = data[0][0:6] + "%02X" % mnclen
132 data, sw = self._scc.update_binary(EF['AD'], content)
133 return sw
134
Alexander Chemeriseb6807d2017-07-18 17:04:38 +0300135 def read_spn(self):
136 (spn, sw) = self._scc.read_binary(EF['SPN'])
137 if sw == '9000':
138 return (dec_spn(spn), sw)
139 else:
140 return (None, sw)
141
142 def update_spn(self, name, hplmn_disp=False, oplmn_disp=False):
143 content = enc_spn(name, hplmn_disp, oplmn_disp)
144 data, sw = self._scc.update_binary(EF['SPN'], rpad(content, 32))
145 return sw
146
Sylvain Munaut76504e02010-12-07 00:24:32 +0100147
148class _MagicSimBase(Card):
149 """
150 Theses cards uses several record based EFs to store the provider infos,
151 each possible provider uses a specific record number in each EF. The
152 indexes used are ( where N is the number of providers supported ) :
153 - [2 .. N+1] for the operator name
154 - [1 .. N] for the programable EFs
155
156 * 3f00/7f4d/8f0c : Operator Name
157
158 bytes 0-15 : provider name, padded with 0xff
159 byte 16 : length of the provider name
160 byte 17 : 01 for valid records, 00 otherwise
161
162 * 3f00/7f4d/8f0d : Programmable Binary EFs
163
164 * 3f00/7f4d/8f0e : Programmable Record EFs
165
166 """
167
168 @classmethod
169 def autodetect(kls, scc):
170 try:
171 for p, l, t in kls._files.values():
172 if not t:
173 continue
174 if scc.record_size(['3f00', '7f4d', p]) != l:
175 return None
176 except:
177 return None
178
179 return kls(scc)
180
181 def _get_count(self):
182 """
183 Selects the file and returns the total number of entries
184 and entry size
185 """
186 f = self._files['name']
187
188 r = self._scc.select_file(['3f00', '7f4d', f[0]])
189 rec_len = int(r[-1][28:30], 16)
190 tlen = int(r[-1][4:8],16)
191 rec_cnt = (tlen / rec_len) - 1;
192
193 if (rec_cnt < 1) or (rec_len != f[1]):
194 raise RuntimeError('Bad card type')
195
196 return rec_cnt
197
198 def program(self, p):
199 # Go to dir
200 self._scc.select_file(['3f00', '7f4d'])
201
202 # Home PLMN in PLMN_Sel format
Alexander Chemeris7be92ff2013-07-10 11:18:06 +0400203 hplmn = enc_plmn(p['mcc'], p['mnc'])
Sylvain Munaut76504e02010-12-07 00:24:32 +0100204
205 # Operator name ( 3f00/7f4d/8f0c )
206 self._scc.update_record(self._files['name'][0], 2,
207 rpad(b2h(p['name']), 32) + ('%02x' % len(p['name'])) + '01'
208 )
209
210 # ICCID/IMSI/Ki/HPLMN ( 3f00/7f4d/8f0d )
211 v = ''
212
213 # inline Ki
214 if self._ki_file is None:
215 v += p['ki']
216
217 # ICCID
Alexander Chemeris7be92ff2013-07-10 11:18:06 +0400218 v += '3f00' + '2fe2' + '0a' + enc_iccid(p['iccid'])
Sylvain Munaut76504e02010-12-07 00:24:32 +0100219
220 # IMSI
Alexander Chemeris7be92ff2013-07-10 11:18:06 +0400221 v += '7f20' + '6f07' + '09' + enc_imsi(p['imsi'])
Sylvain Munaut76504e02010-12-07 00:24:32 +0100222
223 # Ki
224 if self._ki_file:
225 v += self._ki_file + '10' + p['ki']
226
227 # PLMN_Sel
228 v+= '6f30' + '18' + rpad(hplmn, 36)
229
Alexander Chemeris21885242013-07-02 16:56:55 +0400230 # ACC
231 # This doesn't work with "fake" SuperSIM cards,
232 # but will hopefully work with real SuperSIMs.
233 if p.get('acc') is not None:
234 v+= '6f78' + '02' + lpad(p['acc'], 4)
235
Sylvain Munaut76504e02010-12-07 00:24:32 +0100236 self._scc.update_record(self._files['b_ef'][0], 1,
237 rpad(v, self._files['b_ef'][1]*2)
238 )
239
240 # SMSP ( 3f00/7f4d/8f0e )
241 # FIXME
242
243 # Write PLMN_Sel forcefully as well
244 r = self._scc.select_file(['3f00', '7f20', '6f30'])
245 tl = int(r[-1][4:8], 16)
246
Alexander Chemeris7be92ff2013-07-10 11:18:06 +0400247 hplmn = enc_plmn(p['mcc'], p['mnc'])
Sylvain Munaut76504e02010-12-07 00:24:32 +0100248 self._scc.update_binary('6f30', hplmn + 'ff' * (tl-3))
249
250 def erase(self):
251 # Dummy
252 df = {}
253 for k, v in self._files.iteritems():
254 ofs = 1
255 fv = v[1] * 'ff'
256 if k == 'name':
257 ofs = 2
258 fv = fv[0:-4] + '0000'
259 df[v[0]] = (fv, ofs)
260
261 # Write
262 for n in range(0,self._get_count()):
263 for k, (msg, ofs) in df.iteritems():
264 self._scc.update_record(['3f00', '7f4d', k], n + ofs, msg)
265
266
267class SuperSim(_MagicSimBase):
268
269 name = 'supersim'
270
271 _files = {
272 'name' : ('8f0c', 18, True),
273 'b_ef' : ('8f0d', 74, True),
274 'r_ef' : ('8f0e', 50, True),
275 }
276
277 _ki_file = None
278
279
280class MagicSim(_MagicSimBase):
281
282 name = 'magicsim'
283
284 _files = {
285 'name' : ('8f0c', 18, True),
286 'b_ef' : ('8f0d', 130, True),
287 'r_ef' : ('8f0e', 102, False),
288 }
289
290 _ki_file = '6f1b'
291
292
293class FakeMagicSim(Card):
294 """
295 Theses cards have a record based EF 3f00/000c that contains the provider
296 informations. See the program method for its format. The records go from
297 1 to N.
298 """
299
300 name = 'fakemagicsim'
301
302 @classmethod
303 def autodetect(kls, scc):
304 try:
305 if scc.record_size(['3f00', '000c']) != 0x5a:
306 return None
307 except:
308 return None
309
310 return kls(scc)
311
312 def _get_infos(self):
313 """
314 Selects the file and returns the total number of entries
315 and entry size
316 """
317
318 r = self._scc.select_file(['3f00', '000c'])
319 rec_len = int(r[-1][28:30], 16)
320 tlen = int(r[-1][4:8],16)
321 rec_cnt = (tlen / rec_len) - 1;
322
323 if (rec_cnt < 1) or (rec_len != 0x5a):
324 raise RuntimeError('Bad card type')
325
326 return rec_cnt, rec_len
327
328 def program(self, p):
329 # Home PLMN
330 r = self._scc.select_file(['3f00', '7f20', '6f30'])
331 tl = int(r[-1][4:8], 16)
332
Alexander Chemeris7be92ff2013-07-10 11:18:06 +0400333 hplmn = enc_plmn(p['mcc'], p['mnc'])
Sylvain Munaut76504e02010-12-07 00:24:32 +0100334 self._scc.update_binary('6f30', hplmn + 'ff' * (tl-3))
335
336 # Get total number of entries and entry size
337 rec_cnt, rec_len = self._get_infos()
338
339 # Set first entry
340 entry = (
Philipp Maier45daa922019-04-01 15:49:45 +0200341 '81' + # 1b Status: Valid & Active
Sylvain Munaut76504e02010-12-07 00:24:32 +0100342 rpad(b2h(p['name'][0:14]), 28) + # 14b Entry Name
Philipp Maier45daa922019-04-01 15:49:45 +0200343 enc_iccid(p['iccid']) + # 10b ICCID
344 enc_imsi(p['imsi']) + # 9b IMSI_len + id_type(9) + IMSI
345 p['ki'] + # 16b Ki
346 lpad(p['smsp'], 80) # 40b SMSP (padded with ff if needed)
Sylvain Munaut76504e02010-12-07 00:24:32 +0100347 )
348 self._scc.update_record('000c', 1, entry)
349
350 def erase(self):
351 # Get total number of entries and entry size
352 rec_cnt, rec_len = self._get_infos()
353
354 # Erase all entries
355 entry = 'ff' * rec_len
356 for i in range(0, rec_cnt):
357 self._scc.update_record('000c', 1+i, entry)
358
Sylvain Munaut5da8d4e2013-07-02 15:13:24 +0200359
Harald Welte3156d902011-03-22 21:48:19 +0100360class GrcardSim(Card):
361 """
362 Greencard (grcard.cn) HZCOS GSM SIM
363 These cards have a much more regular ISO 7816-4 / TS 11.11 structure,
364 and use standard UPDATE RECORD / UPDATE BINARY commands except for Ki.
365 """
366
367 name = 'grcardsim'
368
369 @classmethod
370 def autodetect(kls, scc):
371 return None
372
373 def program(self, p):
374 # We don't really know yet what ADM PIN 4 is about
375 #self._scc.verify_chv(4, h2b("4444444444444444"))
376
377 # Authenticate using ADM PIN 5
Jan Balkec3ebd332015-01-26 12:22:55 +0100378 if p['pin_adm']:
Philipp Maiera3de5a32018-08-23 10:27:04 +0200379 pin = h2b(p['pin_adm'])
Jan Balkec3ebd332015-01-26 12:22:55 +0100380 else:
381 pin = h2b("4444444444444444")
382 self._scc.verify_chv(5, pin)
Harald Welte3156d902011-03-22 21:48:19 +0100383
384 # EF.ICCID
385 r = self._scc.select_file(['3f00', '2fe2'])
Alexander Chemeris7be92ff2013-07-10 11:18:06 +0400386 data, sw = self._scc.update_binary('2fe2', enc_iccid(p['iccid']))
Harald Welte3156d902011-03-22 21:48:19 +0100387
388 # EF.IMSI
389 r = self._scc.select_file(['3f00', '7f20', '6f07'])
Alexander Chemeris7be92ff2013-07-10 11:18:06 +0400390 data, sw = self._scc.update_binary('6f07', enc_imsi(p['imsi']))
Harald Welte3156d902011-03-22 21:48:19 +0100391
392 # EF.ACC
Alexander Chemeris21885242013-07-02 16:56:55 +0400393 if p.get('acc') is not None:
394 data, sw = self._scc.update_binary('6f78', lpad(p['acc'], 4))
Harald Welte3156d902011-03-22 21:48:19 +0100395
396 # EF.SMSP
397 r = self._scc.select_file(['3f00', '7f10', '6f42'])
Sylvain Munaut8ca49e92011-12-10 09:57:50 +0100398 data, sw = self._scc.update_record('6f42', 1, lpad(p['smsp'], 80))
Harald Welte3156d902011-03-22 21:48:19 +0100399
400 # Set the Ki using proprietary command
401 pdu = '80d4020010' + p['ki']
402 data, sw = self._scc._tp.send_apdu(pdu)
403
404 # EF.HPLMN
405 r = self._scc.select_file(['3f00', '7f20', '6f30'])
406 size = int(r[-1][4:8], 16)
Alexander Chemeris7be92ff2013-07-10 11:18:06 +0400407 hplmn = enc_plmn(p['mcc'], p['mnc'])
Harald Welte3156d902011-03-22 21:48:19 +0100408 self._scc.update_binary('6f30', hplmn + 'ff' * (size-3))
409
410 # EF.SPN (Service Provider Name)
411 r = self._scc.select_file(['3f00', '7f20', '6f30'])
412 size = int(r[-1][4:8], 16)
413 # FIXME
414
415 # FIXME: EF.MSISDN
416
417 def erase(self):
418 return
Sylvain Munaut76504e02010-12-07 00:24:32 +0100419
Harald Weltee10394b2011-12-07 12:34:14 +0100420class SysmoSIMgr1(GrcardSim):
421 """
422 sysmocom sysmoSIM-GR1
423 These cards have a much more regular ISO 7816-4 / TS 11.11 structure,
424 and use standard UPDATE RECORD / UPDATE BINARY commands except for Ki.
425 """
426 name = 'sysmosim-gr1'
427
Philipp Maier087feff2018-08-23 09:41:36 +0200428 @classmethod
429 def autodetect(kls, scc):
430 try:
431 # Look for ATR
432 if scc.get_atr() == toBytes("3B 99 18 00 11 88 22 33 44 55 66 77 60"):
433 return kls(scc)
434 except:
435 return None
436 return None
Sylvain Munaut5da8d4e2013-07-02 15:13:24 +0200437
Holger Hans Peter Freyther4d91bf42012-03-22 14:28:38 +0100438class SysmoUSIMgr1(Card):
439 """
440 sysmocom sysmoUSIM-GR1
441 """
442 name = 'sysmoUSIM-GR1'
443
444 @classmethod
445 def autodetect(kls, scc):
446 # TODO: Access the ATR
447 return None
448
449 def program(self, p):
450 # TODO: check if verify_chv could be used or what it needs
451 # self._scc.verify_chv(0x0A, [0x33,0x32,0x32,0x31,0x33,0x32,0x33,0x32])
452 # Unlock the card..
453 data, sw = self._scc._tp.send_apdu_checksw("0020000A083332323133323332")
454
455 # TODO: move into SimCardCommands
Holger Hans Peter Freyther4d91bf42012-03-22 14:28:38 +0100456 par = ( p['ki'] + # 16b K
Alexander Chemeris7be92ff2013-07-10 11:18:06 +0400457 p['opc'] + # 32b OPC
458 enc_iccid(p['iccid']) + # 10b ICCID
459 enc_imsi(p['imsi']) # 9b IMSI_len + id_type(9) + IMSI
Holger Hans Peter Freyther4d91bf42012-03-22 14:28:38 +0100460 )
461 data, sw = self._scc._tp.send_apdu_checksw("0099000033" + par)
462
463 def erase(self):
464 return
465
Sylvain Munaut053c8952013-07-02 15:12:32 +0200466
Sylvain Munaut2fc205c2013-12-23 17:22:56 +0100467class SysmoSIMgr2(Card):
468 """
469 sysmocom sysmoSIM-GR2
470 """
471
472 name = 'sysmoSIM-GR2'
473
474 @classmethod
475 def autodetect(kls, scc):
Alexander Chemeris8ad124a2018-01-10 14:17:55 +0900476 try:
477 # Look for ATR
478 if scc.get_atr() == toBytes("3B 7D 94 00 00 55 55 53 0A 74 86 93 0B 24 7C 4D 54 68"):
479 return kls(scc)
480 except:
481 return None
Sylvain Munaut2fc205c2013-12-23 17:22:56 +0100482 return None
483
484 def program(self, p):
485
486 # select MF
487 r = self._scc.select_file(['3f00'])
488
489 # authenticate as SUPER ADM using default key
490 self._scc.verify_chv(0x0b, h2b("3838383838383838"))
491
492 # set ADM pin using proprietary command
493 # INS: D4
494 # P1: 3A for PIN, 3B for PUK
495 # P2: CHV number, as in VERIFY CHV for PIN, and as in UNBLOCK CHV for PUK
496 # P3: 08, CHV length (curiously the PUK is also 08 length, instead of 10)
Jan Balkec3ebd332015-01-26 12:22:55 +0100497 if p['pin_adm']:
498 pin = p['pin_adm']
499 else:
500 pin = h2b("4444444444444444")
501
502 pdu = 'A0D43A0508' + b2h(pin)
Sylvain Munaut2fc205c2013-12-23 17:22:56 +0100503 data, sw = self._scc._tp.send_apdu(pdu)
504
505 # authenticate as ADM (enough to write file, and can set PINs)
Jan Balkec3ebd332015-01-26 12:22:55 +0100506
507 self._scc.verify_chv(0x05, pin)
Sylvain Munaut2fc205c2013-12-23 17:22:56 +0100508
509 # write EF.ICCID
510 data, sw = self._scc.update_binary('2fe2', enc_iccid(p['iccid']))
511
512 # select DF_GSM
513 r = self._scc.select_file(['7f20'])
514
515 # write EF.IMSI
516 data, sw = self._scc.update_binary('6f07', enc_imsi(p['imsi']))
517
518 # write EF.ACC
519 if p.get('acc') is not None:
520 data, sw = self._scc.update_binary('6f78', lpad(p['acc'], 4))
521
522 # get size and write EF.HPLMN
523 r = self._scc.select_file(['6f30'])
524 size = int(r[-1][4:8], 16)
525 hplmn = enc_plmn(p['mcc'], p['mnc'])
526 self._scc.update_binary('6f30', hplmn + 'ff' * (size-3))
527
528 # set COMP128 version 0 in proprietary file
529 data, sw = self._scc.update_binary('0001', '001000')
530
531 # set Ki in proprietary file
532 data, sw = self._scc.update_binary('0001', p['ki'], 3)
533
534 # select DF_TELECOM
535 r = self._scc.select_file(['3f00', '7f10'])
536
537 # write EF.SMSP
538 data, sw = self._scc.update_record('6f42', 1, lpad(p['smsp'], 80))
539
540 def erase(self):
541 return
542
Jan Balke3e840672015-01-26 15:36:27 +0100543class SysmoUSIMSJS1(Card):
544 """
545 sysmocom sysmoUSIM-SJS1
546 """
547
548 name = 'sysmoUSIM-SJS1'
549
550 def __init__(self, ssc):
551 super(SysmoUSIMSJS1, self).__init__(ssc)
552 self._scc.cla_byte = "00"
Philipp Maier2d15ea02019-03-20 12:40:36 +0100553 self._scc.sel_ctrl = "0004" #request an FCP
Jan Balke3e840672015-01-26 15:36:27 +0100554
555 @classmethod
556 def autodetect(kls, scc):
Alexander Chemeris8ad124a2018-01-10 14:17:55 +0900557 try:
558 # Look for ATR
559 if scc.get_atr() == toBytes("3B 9F 96 80 1F C7 80 31 A0 73 BE 21 13 67 43 20 07 18 00 00 01 A5"):
560 return kls(scc)
561 except:
562 return None
Jan Balke3e840672015-01-26 15:36:27 +0100563 return None
564
565 def program(self, p):
566
Philipp Maiere9604882017-03-21 17:24:31 +0100567 # authenticate as ADM using default key (written on the card..)
568 if not p['pin_adm']:
569 raise ValueError("Please provide a PIN-ADM as there is no default one")
570 self._scc.verify_chv(0x0A, h2b(p['pin_adm']))
Jan Balke3e840672015-01-26 15:36:27 +0100571
572 # select MF
573 r = self._scc.select_file(['3f00'])
574
Philipp Maiere9604882017-03-21 17:24:31 +0100575 # write EF.ICCID
576 data, sw = self._scc.update_binary('2fe2', enc_iccid(p['iccid']))
577
Jan Balke3e840672015-01-26 15:36:27 +0100578 # select DF_GSM
579 r = self._scc.select_file(['7f20'])
580
Jan Balke3e840672015-01-26 15:36:27 +0100581 # set Ki in proprietary file
582 data, sw = self._scc.update_binary('00FF', p['ki'])
583
Philipp Maier1be35bf2018-07-13 11:29:03 +0200584 # set OPc in proprietary file
Jan Balke3e840672015-01-26 15:36:27 +0100585 content = "01" + p['opc']
586 data, sw = self._scc.update_binary('00F7', content)
587
588
589 # write EF.IMSI
590 data, sw = self._scc.update_binary('6f07', enc_imsi(p['imsi']))
591
Philipp Maier2d15ea02019-03-20 12:40:36 +0100592 # EF.PLMNsel
593 if p.get('mcc') and p.get('mnc'):
594 sw = self.update_plmnsel(p['mcc'], p['mnc'])
595 if sw != '9000':
596 print("Programming PLMNsel failed with code %s"%sw)
597
598 # EF.PLMNwAcT
599 if p.get('mcc') and p.get('mnc'):
600 sw = self.update_plmn_act(p['mcc'], p['mnc'])
601 if sw != '9000':
602 print("Programming PLMNwAcT failed with code %s"%sw)
603
604 # EF.OPLMNwAcT
605 if p.get('mcc') and p.get('mnc'):
606 sw = self.update_oplmn_act(p['mcc'], p['mnc'])
607 if sw != '9000':
608 print("Programming OPLMNwAcT failed with code %s"%sw)
609
Philipp Maieree908ae2019-03-21 16:21:12 +0100610 # EF.AD
611 if p.get('mcc') and p.get('mnc'):
612 sw = self.update_ad(p['mnc'])
613 if sw != '9000':
614 print("Programming AD failed with code %s"%sw)
Philipp Maier2d15ea02019-03-20 12:40:36 +0100615
Daniel Willmann1d087ef2017-08-31 10:08:45 +0200616 # EF.SMSP
617 r = self._scc.select_file(['3f00', '7f10'])
618 data, sw = self._scc.update_record('6f42', 1, lpad(p['smsp'], 104), force_len=True)
Jan Balke3e840672015-01-26 15:36:27 +0100619
Alexander Chemerise0d9d882018-01-10 14:18:32 +0900620 def erase(self):
621 return
622
623
624class FairwavesSIM(Card):
625 """
626 FairwavesSIM
627
628 The SIM card is operating according to the standard.
629 For Ki/OP/OPC programming the following files are additionally open for writing:
630 3F00/7F20/FF01 – OP/OPC:
631 byte 1 = 0x01, bytes 2-17: OPC;
632 byte 1 = 0x00, bytes 2-17: OP;
633 3F00/7F20/FF02: Ki
634 """
635
636 name = 'Fairwaves SIM'
637 # Propriatary files
638 _EF_num = {
639 'Ki': 'FF02',
640 'OP/OPC': 'FF01',
641 }
642 _EF = {
643 'Ki': DF['GSM']+[_EF_num['Ki']],
644 'OP/OPC': DF['GSM']+[_EF_num['OP/OPC']],
645 }
646
647 def __init__(self, ssc):
648 super(FairwavesSIM, self).__init__(ssc)
649 self._adm_chv_num = 0x11
650 self._adm2_chv_num = 0x12
651
652
653 @classmethod
654 def autodetect(kls, scc):
655 try:
656 # Look for ATR
657 if scc.get_atr() == toBytes("3B 9F 96 80 1F C7 80 31 A0 73 BE 21 13 67 44 22 06 10 00 00 01 A9"):
658 return kls(scc)
659 except:
660 return None
661 return None
662
663
664 def verify_adm2(self, key):
665 '''
666 Authenticate with ADM2 key.
667
668 Fairwaves SIM cards support hierarchical key structure and ADM2 key
669 is a key which has access to proprietary files (Ki and OP/OPC).
670 That said, ADM key inherits permissions of ADM2 key and thus we rarely
671 need ADM2 key per se.
672 '''
673 (res, sw) = self._scc.verify_chv(self._adm2_chv_num, key)
674 return sw
675
676
677 def read_ki(self):
678 """
679 Read Ki in proprietary file.
680
681 Requires ADM1 access level
682 """
683 return self._scc.read_binary(self._EF['Ki'])
684
685
686 def update_ki(self, ki):
687 """
688 Set Ki in proprietary file.
689
690 Requires ADM1 access level
691 """
692 data, sw = self._scc.update_binary(self._EF['Ki'], ki)
693 return sw
694
695
696 def read_op_opc(self):
697 """
698 Read Ki in proprietary file.
699
700 Requires ADM1 access level
701 """
702 (ef, sw) = self._scc.read_binary(self._EF['OP/OPC'])
703 type = 'OP' if ef[0:2] == '00' else 'OPC'
704 return ((type, ef[2:]), sw)
705
706
707 def update_op(self, op):
708 """
709 Set OP in proprietary file.
710
711 Requires ADM1 access level
712 """
713 content = '00' + op
714 data, sw = self._scc.update_binary(self._EF['OP/OPC'], content)
715 return sw
716
717
718 def update_opc(self, opc):
719 """
720 Set OPC in proprietary file.
721
722 Requires ADM1 access level
723 """
724 content = '01' + opc
725 data, sw = self._scc.update_binary(self._EF['OP/OPC'], content)
726 return sw
727
728
729 def program(self, p):
730 # authenticate as ADM1
731 if not p['pin_adm']:
732 raise ValueError("Please provide a PIN-ADM as there is no default one")
733 sw = self.verify_adm(h2b(p['pin_adm']))
734 if sw != '9000':
735 raise RuntimeError('Failed to authenticate with ADM key %s'%(p['pin_adm'],))
736
737 # TODO: Set operator name
738 if p.get('smsp') is not None:
739 sw = self.update_smsp(p['smsp'])
740 if sw != '9000':
741 print("Programming SMSP failed with code %s"%sw)
742 # This SIM doesn't support changing ICCID
743 if p.get('mcc') is not None and p.get('mnc') is not None:
744 sw = self.update_hplmn_act(p['mcc'], p['mnc'])
745 if sw != '9000':
746 print("Programming MCC/MNC failed with code %s"%sw)
747 if p.get('imsi') is not None:
748 sw = self.update_imsi(p['imsi'])
749 if sw != '9000':
750 print("Programming IMSI failed with code %s"%sw)
751 if p.get('ki') is not None:
752 sw = self.update_ki(p['ki'])
753 if sw != '9000':
754 print("Programming Ki failed with code %s"%sw)
755 if p.get('opc') is not None:
756 sw = self.update_opc(p['opc'])
757 if sw != '9000':
758 print("Programming OPC failed with code %s"%sw)
759 if p.get('acc') is not None:
760 sw = self.update_acc(p['acc'])
761 if sw != '9000':
762 print("Programming ACC failed with code %s"%sw)
Jan Balke3e840672015-01-26 15:36:27 +0100763
764 def erase(self):
765 return
766
767
Todd Neal9eeadfc2018-04-25 15:36:29 -0500768class OpenCellsSim(Card):
769 """
770 OpenCellsSim
771
772 """
773
774 name = 'OpenCells SIM'
775
776 def __init__(self, ssc):
777 super(OpenCellsSim, self).__init__(ssc)
778 self._adm_chv_num = 0x0A
779
780
781 @classmethod
782 def autodetect(kls, scc):
783 try:
784 # Look for ATR
785 if scc.get_atr() == toBytes("3B 9F 95 80 1F C3 80 31 E0 73 FE 21 13 57 86 81 02 86 98 44 18 A8"):
786 return kls(scc)
787 except:
788 return None
789 return None
790
791
792 def program(self, p):
793 if not p['pin_adm']:
794 raise ValueError("Please provide a PIN-ADM as there is no default one")
795 self._scc.verify_chv(0x0A, h2b(p['pin_adm']))
796
797 # select MF
798 r = self._scc.select_file(['3f00'])
799
800 # write EF.ICCID
801 data, sw = self._scc.update_binary('2fe2', enc_iccid(p['iccid']))
802
803 r = self._scc.select_file(['7ff0'])
804
805 # set Ki in proprietary file
806 data, sw = self._scc.update_binary('FF02', p['ki'])
807
808 # set OPC in proprietary file
809 data, sw = self._scc.update_binary('FF01', p['opc'])
810
811 # select DF_GSM
812 r = self._scc.select_file(['7f20'])
813
814 # write EF.IMSI
815 data, sw = self._scc.update_binary('6f07', enc_imsi(p['imsi']))
816
Philipp Maierc8ce82a2018-07-04 17:57:20 +0200817class WavemobileSim(Card):
818 """
819 WavemobileSim
820
821 """
822
823 name = 'Wavemobile-SIM'
824
825 def __init__(self, ssc):
826 super(WavemobileSim, self).__init__(ssc)
827 self._adm_chv_num = 0x0A
828 self._scc.cla_byte = "00"
829 self._scc.sel_ctrl = "0004" #request an FCP
830
831 @classmethod
832 def autodetect(kls, scc):
833 try:
834 # Look for ATR
835 if scc.get_atr() == toBytes("3B 9F 95 80 1F C7 80 31 E0 73 F6 21 13 67 4D 45 16 00 43 01 00 8F"):
836 return kls(scc)
837 except:
838 return None
839 return None
840
841 def program(self, p):
842 if not p['pin_adm']:
843 raise ValueError("Please provide a PIN-ADM as there is no default one")
844 sw = self.verify_adm(h2b(p['pin_adm']))
845 if sw != '9000':
846 raise RuntimeError('Failed to authenticate with ADM key %s'%(p['pin_adm'],))
847
848 # EF.ICCID
849 # TODO: Add programming of the ICCID
850 if p.get('iccid'):
851 print("Warning: Programming of the ICCID is not implemented for this type of card.")
852
853 # KI (Presumably a propritary file)
854 # TODO: Add programming of KI
855 if p.get('ki'):
856 print("Warning: Programming of the KI is not implemented for this type of card.")
857
858 # OPc (Presumably a propritary file)
859 # TODO: Add programming of OPc
860 if p.get('opc'):
861 print("Warning: Programming of the OPc is not implemented for this type of card.")
862
863 # EF.SMSP
864 if p.get('smsp'):
865 sw = self.update_smsp(p['smsp'])
866 if sw != '9000':
867 print("Programming SMSP failed with code %s"%sw)
868
869 # EF.IMSI
870 if p.get('imsi'):
871 sw = self.update_imsi(p['imsi'])
872 if sw != '9000':
873 print("Programming IMSI failed with code %s"%sw)
874
875 # EF.ACC
876 if p.get('acc'):
877 sw = self.update_acc(p['acc'])
878 if sw != '9000':
879 print("Programming ACC failed with code %s"%sw)
880
881 # EF.PLMNsel
882 if p.get('mcc') and p.get('mnc'):
883 sw = self.update_plmnsel(p['mcc'], p['mnc'])
884 if sw != '9000':
885 print("Programming PLMNsel failed with code %s"%sw)
886
887 # EF.PLMNwAcT
888 if p.get('mcc') and p.get('mnc'):
889 sw = self.update_plmn_act(p['mcc'], p['mnc'])
890 if sw != '9000':
891 print("Programming PLMNwAcT failed with code %s"%sw)
892
893 # EF.OPLMNwAcT
894 if p.get('mcc') and p.get('mnc'):
895 sw = self.update_oplmn_act(p['mcc'], p['mnc'])
896 if sw != '9000':
897 print("Programming OPLMNwAcT failed with code %s"%sw)
898
Philipp Maier6e507a72019-04-01 16:33:48 +0200899 # EF.AD
900 if p.get('mcc') and p.get('mnc'):
901 sw = self.update_ad(p['mnc'])
902 if sw != '9000':
903 print("Programming AD failed with code %s"%sw)
904
Philipp Maierc8ce82a2018-07-04 17:57:20 +0200905 return None
906
907 def erase(self):
908 return
909
Todd Neal9eeadfc2018-04-25 15:36:29 -0500910
911# In order for autodetection ...
Harald Weltee10394b2011-12-07 12:34:14 +0100912_cards_classes = [ FakeMagicSim, SuperSim, MagicSim, GrcardSim,
Alexander Chemerise0d9d882018-01-10 14:18:32 +0900913 SysmoSIMgr1, SysmoSIMgr2, SysmoUSIMgr1, SysmoUSIMSJS1,
Philipp Maierc8ce82a2018-07-04 17:57:20 +0200914 FairwavesSIM, OpenCellsSim, WavemobileSim ]
Alexander Chemeris8ad124a2018-01-10 14:17:55 +0900915
916def card_autodetect(scc):
917 for kls in _cards_classes:
918 card = kls.autodetect(scc)
919 if card is not None:
920 card.reset()
921 return card
922 return None