gvmtools.parser

Complexity

Total Complexity

13

Size/Duplication

Total Lines	246
Duplicated Lines	0 %

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	CliParser.add_protocol_argument()	0	5	1
B	CliParser._add_subparsers()	0	65	1
B	CliParser.__init__()	0	52	2
A	CliParser.add_argument()	0	3	1
A	CliParser._load_config()	0	13	2
A	CliParser.parse_args()	0	19	2

# -*- coding: utf-8 -*-
# Copyright (C) 2018 Greenbone Networks GmbH
#
# SPDX-License-Identifier: GPL-3.0-or-later
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

"""Command Line Interface Parser
"""

import argparse
import configparser
import logging
import os

from gvm import get_version as get_gvm_version
from gvm.connections import (DEFAULT_UNIX_SOCKET_PATH,
                             DEFAULT_TIMEOUT,
                             DEFAULT_GVM_PORT,
                             SSHConnection,
                             TLSConnection,
                             UnixSocketConnection)

from gvmtools import get_version

logger = logging.getLogger(__name__)

__version__ = get_version()
__api_version__ = get_gvm_version()

DEFAULT_CONFIG_PATH = '~/.config/gvm-tools.conf'

PROTOCOL_OSP = 'OSP'
PROTOCOL_GMP = 'GMP'
DEFAULT_PROTOCOL = PROTOCOL_GMP


