Split all things into a more "library-like" package

Signed-off-by: Sylvain Munaut <tnt@246tNt.com>

1 files changed, 259 insertions, 0 deletions

diff --git a/pySim/cards.py b/pySim/cards.py
new file mode 100644
index 0000000..55a3247
--- /dev/null
+++ b/pySim/cards.py
@@ -0,0 +1,259 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+""" pySim: Card programmation logic
+"""
+
+#
+# Copyright (C) 2009-2010  Sylvain Munaut <tnt@246tNt.com>
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 2 of the License, or
+# (at your option) any later version.
+#
+# 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, see <http://www.gnu.org/licenses/>.
+#
+
+from pySim.utils import b2h, swap_nibbles, rpad, lpad
+
+
+class Card(object):
+
+	def __init__(self, scc):
+		self._scc = scc
+
+	def _e_iccid(self, iccid):
+		return swap_nibbles(iccid)
+
+	def _e_imsi(self, imsi):
+		"""Converts a string imsi into the value of the EF"""
+		l = (len(imsi) + 1) // 2	# Required bytes
+		oe = len(imsi) & 1			# Odd (1) / Even (0)
+		ei = '%02x' % l + swap_nibbles(lpad('%01x%s' % ((oe<<3)|1, imsi), 16))
+		return ei
+
+	def _e_plmn(self, mcc, mnc):
+		"""Converts integer MCC/MNC into 6 bytes for EF"""
+		return swap_nibbles(lpad('%d' % mcc, 3) + lpad('%d' % mnc, 3))
+
+	def reset(self):
+		self._scc.reset_card()
+
+
+class _MagicSimBase(Card):
+	"""
+	Theses cards uses several record based EFs to store the provider infos,
+	each possible provider uses a specific record number in each EF. The
+	indexes used are ( where N is the number of providers supported ) :
+	 - [2 .. N+1] for the operator name
+     - [1 .. N] for the programable EFs
+
+	* 3f00/7f4d/8f0c : Operator Name
+
+	bytes 0-15 : provider name, padded with 0xff
+	byte  16   : length of the provider name
+	byte  17   : 01 for valid records, 00 otherwise
+
+	* 3f00/7f4d/8f0d : Programmable Binary EFs
+
+	* 3f00/7f4d/8f0e : Programmable Record EFs
+
+	"""
+
+	@classmethod
+	def autodetect(kls, scc):
+		try:
+			for p, l, t in kls._files.values():
+				if not t:
+					continue
+				if scc.record_size(['3f00', '7f4d', p]) != l:
+					return None
+		except:
+			return None
+
+		return kls(scc)
+
+	def _get_count(self):
+		"""
+		Selects the file and returns the total number of entries
+		and entry size
+		"""
+		f = self._files['name']
+
+		r = self._scc.select_file(['3f00', '7f4d', f[0]])
+		rec_len = int(r[-1][28:30], 16)
+		tlen = int(r[-1][4:8],16)
+		rec_cnt = (tlen / rec_len) - 1;
+
+		if (rec_cnt < 1) or (rec_len != f[1]):
+			raise RuntimeError('Bad card type')
+
+		return rec_cnt
+
+	def program(self, p):
+		# Go to dir
+		self._scc.select_file(['3f00', '7f4d'])
+
+		# Home PLMN in PLMN_Sel format
+		hplmn = self._e_plmn(p['mcc'], p['mnc'])
+
+		# Operator name ( 3f00/7f4d/8f0c )
+		self._scc.update_record(self._files['name'][0], 2,
+			rpad(b2h(p['name']), 32)  + ('%02x' % len(p['name'])) + '01'
+		)
+
+		# ICCID/IMSI/Ki/HPLMN ( 3f00/7f4d/8f0d )
+		v = ''
+
+			# inline Ki
+		if self._ki_file is None:
+			v += p['ki']
+
+			# ICCID
+		v += '3f00' + '2fe2' + '0a' + self._e_iccid(p['iccid'])
+
+			# IMSI
+		v += '7f20' + '6f07' + '09' + self._e_imsi(p['imsi'])
+
+			# Ki
+		if self._ki_file:
+			v += self._ki_file + '10' + p['ki']
+
+			# PLMN_Sel
+		v+= '6f30' + '18' +  rpad(hplmn, 36)
+
+		self._scc.update_record(self._files['b_ef'][0], 1,
+			rpad(v, self._files['b_ef'][1]*2)
+		)
+
+		# SMSP ( 3f00/7f4d/8f0e )
+			# FIXME
+
+		# Write PLMN_Sel forcefully as well
+		r = self._scc.select_file(['3f00', '7f20', '6f30'])
+		tl = int(r[-1][4:8], 16)
+
+		hplmn = self._e_plmn(p['mcc'], p['mnc'])
+		self._scc.update_binary('6f30', hplmn + 'ff' * (tl-3))
+
+	def erase(self):
+		# Dummy
+		df = {}
+		for k, v in self._files.iteritems():
+			ofs = 1
+			fv = v[1] * 'ff'
+			if k == 'name':
+				ofs = 2
+				fv = fv[0:-4] + '0000'
+			df[v[0]] = (fv, ofs)
+
+		# Write
+		for n in range(0,self._get_count()):
+			for k, (msg, ofs) in df.iteritems():
+				self._scc.update_record(['3f00', '7f4d', k], n + ofs, msg)
+
+
+class SuperSim(_MagicSimBase):
+
+	name = 'supersim'
+
+	_files = {
+		'name' : ('8f0c', 18, True),
+		'b_ef' : ('8f0d', 74, True),
+		'r_ef' : ('8f0e', 50, True),
+	}
+
+	_ki_file = None
+
+
+class MagicSim(_MagicSimBase):
+
+	name = 'magicsim'
+
+	_files = {
+		'name' : ('8f0c', 18, True),
+		'b_ef' : ('8f0d', 130, True),
+		'r_ef' : ('8f0e', 102, False),
+	}
+
+	_ki_file = '6f1b'
+
+
+class FakeMagicSim(Card):
+	"""
+	Theses cards have a record based EF 3f00/000c that contains the provider
+	informations. See the program method for its format. The records go from
+	1 to N.
+	"""
+
+	name = 'fakemagicsim'
+
+	@classmethod
+	def autodetect(kls, scc):
+		try:
+			if scc.record_size(['3f00', '000c']) != 0x5a:
+				return None
+		except:
+			return None
+
+		return kls(scc)
+
+	def _get_infos(self):
+		"""
+		Selects the file and returns the total number of entries
+		and entry size
+		"""
+
+		r = self._scc.select_file(['3f00', '000c'])
+		rec_len = int(r[-1][28:30], 16)
+		tlen = int(r[-1][4:8],16)
+		rec_cnt = (tlen / rec_len) - 1;
+
+		if (rec_cnt < 1) or (rec_len != 0x5a):
+			raise RuntimeError('Bad card type')
+
+		return rec_cnt, rec_len
+
+	def program(self, p):
+		# Home PLMN
+		r = self._scc.select_file(['3f00', '7f20', '6f30'])
+		tl = int(r[-1][4:8], 16)
+
+		hplmn = self._e_plmn(p['mcc'], p['mnc'])
+		self._scc.update_binary('6f30', hplmn + 'ff' * (tl-3))
+
+		# Get total number of entries and entry size
+		rec_cnt, rec_len = self._get_infos()
+
+		# Set first entry
+		entry = (
+			'81' +								#  1b  Status: Valid & Active
+			rpad(b2h(p['name'][0:14]), 28) +	# 14b  Entry Name
+			self._e_iccid(p['iccid']) +			# 10b  ICCID
+			self._e_imsi(p['imsi']) +			#  9b  IMSI_len + id_type(9) + IMSI
+			p['ki'] +							# 16b  Ki
+			24*'f' + 'fd' + 24*'f' +			# 25b  (unknown ...)
+			rpad(p['smsp'], 20) +				# 10b  SMSP (padded with ff if needed)
+			10*'f'								#  5b  (unknown ...)
+		)
+		self._scc.update_record('000c', 1, entry)
+
+	def erase(self):
+		# Get total number of entries and entry size
+		rec_cnt, rec_len = self._get_infos()
+
+		# Erase all entries
+		entry = 'ff' * rec_len
+		for i in range(0, rec_cnt):
+			self._scc.update_record('000c', 1+i, entry)
+
+
+	# In order for autodetection ...
+_cards_classes = [ FakeMagicSim, SuperSim, MagicSim ]