Raise CorruptLogError when NUL bytes are present

Author: beheh

hslog/exceptions.py

@@ -14,6 +14,13 @@ class RegexParsingError(ParsingError):
 	pass
 
 
+class CorruptLogError(ParsingError):
+	"""
+	Raised when a log is obviously corrupt, for example when containing NUL (0x00) bytes.
+	"""
+	pass
+
+
 class ExporterError(Exception):
 	"""
 	Generic exception that happens during PacketTree export.

hslog/parser.py

@@ -9,7 +9,7 @@
 )
 
 from . import packets, tokens
-from .exceptions import ParsingError, RegexParsingError
+from .exceptions import CorruptLogError, ParsingError, RegexParsingError
 from .packets import (
 	Block, Choices, ChosenEntities, CreateGame,
 	MetaData, Packet, PacketTree, SendChoices, SubSpell
@@ -327,6 +327,8 @@ def handle_data(self, ps: ParsingState, ts, data):
 				return
 			ps.current_block.targets.append(entity)
 		else:
+			if "\x00" in data:
+				raise CorruptLogError("Log contains contains a NUL (0x00) byte")
 			raise NotImplementedError(data)
 
 	def handle_power(self, ps: ParsingState, ts, opcode, data):

tests/data.py

@@ -243,3 +243,31 @@
 SHUFFLE_DECK = """
 D 17:21:14.4464414 GameState.DebugPrintPower() -     SHUFFLE_DECK PlayerID=2
 """.strip()
+
+
+CORRUPT_SHOW_ENTITY = """
+D 13:24:38.7829954 GameState.DebugPrintPower() -             SHOW_ENTITY - Updating Entity=9537 CardID=BG21_017
+D 13:24:38.7829954 GameState.DebugPrintPower() -                 tag=CONTROLLER value=11
+D 13:24:38.7829954 GameState.DebugPrintPower() -  \x01\x00\x10\x00\x01 \x10\x00\x03\x00\x10\x00   tag=CARDTYPE value=MINION
+D 13:24:38.7829954 GameState.DebugPrintPower() -                 tag=TAG_LAST_KNOWN_COST_IN_HAND value=4
+D 13:24:38.7829954 GameState.DebugPrintPower() -                 tag=479 value=4
+D 13:24:38.7829954 GameState.DebugPrintPower() -                 tag=COST value=4
+D 13:24:38.7829954 GameState.DebugPrintPower() -                 tag=ATK value=4
+D 13:24:38.7829954 GameState.DebugPrintPower() -                 tag=HEALTH value=4
+D 13:24:38.7829954 GameState.DebugPrintPower() -                 tag=TRIGGER_VISUAL value=1
+D 13:24:38.7829954 GameState.DebugPrintPower() -                 tag=ZONE value=PLAY
+D 13:24:38.7829954 GameState.DebugPrintPower() -                 tag=ENTITY_ID value=9537
+D 13:24:38.7829954 GameState.DebugPrintPower() -                 tag=CARDRACE value=PIRATE
+D 13:24:38.7829954 GameState.DebugPrintPower() -                 tag=CREATOR value=9508
+D 13:24:38.7829954 GameState.DebugPrintPower() -                 tag=1037 value=3
+D 13:24:38.7829954 GameState.DebugPrintPower() -                 tag=1067 value=0
+D 13:24:38.7829954 GameState.DebugPrintPower() -                 tag=1068 value=0
+D 13:24:38.7829954 GameState.DebugPrintPower() -                 tag=CREATOR_DBID value=72230
+D 13:24:38.7829954 GameState.DebugPrintPower() -                 tag=1429 value=73951
+D 13:24:38.7829954 GameState.DebugPrintPower() -                 tag=TECH_LEVEL value=3
+D 13:24:38.7829954 GameState.DebugPrintPower() -                 tag=IS_BACON_POOL_MINION value=1
+D 13:24:38.7829954 GameState.DebugPrintPower() -                 tag=SUPPRESS_ALL_SUMMON_VO value=1
+D 13:24:38.7829954 GameState.DebugPrintPower() -                 tag=SPAWN_TIME_COUNT value=1
+D 13:24:38.7829954 GameState.DebugPrintPower() -                 tag=COPIED_FROM_ENTITY_ID value=9531
+D 13:24:38.7829954 GameState.DebugPrintPower() -                 tag=1596 value=1
+""".strip()

tests/test_parser.py

@@ -10,7 +10,7 @@
 )
 
 from hslog import LogParser, packets
-from hslog.exceptions import ParsingError
+from hslog.exceptions import CorruptLogError, ParsingError
 from hslog.parser import parse_initial_tag
 
 from . import data
@@ -516,3 +516,13 @@ def test_shuffle_deck_only(self):
 		shuffle_deck_packet = packet_tree.packets[1]
 
 		assert shuffle_deck_packet.player_id == 2
+
+	def test_nul_byte(self):
+		parser = LogParser()
+		parser.read(StringIO(data.INITIAL_GAME))
+
+		with pytest.raises(
+			CorruptLogError,
+			match=r"Log contains contains a NUL \(0x00\) byte"
+		):
+			parser.read(StringIO(data.CORRUPT_SHOW_ENTITY))