a >hW@sddlZGdddZdS)Nc@sPeZdZdZdZdZddZddZdd Zd d Z d d Z ddZ ddZ dS) SoSPreppera A prepper is a way to prepare loaded mappings with selected items within an sos report prior to beginning the full obfuscation routine. This was previously handled directly within archives, however this is a bit cumbersome and doesn't allow for all the flexibility we could use in this effort. Preppers are separated from parsers but will leverage them in order to feed parser-matched strings from files highlighted by a Prepper() to the appropriate mapping for initial obfuscation. Preppers may specify their own priority in order to influence the order in which mappings are prepped. Further, Preppers have two ways to prepare the maps - either by generating a list of filenames or via directly pulling content out of select files without the assistance of a parser. A lower priority value means the prepper should run sooner than those with higher values. For the former approach, `Prepper._get_$parser_file_list()` should be used and should yield filenames that exist in target archives. For the latter, the `Prepper._get_items_for_$map()` should be used. Finally, a `regex_items` dict is available for storing individual regex items for parsers that rely on them. These items will be added after all files and other individual items are handled. This dict has keys set to parser/mapping names, and the values should be sets of items, so preppers should add to them like so: self.regex_items['hostname'].add('myhostname') Z UndefineddcCsBttttttd|_||_td|_td|_dS)N)hostnameipZipv6keywordZmacusernameZsosZsos_ui)setZ regex_itemsZoptsloggingZ getLoggersoslogZui_log)selfoptionsr A/usr/lib/python3.9/site-packages/sos/cleaner/preppers/__init__.py__init__2s zSoSPrepper.__init__cCsd|jd|S)Nz [prepper:z] )namer msgr r r _fmt_log_msg?szSoSPrepper._fmt_log_msgcCs|j||dSN)r debugrrr r r log_debugBszSoSPrepper.log_debugcCs|j||dSr)r inforrr r rlog_infoEszSoSPrepper.log_infocCs|j||dSr)r errorrrr r r log_errorHszSoSPrepper.log_errorcCs(d|d}t||r$t|||SgS)a Helper that calls the appropriate Prepper method for the specified parser. This allows Preppers to be able to provide items for multiple types of parsers without needing to handle repetitious logic to determine which parser we're interested within each individual call. The convention to use is to define `_get_$parser_file_list()` methods within Preppers, e.g. `_get_hostname_file_list()` would be used to provide filenames for the hostname parser. If such a method is not defined within a Prepper for a given parser, we handle that here so that individual Preppers do not need to. :param parser: The _name_ of the parser to get a file list for :type parser: ``str`` :param archive: The archive we are operating on currently for the specified parser :type archive: ``SoSObfuscationArchive`` :returns: A list of filenames within the archive to prep with :rtype: ``list`` Z_get_Z _file_listhasattrgetattr)r parserarchive_checkr r rget_parser_file_listKs  zSoSPrepper.get_parser_file_listcCs&d|}t||r"t|||SgS)a Similar to `get_parser_file_list()`, a helper for calling the specific method for generating items for the given `map`. This allows Preppers to be able to provide items for multiple types of maps, without the need to handle repetitious logic to determine which parser we're interested in within each individual call. :param mapping: The _name_ of the mapping to get items for :type mapping: ``str`` :param archive: The archive we are operating on currently for the specified parser :type archive: ``SoSObfuscationArchive`` :returns: A list of distinct items to obfuscate without using a parser :rtype: ``list`` Z_get_items_for_r)r mappingrr r r rget_items_for_mapgs  zSoSPrepper.get_items_for_mapN) __name__ __module__ __qualname____doc__rpriorityrrrrrr!r#r r r rrs  r)r rr r r r s