# -*- coding: utf-8 -*-
"""The Viper analysis plugin CLI arguments helper."""
from plaso.analysis import viper
from plaso.cli.helpers import interface
from plaso.cli.helpers import manager
from plaso.lib import errors
[docs]
class ViperAnalysisArgumentsHelper(interface.ArgumentsHelper):
"""Viper analysis plugin CLI arguments helper."""
NAME = 'viper'
CATEGORY = 'analysis'
DESCRIPTION = 'Argument helper for the Viper analysis plugin.'
_DEFAULT_HASH = 'sha256'
_DEFAULT_HOST = 'localhost'
_DEFAULT_PORT = 8080
_DEFAULT_PROTOCOL = 'http'
_SUPPORTED_HASHES = sorted(viper.ViperAnalysisPlugin.SUPPORTED_HASHES)
_SUPPORTED_PROTOCOLS = sorted(viper.ViperAnalysisPlugin.SUPPORTED_PROTOCOLS)
[docs]
@classmethod
def AddArguments(cls, argument_group):
"""Adds command line arguments the helper supports to an argument group.
This function takes an argument parser or an argument group object and adds
to it all the command line arguments this helper supports.
Args:
argument_group (argparse._ArgumentGroup|argparse.ArgumentParser):
argparse group.
"""
supported_hashes = ', '.join(cls._SUPPORTED_HASHES)
argument_group.add_argument(
'--viper-hash', '--viper_hash', dest='viper_hash', type=str,
action='store', choices=cls._SUPPORTED_HASHES,
default=cls._DEFAULT_HASH, metavar='HASH', help=(
f'Type of hash to use to query the Viper server, the default is: '
f'{cls._DEFAULT_HASH:s}. Supported options: {supported_hashes:s}'))
argument_group.add_argument(
'--viper-host', '--viper_host', dest='viper_host', type=str,
action='store', default=cls._DEFAULT_HOST, metavar='HOST', help=(
f'Hostname of the Viper server to query, the default is: '
f'{cls._DEFAULT_HOST:s}'))
argument_group.add_argument(
'--viper-port', '--viper_port', dest='viper_port', type=int,
action='store', default=cls._DEFAULT_PORT, metavar='PORT', help=(
f'Port of the Viper server to query, the default is: '
f'{cls._DEFAULT_PORT:d}.'))
supported_protocols = ', '.join(cls._SUPPORTED_PROTOCOLS)
argument_group.add_argument(
'--viper-protocol', '--viper_protocol', dest='viper_protocol',
type=str, choices=cls._SUPPORTED_PROTOCOLS, action='store',
default=cls._DEFAULT_PROTOCOL, metavar='PROTOCOL', help=(
f'Protocol to use to query Viper, the default is: '
f'{cls._DEFAULT_PROTOCOL:s}. Supported options: '
f'{supported_protocols:s}'))
[docs]
@classmethod
def ParseOptions(cls, options, analysis_plugin): # pylint: disable=arguments-renamed
"""Parses and validates options.
Args:
options (argparse.Namespace): parser options.
analysis_plugin (ViperAnalysisPlugin): analysis plugin to configure.
Raises:
BadConfigObject: when the output module object is of the wrong type.
BadConfigOption: when unable to connect to Viper instance.
"""
if not isinstance(analysis_plugin, viper.ViperAnalysisPlugin):
raise errors.BadConfigObject(
'Analysis plugin is not an instance of ViperAnalysisPlugin')
lookup_hash = cls._ParseStringOption(
options, 'viper_hash', default_value=cls._DEFAULT_HASH)
analysis_plugin.SetLookupHash(lookup_hash)
host = cls._ParseStringOption(
options, 'viper_host', default_value=cls._DEFAULT_HOST)
analysis_plugin.SetHost(host)
port = cls._ParseNumericOption(
options, 'viper_port', default_value=cls._DEFAULT_PORT)
analysis_plugin.SetPort(port)
protocol = cls._ParseStringOption(
options, 'viper_protocol', default_value=cls._DEFAULT_PROTOCOL)
protocol = protocol.lower().strip()
analysis_plugin.SetProtocol(protocol)
if not analysis_plugin.TestConnection():
raise errors.BadConfigOption(
f'Unable to connect to Viper {host:s}:{port:d}')
manager.ArgumentHelperManager.RegisterHelper(ViperAnalysisArgumentsHelper)