Source code for plaso.formatters.utmp

# -*- coding: utf-8 -*-
"""The UTMP binary file event formatter."""

from __future__ import unicode_literals

from plaso.formatters import interface
from plaso.formatters import manager
from plaso.lib import errors

[docs]class UtmpSessionFormatter(interface.ConditionalEventFormatter): """Formatter for an UTMP session event.""" DATA_TYPE = 'linux:utmp:event' FORMAT_STRING_PIECES = [ 'User: {username}', 'Hostname: {hostname}', 'Terminal: {terminal}', 'PID: {pid}', 'Terminal identifier: {terminal_identifier}', 'Status: {status}', 'IP Address: {ip_address}', 'Exit status: {exit_status}'] FORMAT_STRING_SHORT_PIECES = [ 'User: {username}', 'PID: {pid}', 'Status: {status}'] SOURCE_LONG = 'UTMP session' SOURCE_SHORT = 'LOG' _STATUS_TYPES = { 0: 'EMPTY', 1: 'RUN_LVL', 2: 'BOOT_TIME', 3: 'NEW_TIME', 4: 'OLD_TIME', 5: 'INIT_PROCESS', 6: 'LOGIN_PROCESS', 7: 'USER_PROCESS', 8: 'DEAD_PROCESS', 9: 'ACCOUNTING'} # pylint: disable=unused-argument
[docs] def GetMessages(self, formatter_mediator, event_data): """Determines the formatted message strings for the event data. Args: formatter_mediator (FormatterMediator): mediates the interactions between formatters and other components, such as storage and Windows EventLog resources. event_data (EventData): event data. Returns: tuple(str, str): formatted message string and short message string. Raises: WrongFormatter: if the event data cannot be formatted by the formatter. """ if self.DATA_TYPE != event_data.data_type: raise errors.WrongFormatter('Unsupported data type: {0:s}.'.format( event_data.data_type)) event_values = event_data.CopyToDict() login_type = event_values.get('type', None) if login_type is None: status = 'N/A' else: status = self._STATUS_TYPES.get(login_type, 'UNKNOWN') event_values['status'] = status return self._ConditionalFormatMessages(event_values)