public/pysim
1
0
Fork 1
mirror of https://gitea.osmocom.org/sim-card/pysim.git synced 2026-04-01 11:11:03 +03:00
Code Issues Packages Projects Releases Wiki Activity

filesystem: Introduce support for TLV parser

Browse Source 
This adds an easy way for files to make use of the pySim.tlv parser.

All a file has to do is to specify a _tlv member which points to
either a TLV_IE or a TLV_IE_Collection instance.

Change-Id: I59f456b4223ec88081e91cee168b654c69bcb5f4
This commit is contained in:
Harald Welte
2021-05-29 21:28:24 +02:00
parent bb3b5df8bf
commit fb50621570
2 changed files with 40 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

38
pySim/filesystem.py
View File

@@ -468,6 +468,7 @@ class TransparentEF(CardEF):
""" """
super().__init__(fid=fid, sfid=sfid, name=name, desc=desc, parent=parent) super().__init__(fid=fid, sfid=sfid, name=name, desc=desc, parent=parent)
self._construct = None self._construct = None
self._tlv = None
self.size = size self.size = size
self.shell_commands = [self.ShellCommands()] self.shell_commands = [self.ShellCommands()]
@@ -491,6 +492,9 @@ class TransparentEF(CardEF):
return method(b2h(raw_bin_data)) return method(b2h(raw_bin_data))
if self._construct: if self._construct:
return parse_construct(self._construct, raw_bin_data) return parse_construct(self._construct, raw_bin_data)
elif self._tlv:
self._tlv.from_tlv(raw_bin_data)
return self._tlv.to_dict()
return {'raw': raw_bin_data.hex()} return {'raw': raw_bin_data.hex()}
def decode_hex(self, raw_hex_data:str) -> dict: def decode_hex(self, raw_hex_data:str) -> dict:
@@ -514,6 +518,9 @@ class TransparentEF(CardEF):
return method(raw_bin_data) return method(raw_bin_data)
if self._construct: if self._construct:
return parse_construct(self._construct, raw_bin_data) return parse_construct(self._construct, raw_bin_data)
elif self._tlv:
self._tlv.from_tlv(raw_bin_data)
return self._tlv.to_dict()
return {'raw': raw_bin_data.hex()} return {'raw': raw_bin_data.hex()}
def encode_bin(self, abstract_data:dict) -> bytearray: def encode_bin(self, abstract_data:dict) -> bytearray:
@@ -536,6 +543,9 @@ class TransparentEF(CardEF):
return h2b(method(abstract_data)) return h2b(method(abstract_data))
if self._construct: if self._construct:
return self._construct.build(abstract_data) return self._construct.build(abstract_data)
elif self._tlv:
self._tlv.from_dict(abstract_data)
return self._tlv.to_tlv()
raise NotImplementedError raise NotImplementedError
def encode_hex(self, abstract_data:dict) -> str: def encode_hex(self, abstract_data:dict) -> str:
@@ -559,6 +569,9 @@ class TransparentEF(CardEF):
return b2h(raw_bin_data) return b2h(raw_bin_data)
if self._construct: if self._construct:
return b2h(self._construct.build(abstract_data)) return b2h(self._construct.build(abstract_data))
elif self._tlv:
self._tlv.from_dict(abstract_data)
return b2h(self._tlv.to_tlv())
raise NotImplementedError raise NotImplementedError
@@ -691,6 +704,7 @@ class LinFixedEF(CardEF):
self.rec_len = rec_len self.rec_len = rec_len
self.shell_commands = [self.ShellCommands()] self.shell_commands = [self.ShellCommands()]
self._construct = None self._construct = None
self._tlv = None
def decode_record_hex(self, raw_hex_data:str) -> dict: def decode_record_hex(self, raw_hex_data:str) -> dict:
"""Decode raw (hex string) data into abstract representation. """Decode raw (hex string) data into abstract representation.
@@ -713,6 +727,9 @@ class LinFixedEF(CardEF):
return method(raw_bin_data) return method(raw_bin_data)
if self._construct: if self._construct:
return parse_construct(self._construct, raw_bin_data) return parse_construct(self._construct, raw_bin_data)
elif self._tlv:
self._tlv.from_tlv(raw_bin_data)
return self._tlv.to_dict()
return {'raw': raw_bin_data.hex()} return {'raw': raw_bin_data.hex()}
def decode_record_bin(self, raw_bin_data:bytearray) -> dict: def decode_record_bin(self, raw_bin_data:bytearray) -> dict:
@@ -736,6 +753,9 @@ class LinFixedEF(CardEF):
return method(raw_hex_data) return method(raw_hex_data)
if self._construct: if self._construct:
return parse_construct(self._construct, raw_bin_data) return parse_construct(self._construct, raw_bin_data)
elif self._tlv:
self._tlv.from_tlv(raw_bin_data)
return self._tlv.to_dict()
return {'raw': raw_hex_data} return {'raw': raw_hex_data}
def encode_record_hex(self, abstract_data:dict) -> str: def encode_record_hex(self, abstract_data:dict) -> str:
@@ -759,6 +779,9 @@ class LinFixedEF(CardEF):
return b2h(raw_bin_data) return b2h(raw_bin_data)
if self._construct: if self._construct:
return b2h(self._construct.build(abstract_data)) return b2h(self._construct.build(abstract_data))
elif self._tlv:
self._tlv.from_dict(abstract_data)
return b2h(self._tlv.to_tlv())
raise NotImplementedError raise NotImplementedError
def encode_record_bin(self, abstract_data:dict) -> bytearray: def encode_record_bin(self, abstract_data:dict) -> bytearray:
@@ -781,6 +804,9 @@ class LinFixedEF(CardEF):
return h2b(method(abstract_data)) return h2b(method(abstract_data))
if self._construct: if self._construct:
return self._construct.build(abstract_data) return self._construct.build(abstract_data)
elif self._tlv:
self._tlv.from_dict(abstract_data)
return self._tlv.to_tlv()
raise NotImplementedError raise NotImplementedError
class CyclicEF(LinFixedEF): class CyclicEF(LinFixedEF):
@@ -835,6 +861,9 @@ class TransRecEF(TransparentEF):
return method(raw_bin_data) return method(raw_bin_data)
if self._construct: if self._construct:
return parse_construct(self._construct, raw_bin_data) return parse_construct(self._construct, raw_bin_data)
elif self._tlv:
self._tlv.from_tlv(raw_bin_data)
return self._tlv.to_dict()
return {'raw': raw_hex_data} return {'raw': raw_hex_data}
def decode_record_bin(self, raw_bin_data:bytearray) -> dict: def decode_record_bin(self, raw_bin_data:bytearray) -> dict:
@@ -858,6 +887,9 @@ class TransRecEF(TransparentEF):
return method(raw_hex_data) return method(raw_hex_data)
if self._construct: if self._construct:
return parse_construct(self._construct, raw_bin_data) return parse_construct(self._construct, raw_bin_data)
elif self._tlv:
self._tlv.from_tlv(raw_bin_data)
return self._tlv.to_dict()
return {'raw': raw_hex_data} return {'raw': raw_hex_data}
def encode_record_hex(self, abstract_data:dict) -> str: def encode_record_hex(self, abstract_data:dict) -> str:
@@ -880,6 +912,9 @@ class TransRecEF(TransparentEF):
return b2h(method(abstract_data)) return b2h(method(abstract_data))
if self._construct: if self._construct:
return b2h(filter_dict(self._construct.build(abstract_data))) return b2h(filter_dict(self._construct.build(abstract_data)))
elif self._tlv:
self._tlv.from_dict(abstract_data)
return b2h(self._tlv.to_tlv())
raise NotImplementedError raise NotImplementedError
def encode_record_bin(self, abstract_data:dict) -> bytearray: def encode_record_bin(self, abstract_data:dict) -> bytearray:
@@ -902,6 +937,9 @@ class TransRecEF(TransparentEF):
return h2b(method(abstract_data)) return h2b(method(abstract_data))
if self._construct: if self._construct:
return filter_dict(self._construct.build(abstract_data)) return filter_dict(self._construct.build(abstract_data))
elif self._tlv:
self._tlv.from_dict(abstract_data)
return self._tlv.to_tlv()
raise NotImplementedError raise NotImplementedError
def _decode_bin(self, raw_bin_data:bytearray): def _decode_bin(self, raw_bin_data:bytearray):

2
pySim/tlv.py
View File

@@ -338,6 +338,8 @@ class TLV_IE_Collection(metaclass=TlvCollectionMeta):
while len(remainder): while len(remainder):
# obtain the tag at the start of the remainder # obtain the tag at the start of the remainder
tag, r = first._parse_tag_raw(remainder) tag, r = first._parse_tag_raw(remainder)
if tag == None:
return res
if tag in self.members_by_tag: if tag in self.members_by_tag:
cls = self.members_by_tag[tag] cls = self.members_by_tag[tag]
# create an instance and parse accordingly # create an instance and parse accordingly