class CliParser:

    def __init__(self, description, logfilename):
        root_parser = argparse.ArgumentParser(
            description=description,
            formatter_class=argparse.RawTextHelpFormatter,
            add_help=False)

        root_parser.add_argument(
            '-c', '--config', nargs='?', default=DEFAULT_CONFIG_PATH,
            help='Configuration file path (default: %(default)s)')
        root_parser.add_argument(
            '--log', nargs='?', dest='loglevel', const='INFO',
            choices=['DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'],
            help='Activate logging (default level: %(default)s)')

        args_before, _ = root_parser.parse_known_args()

        if args_before.loglevel is not None:
            level = logging.getLevelName(args_before.loglevel)
            logging.basicConfig(filename=logfilename, level=level)

        root_parser.add_argument(
            '--timeout', required=False, default=DEFAULT_TIMEOUT, type=int,
            help='Response timeout in seconds, or -1 to wait '
                 'indefinitely (default: %(default)s)')
        root_parser.add_argument(
            '--gmp-username',
            help='Username for GMP service (default: %(default)r)')
        root_parser.add_argument(
            '--gmp-password',
            help='Password for GMP service (default: %(default)r)')
        root_parser.add_argument(
            '-V', '--version', action='version',
            version='%(prog)s {version} (API version {apiversion})'.format(
                version=__version__, apiversion=__api_version__),
            help='Show version information and exit')

        parser = argparse.ArgumentParser(parents=[root_parser])

        subparsers = parser.add_subparsers(
            metavar='CONNECTION_TYPE',
            title='connections',
            description='valid connection types',
            help="Connection type to use",
        )
        subparsers.required = True
        subparsers.dest = 'connection_type'

        self._config = self._load_config(args_before.config)

        self._parser = parser
        self._root_parser = root_parser
        self._subparsers = subparsers

    def parse_args(self):
        self._add_subparsers()

        self._parser.set_defaults(
            gmp_username=self._config.get('gmp', 'username', fallback=''),
            gmp_password=self._config.get('gmp', 'password', fallback=''),
            **self._config.defaults()
        )

        args = self._parser.parse_args()

        # If timeout value is -1, then the socket should have no timeout
        if args.timeout == -1:
            args.timeout = None


        logging.debug('Parsed arguments %r', args)

        return args

    def add_argument(self, *args, **kwargs):
        self._parser.add_argument(*args, **kwargs)
        self._root_parser.add_argument(*args, **kwargs)

    def _load_config(self, configfile):
        config = configparser.ConfigParser(default_section='main')

        try:
            path = os.path.expanduser(configfile)
            config.read(path)
        except Exception as e: # pylint: disable=broad-except
            raise RuntimeError(
                'Error while parsing config file {config}. Error was '
                '{message}'.format(config=configfile, message=e))

        logger.debug('Loaded config %s', configfile)
        return config

    def _add_subparsers(self):
        parser_ssh = self._subparsers.add_parser(
            'ssh', help='Use SSH to connect to service',
            parents=[self._root_parser])

        parser_ssh.add_argument('--hostname', required=True,
                                help='Hostname or IP address')
        parser_ssh.add_argument('--port', required=False,
                                help='SSH port (default: %(default)s)')
        parser_ssh.add_argument('--ssh-username',
                                help='SSH username (default: %(default)r)')
        parser_ssh.add_argument('--ssh-password',
                                help='SSH password (default: %(default)r)')

        parser_ssh.set_defaults(
            port=int(self._config.get('ssh', 'port', fallback=22)),
            ssh_username=self._config.get('ssh', 'username', fallback='gmp'),
            ssh_password=self._config.get('ssh', 'password', fallback='gmp'),
        )

        parser_tls = self._subparsers.add_parser(
            'tls', help='Use TLS secured connection to connect to service',
            parents=[self._root_parser])
        parser_tls.add_argument('--hostname', required=True,
                                help='Hostname or IP address')
        parser_tls.add_argument('--port', required=False,
                                help='GMP/OSP port (default: %(default)s)')
        parser_tls.add_argument(
            '--certfile', required=False,
            help='Path to the certificate file for client authentication. '
                 '(default: %(default)s)')
        parser_tls.add_argument(
            '--keyfile', required=False,
            help='Path to key file for client authentication. '
                 '(default: %(default)s)')
        parser_tls.add_argument(
            '--cafile', required=False,
            help='Path to CA certificate for server authentication. '
                 '(default: %(default)s)')
        parser_tls.add_argument(
            '--no-credentials', required=False, default=False,
            help='Use only certificates for authentication')
        parser_tls.set_defaults(
            port=int(self._config.get(
                'tls', 'port', fallback=DEFAULT_GVM_PORT)),
            certfile=self._config.get('tls', 'certfile', fallback=None),
            keyfile=self._config.get('tls', 'keyfile', fallback=None),
            cafile=self._config.get('tls', 'cafile', fallback=None),
        )

        parser_socket = self._subparsers.add_parser(
            'socket', help='Use UNIX Domain socket to connect to service',
            parents=[self._root_parser])

        socketpath_group = parser_socket.add_mutually_exclusive_group()
        socketpath_group.add_argument(
            '--sockpath', nargs='?', default=None,
            help='Deprecated, use --socketpath instead')
        socketpath_group.add_argument(
            '--socketpath', nargs='?',
            help='Path to UNIX Domain socket (default: %(default)s)')

        parser_socket.set_defaults(
            socketpath=self._config.get(
                'unixsocket', 'socketpath', fallback=DEFAULT_UNIX_SOCKET_PATH),
        )

    def add_protocol_argument(self):
        self.add_argument(
            '--protocol', required=False, default=DEFAULT_PROTOCOL,
            choices=[PROTOCOL_GMP, PROTOCOL_OSP],
            help='Service protocol to use (default: %(default)s)')


def create_parser(description, logfilename):
    return CliParser(description, logfilename)


def create_connection(connection_type, socketpath=None, timeout=None,
                      hostname=None, port=None, certfile=None, keyfile=None,
                      cafile=None, ssh_username=None, ssh_password=None,
                      **kwargs):
    if 'socket' in connection_type:
        return UnixSocketConnection(
            timeout=timeout,
            path=socketpath
        )

    if 'tls' in connection_type:
        return TLSConnection(
            timeout=timeout,
            hostname=hostname,
            port=port,
            certfile=certfile,
            keyfile=keyfile,
            cafile=cafile,
        )

    return SSHConnection(
        timeout=timeout,
        hostname=hostname,
        port=port,
        username=ssh_username,
        password=ssh_password
    )