__init__.py

# This file is part of the sos project: https://github.com/sosreport/sos
#
# This copyrighted material is made available to anyone wishing to use,
# modify, copy, or redistribute it subject to the terms and conditions of
# version 2 of the GNU General Public License.
#
# See the LICENSE file in the source distribution for further information.

# pylint: disable=no-member

import re

class SoSCleanerParser():
    """Parsers are used to build objects that will take a line as input,
    parse it for a particular pattern (E.G. IP addresses) and then make any
    necessary subtitutions by referencing the SoSMap() associated with the
    parser.

Ideally a new parser subclass will only need to set the class level attrs
    in order to be fully functional.

:param conf_file: The configuration file to read from
    :type conf_file: ``str``

:cvar name:     The parser name, used in logging errors
    :vartype name: ``str``

:cvar regex_pattern:   A static (compiled) regex pattern to check for every
                           line processed
    :vartype regex_pattern: ``re.Pattern``

:cvar mapping: Used by the parser to store and obfuscate matches
    :vartype mapping: ``SoSMap()``

:cvar map_file_key: The key in the ``map_file`` to read when loading
                        previous obfuscation matches
    :vartype map_file_key: ``str``
    """

name = 'Undefined Parser'
    regex_pattern = re.compile(r'(?!)')  # match nothing
    skip_line_patterns = []
    parser_skip_files = []  # list of skip files relevant to a parser
    skip_cleaning_files = []   # list of global skip files from cmdline args
    map_file_key = 'unset'
    compile_regexes = True

def __init__(self, config={}, skip_cleaning_files=[]):
        if self.map_file_key in config:
            self.mapping.conf_update(config[self.map_file_key])
        self.skip_cleaning_files = skip_cleaning_files
        self._generate_skip_regexes()

def load_map_entries(self):
        self.mapping.load_entries()

def _generate_skip_regexes(self):
        """Generate the regexes for the parser's configured parser_skip_files
        or global skip_cleaning_files, so that we don't regenerate them on
        every file being examined for if the parser should skip a given file.
        """
        self.skip_patterns = []
        for p in self.parser_skip_files + self.skip_cleaning_files:
            self.skip_patterns.append(re.compile(p))

def generate_item_regexes(self):
        """Generate regexes for items the parser will be searching for
        repeatedly without needing to generate them for every file and/or line
        we process

Not used by all parsers.
        """
        if not self.compile_regexes:
            return
        self.mapping.initializing = True
        for obitem in self.mapping.dataset:
            self.mapping.add_regex_item(obitem)
        self.mapping.initializing = False
        self.mapping.generate_compiled_regexes()

def parse_line(self, line):
        """This will be called for every line in every file we process, so that
        every parser has a chance to scrub everything.

This will first try to identify needed obfuscations for items we have
        already encountered (if the parser uses compiled regexes that is) and
        make those substitutions early on. After which, we will then parse the
        line again looking for new matches.
        """
        count = 0
        for skip_pattern in self.skip_line_patterns:
            if re.match(skip_pattern, line, re.I):
                return line, count
        if self.compile_regexes:
            line, _rcount = self._parse_line_with_compiled_regexes(line)
            count += _rcount
        line, _count = self._parse_line(line)
        count += _count
        return line, count

def _parse_line_with_compiled_regexes(self, line):
        """Check the provided line against known items we have encountered
        before and have pre-generated regex Pattern() objects for.

:param line:    The line to parse for possible matches for obfuscation
        :type line:     ``str``

:returns:   The obfuscated line and the number of changes made
        :rtype:     ``str``, ``int``
        """
        count = 0
        for item, reg in self.mapping.get_matched_items(line):
            if self.mapping.use_token_lookup or reg.search(line):
                line, _count = reg.subn(self.mapping.get(item), line)
                count += _count
                # break the cycle if no further search can apply;
                # token-lookup parsers don't maintain compiled_search so
                # we rely on get_matched_items() exhausting its results
                if not self.mapping.use_token_lookup and \
                        not self.mapping.compiled_search.search(line):
                    break
        return line, count

def _parse_line(self, line):
        """Check the provided line against the parser regex patterns to try
        and discover _new_ items to obfuscate

:param line: The line to parse for possible matches for obfuscation
        :type line: ``str``

:returns: The obfsucated line, and the number of changes made
        :rtype: ``tuple``, ``(str, int))``
        """
        count = 0
        matches = [m[0] for m in self.regex_pattern.findall(line)]
        if matches:
            matches.sort(reverse=True, key=len)
            count += len(matches)
            for match in matches:
                match = match.strip()
                if match in self.mapping.dataset.values():
                    continue
                new_match = self.mapping.get(match)
                if new_match != match:
                    line = line.replace(match, new_match)
        return line, count

def parse_string_for_keys(self, string_data):
        """Parse a given string for instances of any obfuscated items, without
        applying the normal regex comparisons first. This is mainly used to
        obfuscate filenames that have, for example, hostnames in them.

Rather than try to regex match the string_data, just use the builtin
        checks for substrings matching known obfuscated keys

:param string_data: The line to be parsed
        :type string_data: ``str``

:returns: The obfuscated line
        :rtype: ``str``
        """
        if self.compile_regexes:
            for item, reg in self.mapping.get_matched_items(string_data):
                if self.mapping.use_token_lookup or reg.search(string_data):
                    string_data = reg.sub(self.mapping.get(item), string_data)
        else:
            for k, ob in sorted(self.mapping.dataset.items(), reverse=True,
                                key=lambda x: len(x[0])):
                if k in self.mapping.skip_keys:
                    continue
                if k in string_data:
                    string_data = string_data.replace(k, ob)
        return string_data

def get_map_contents(self):
        """Get the contents of the mapping used by the parser

:returns: All matches and their obfuscate counterparts
        :rtype: ``dict``
        """
        return self.mapping.dataset

docroot: /home/induvedam/public_html

curdir: /lib/python3.9/site-packages/sos/cleaner/parsers

	.	184
	..	107
X	__init__.py	7317
	__pycache__	4096
X	hostname_parser.py	1642
X	ip_parser.py	1758
X	ipv6_parser.py	2839
X	keyword_parser.py	910
X	mac_parser.py	3136
X	username_parser.py	1309