"""Text parser plugin for iOS lockdown daemon log files (ios_lockdownd.log)."""
import pyparsing
from dfdatetime import time_elements as dfdatetime_time_elements
from plaso.containers import events
from plaso.lib import errors
from plaso.parsers import text_parser
from plaso.parsers.text_plugins import interface
[docs]
class IOSLockdowndLogData(events.EventData):
"""iOS lockdown daemon (lockdownd) log event data.
Attributes:
body (str): body of the log entry.
process_identifier (int): identifier of the process making the request to
lockdownd.
written_time (dfdatetime.DateTimeValues): date and time the log entry was
written.
"""
DATA_TYPE = "ios:lockdownd_log:entry"
[docs]
def __init__(self):
"""Initializes event data."""
super().__init__(data_type=self.DATA_TYPE)
self.body = None
self.process_identifier = None
self.written_time = None
[docs]
class IOSLockdowndLogTextPlugin(interface.TextPluginWithLineContinuation):
"""Text parser plugin for iOS lockdown daemon log files."""
NAME = "ios_lockdownd"
DATA_FORMAT = "iOS lockdown daemon log"
_INTEGER = pyparsing.Word(pyparsing.nums).set_parse_action(
lambda tokens: int(tokens[0], 10)
)
_TWO_DIGITS = pyparsing.Word(pyparsing.nums, exact=2).set_parse_action(
lambda tokens: int(tokens[0], 10)
)
_SIX_DIGITS = pyparsing.Word(pyparsing.nums, exact=6).set_parse_action(
lambda tokens: int(tokens[0], 10)
)
_END_OF_LINE = pyparsing.Suppress(pyparsing.LineEnd())
# Date and time values are formatted as: MM/DD/YY hh:mm:ss:######
# For example: 10/13/21 07:57:42.865446
_DATE_TIME = (
_TWO_DIGITS
+ pyparsing.Suppress("/")
+ _TWO_DIGITS
+ pyparsing.Suppress("/")
+ _TWO_DIGITS
+ _TWO_DIGITS
+ pyparsing.Suppress(":")
+ _TWO_DIGITS
+ pyparsing.Suppress(":")
+ _TWO_DIGITS
+ pyparsing.Word(".,", exact=1).suppress()
+ _SIX_DIGITS
)
_LOG_LINE_START = (
_DATE_TIME.set_results_name("date_time")
+ pyparsing.Suppress("pid=")
+ _INTEGER.set_results_name("process_identifier")
)
_LOG_LINE = (
_LOG_LINE_START + pyparsing.restOfLine().set_results_name("body") + _END_OF_LINE
)
_LINE_STRUCTURES = [("log_line", _LOG_LINE)]
VERIFICATION_GRAMMAR = _LOG_LINE
[docs]
def __init__(self):
"""Initializes a text parser plugin."""
super().__init__()
self._body_lines = None
self._event_data = None
def _ParseFinalize(self, parser_mediator):
"""Finalizes parsing.
Args:
parser_mediator (ParserMediator): mediates interactions between parsers
and other components, such as storage and dfVFS.
"""
if self._event_data:
self._event_data.body = " ".join(self._body_lines)
self._body_lines = None
parser_mediator.ProduceEventData(self._event_data)
self._event_data = None
def _ParseLogline(self, structure):
"""Parses a log line.
Args:
structure (pyparsing.ParseResults): structure of tokens derived from
a line of a text file.
"""
time_elements_structure = self._GetValueFromStructure(structure, "date_time")
body = self._GetValueFromStructure(structure, "body", default_value="")
event_data = IOSLockdowndLogData()
event_data.process_identifier = self._GetValueFromStructure(
structure, "process_identifier"
)
event_data.written_time = self._ParseTimeElements(time_elements_structure)
self._event_data = event_data
self._body_lines = [body.strip()]
def _ParseRecord(self, parser_mediator, key, structure):
"""Parses a pyparsing structure.
Args:
parser_mediator (ParserMediator): mediates interactions between parsers
and other components, such as storage and dfVFS.
key (str): name of the parsed structure.
structure (pyparsing.ParseResults): tokens from a parsed log line.
Raises:
ParseError: if the structure cannot be parsed.
"""
if key == "_line_continuation":
body = structure.replace("\n", " ").strip()
self._body_lines.append(body)
else:
if self._event_data:
self._event_data.body = " ".join(self._body_lines)
parser_mediator.ProduceEventData(self._event_data)
self._ParseLogline(structure)
def _ParseTimeElements(self, time_elements_structure):
"""Parses date and time elements of a log line.
Args:
time_elements_structure (pyparsing.ParseResults): date and time elements
of a log line.
Returns:
dfdatetime.TimeElements: date and time value.
Raises:
ParseError: if a valid date and time value cannot be derived from
the time elements.
"""
try:
month, day_of_month, year, hours, minutes, seconds, microseconds = (
time_elements_structure
)
time_elements_tuple = (
2000 + year,
month,
day_of_month,
hours,
minutes,
seconds,
microseconds,
)
return dfdatetime_time_elements.TimeElementsInMicroseconds(
time_elements_tuple=time_elements_tuple
)
except (IndexError, TypeError, ValueError) as exception:
raise errors.ParseError(
f"Unable to parse time elements with error: {exception!s}"
)
def _ResetState(self):
"""Resets stored values."""
self._body_lines = None
self._event_data = None
[docs]
def CheckRequiredFormat(self, parser_mediator, text_reader):
"""Check if the log record has the minimal structure required by the parser.
Args:
parser_mediator (ParserMediator): mediates interactions between parsers
and other components, such as storage and dfVFS.
text_reader (EncodedTextReader): text reader.
Returns:
bool: True if this is the correct plugin, False otherwise.
"""
try:
structure = self._VerifyString(text_reader.lines)
except errors.ParseError:
return False
time_elements_structure = self._GetValueFromStructure(structure, "date_time")
try:
self._ParseTimeElements(time_elements_structure)
except errors.ParseError:
return False
self._ResetState()
return True
text_parser.TextLogParser.RegisterPlugin(IOSLockdowndLogTextPlugin)