<p>Vadim Yanitskiy <strong>merged</strong> this change.</p><p><a href="https://gerrit.osmocom.org/11480">View Change</a></p><div style="white-space:pre-wrap">Approvals:
Jenkins Builder: Verified
Harald Welte: Looks good to me, but someone else must approve
tnt: Looks good to me, approved
</div><pre style="font-family: monospace,monospace; white-space: pre-wrap;">pySim/transport: introduce Calypso based reader interface<br><br>This interface allows to use a Calypso based phone (e.g. Motorola<br>C1XX) as a SIM card reader. It basically implements a few L1CTL<br>messages that are used to interact with the SIM card through<br>the OsmocomBB 'layer1' firmware.<br><br>Please note, that this is an experimental implementation, and<br>there is a risk that SIM programming would fail. Nevertheless,<br>I've managed to program and read one of my SIMs a few times.<br><br>Change-Id: Iec8101140581bf9e2cf7cf3a0b54bdf1875fc51b<br>---<br>M pySim/exceptions.py<br>A pySim/transport/calypso.py<br>2 files changed, 160 insertions(+), 0 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/pySim/exceptions.py b/pySim/exceptions.py</span><br><span>index 403f54c..831b1c9 100644</span><br><span>--- a/pySim/exceptions.py</span><br><span>+++ b/pySim/exceptions.py</span><br><span>@@ -31,3 +31,6 @@</span><br><span> </span><br><span> class ProtocolError(exceptions.Exception):</span><br><span> pass</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+class ReaderError(exceptions.Exception):</span><br><span style="color: hsl(120, 100%, 40%);">+ pass</span><br><span>diff --git a/pySim/transport/calypso.py b/pySim/transport/calypso.py</span><br><span>new file mode 100644</span><br><span>index 0000000..fd501b5</span><br><span>--- /dev/null</span><br><span>+++ b/pySim/transport/calypso.py</span><br><span>@@ -0,0 +1,157 @@</span><br><span style="color: hsl(120, 100%, 40%);">+#!/usr/bin/env python</span><br><span style="color: hsl(120, 100%, 40%);">+# -*- coding: utf-8 -*-</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+""" pySim: Transport Link for Calypso bases phones</span><br><span style="color: hsl(120, 100%, 40%);">+"""</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+#</span><br><span style="color: hsl(120, 100%, 40%);">+# Copyright (C) 2018 Vadim Yanitskiy <axilirator@gmail.com></span><br><span style="color: hsl(120, 100%, 40%);">+#</span><br><span style="color: hsl(120, 100%, 40%);">+# This program is free software: you can redistribute it and/or modify</span><br><span style="color: hsl(120, 100%, 40%);">+# it under the terms of the GNU General Public License as published by</span><br><span style="color: hsl(120, 100%, 40%);">+# the Free Software Foundation, either version 2 of the License, or</span><br><span style="color: hsl(120, 100%, 40%);">+# (at your option) any later version.</span><br><span style="color: hsl(120, 100%, 40%);">+#</span><br><span style="color: hsl(120, 100%, 40%);">+# This program is distributed in the hope that it will be useful,</span><br><span style="color: hsl(120, 100%, 40%);">+# but WITHOUT ANY WARRANTY; without even the implied warranty of</span><br><span style="color: hsl(120, 100%, 40%);">+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span><br><span style="color: hsl(120, 100%, 40%);">+# GNU General Public License for more details.</span><br><span style="color: hsl(120, 100%, 40%);">+#</span><br><span style="color: hsl(120, 100%, 40%);">+# You should have received a copy of the GNU General Public License</span><br><span style="color: hsl(120, 100%, 40%);">+# along with this program. If not, see <http://www.gnu.org/licenses/>.</span><br><span style="color: hsl(120, 100%, 40%);">+#</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+from __future__ import absolute_import</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+import select</span><br><span style="color: hsl(120, 100%, 40%);">+import struct</span><br><span style="color: hsl(120, 100%, 40%);">+import socket</span><br><span style="color: hsl(120, 100%, 40%);">+import os</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+from pySim.transport import LinkBase</span><br><span style="color: hsl(120, 100%, 40%);">+from pySim.exceptions import *</span><br><span style="color: hsl(120, 100%, 40%);">+from pySim.utils import h2b, b2h</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+class L1CTLMessage(object):</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ # Every (encoded) L1CTL message has the following structure:</span><br><span style="color: hsl(120, 100%, 40%);">+ # - msg_length (2 bytes, net order)</span><br><span style="color: hsl(120, 100%, 40%);">+ # - l1ctl_hdr (packed structure)</span><br><span style="color: hsl(120, 100%, 40%);">+ # - msg_type</span><br><span style="color: hsl(120, 100%, 40%);">+ # - flags</span><br><span style="color: hsl(120, 100%, 40%);">+ # - padding (2 spare bytes)</span><br><span style="color: hsl(120, 100%, 40%);">+ # - ... payload ...</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ def __init__(self, msg_type, flags = 0x00):</span><br><span style="color: hsl(120, 100%, 40%);">+ # Init L1CTL message header</span><br><span style="color: hsl(120, 100%, 40%);">+ self.data = struct.pack("BBxx", msg_type, flags)</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ def gen_msg(self):</span><br><span style="color: hsl(120, 100%, 40%);">+ return struct.pack("!H", len(self.data)) + self.data</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+class L1CTLMessageReset(L1CTLMessage):</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ # L1CTL message types</span><br><span style="color: hsl(120, 100%, 40%);">+ L1CTL_RESET_REQ = 0x0d</span><br><span style="color: hsl(120, 100%, 40%);">+ L1CTL_RESET_IND = 0x07</span><br><span style="color: hsl(120, 100%, 40%);">+ L1CTL_RESET_CONF = 0x0e</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ # Reset types</span><br><span style="color: hsl(120, 100%, 40%);">+ L1CTL_RES_T_BOOT = 0x00</span><br><span style="color: hsl(120, 100%, 40%);">+ L1CTL_RES_T_FULL = 0x01</span><br><span style="color: hsl(120, 100%, 40%);">+ L1CTL_RES_T_SCHED = 0x02</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ def __init__(self, type = L1CTL_RES_T_FULL):</span><br><span style="color: hsl(120, 100%, 40%);">+ super(L1CTLMessageReset, self).__init__(self.L1CTL_RESET_REQ)</span><br><span style="color: hsl(120, 100%, 40%);">+ self.data += struct.pack("Bxxx", type)</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+class L1CTLMessageSIM(L1CTLMessage):</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ # SIM related message types</span><br><span style="color: hsl(120, 100%, 40%);">+ L1CTL_SIM_REQ = 0x16</span><br><span style="color: hsl(120, 100%, 40%);">+ L1CTL_SIM_CONF = 0x17</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ def __init__(self, pdu):</span><br><span style="color: hsl(120, 100%, 40%);">+ super(L1CTLMessageSIM, self).__init__(self.L1CTL_SIM_REQ)</span><br><span style="color: hsl(120, 100%, 40%);">+ self.data += pdu</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+class CalypsoSimLink(LinkBase):</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ def __init__(self, sock_path = "/tmp/osmocom_l2"):</span><br><span style="color: hsl(120, 100%, 40%);">+ # Make sure that a given socket path exists</span><br><span style="color: hsl(120, 100%, 40%);">+ if not os.path.exists(sock_path):</span><br><span style="color: hsl(120, 100%, 40%);">+ raise ReaderError("There is no such ('%s') UNIX socket" % sock_path)</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ print("Connecting to osmocon at '%s'..." % sock_path)</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ # Establish a client connection</span><br><span style="color: hsl(120, 100%, 40%);">+ self.sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)</span><br><span style="color: hsl(120, 100%, 40%);">+ self.sock.connect(sock_path)</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ def __del__(self):</span><br><span style="color: hsl(120, 100%, 40%);">+ self.sock.close()</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ def wait_for_rsp(self, exp_len = 128):</span><br><span style="color: hsl(120, 100%, 40%);">+ # Wait for incoming data (timeout is 3 seconds)</span><br><span style="color: hsl(120, 100%, 40%);">+ s, _, _ = select.select([self.sock], [], [], 3.0)</span><br><span style="color: hsl(120, 100%, 40%);">+ if not s:</span><br><span style="color: hsl(120, 100%, 40%);">+ raise ReaderError("Timeout waiting for card response")</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ # Receive expected amount of bytes from osmocon</span><br><span style="color: hsl(120, 100%, 40%);">+ rsp = self.sock.recv(exp_len)</span><br><span style="color: hsl(120, 100%, 40%);">+ return rsp</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ def reset_card(self):</span><br><span style="color: hsl(120, 100%, 40%);">+ # Request FULL reset</span><br><span style="color: hsl(120, 100%, 40%);">+ req_msg = L1CTLMessageReset()</span><br><span style="color: hsl(120, 100%, 40%);">+ self.sock.send(req_msg.gen_msg())</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ # Wait for confirmation</span><br><span style="color: hsl(120, 100%, 40%);">+ rsp = self.wait_for_rsp()</span><br><span style="color: hsl(120, 100%, 40%);">+ rsp_msg = struct.unpack_from("!HB", rsp)</span><br><span style="color: hsl(120, 100%, 40%);">+ if rsp_msg[1] != L1CTLMessageReset.L1CTL_RESET_CONF:</span><br><span style="color: hsl(120, 100%, 40%);">+ raise ReaderError("Failed to reset Calypso PHY")</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ def connect(self):</span><br><span style="color: hsl(120, 100%, 40%);">+ self.reset_card()</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ def disconnect(self):</span><br><span style="color: hsl(120, 100%, 40%);">+ pass # Nothing to do really ...</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ def wait_for_card(self, timeout = None, newcardonly = False):</span><br><span style="color: hsl(120, 100%, 40%);">+ pass # Nothing to do really ...</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ def send_apdu_raw(self, pdu):</span><br><span style="color: hsl(120, 100%, 40%);">+ """see LinkBase.send_apdu_raw"""</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ # Request FULL reset</span><br><span style="color: hsl(120, 100%, 40%);">+ req_msg = L1CTLMessageSIM(h2b(pdu))</span><br><span style="color: hsl(120, 100%, 40%);">+ self.sock.send(req_msg.gen_msg())</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ # Read message length first</span><br><span style="color: hsl(120, 100%, 40%);">+ rsp = self.wait_for_rsp(struct.calcsize("!H"))</span><br><span style="color: hsl(120, 100%, 40%);">+ msg_len = struct.unpack_from("!H", rsp)[0]</span><br><span style="color: hsl(120, 100%, 40%);">+ if msg_len < struct.calcsize("BBxx"):</span><br><span style="color: hsl(120, 100%, 40%);">+ raise ReaderError("Missing L1CTL header for L1CTL_SIM_CONF")</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ # Read the whole message then</span><br><span style="color: hsl(120, 100%, 40%);">+ rsp = self.sock.recv(msg_len)</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ # Verify L1CTL header</span><br><span style="color: hsl(120, 100%, 40%);">+ hdr = struct.unpack_from("BBxx", rsp)</span><br><span style="color: hsl(120, 100%, 40%);">+ if hdr[0] != L1CTLMessageSIM.L1CTL_SIM_CONF:</span><br><span style="color: hsl(120, 100%, 40%);">+ raise ReaderError("Unexpected L1CTL message received")</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ # Verify the payload length</span><br><span style="color: hsl(120, 100%, 40%);">+ offset = struct.calcsize("BBxx")</span><br><span style="color: hsl(120, 100%, 40%);">+ if len(rsp) <= offset:</span><br><span style="color: hsl(120, 100%, 40%);">+ raise ProtocolError("Empty response from SIM?!?")</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ # Omit L1CTL header</span><br><span style="color: hsl(120, 100%, 40%);">+ rsp = rsp[offset:]</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ # Unpack data and SW</span><br><span style="color: hsl(120, 100%, 40%);">+ data = rsp[:-2]</span><br><span style="color: hsl(120, 100%, 40%);">+ sw = rsp[-2:]</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ return b2h(data), b2h(sw)</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.osmocom.org/11480">change 11480</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://gerrit.osmocom.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://gerrit.osmocom.org/11480"/><meta itemprop="name" content="View Change"/></div></div>
<div style="display:none"> Gerrit-Project: pysim </div>
<div style="display:none"> Gerrit-Branch: master </div>
<div style="display:none"> Gerrit-MessageType: merged </div>
<div style="display:none"> Gerrit-Change-Id: Iec8101140581bf9e2cf7cf3a0b54bdf1875fc51b </div>
<div style="display:none"> Gerrit-Change-Number: 11480 </div>
<div style="display:none"> Gerrit-PatchSet: 3 </div>
<div style="display:none"> Gerrit-Owner: Vadim Yanitskiy <axilirator@gmail.com> </div>
<div style="display:none"> Gerrit-Assignee: tnt <tnt@246tNt.com> </div>
<div style="display:none"> Gerrit-Reviewer: Harald Welte <laforge@gnumonks.org> </div>
<div style="display:none"> Gerrit-Reviewer: Jenkins Builder (1000002) </div>
<div style="display:none"> Gerrit-Reviewer: Vadim Yanitskiy <axilirator@gmail.com> </div>
<div style="display:none"> Gerrit-Reviewer: tnt <tnt@246tNt.com> </div>