gmp.gvm_connection.GVMConnection.cmdSplitter() - Code Metrics - Inspection of "Insert a new line into a long GMP command each ~40..." - greenbone/gvm-tools - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — master (#55)

unknown
created 2018-07-24 11:42 UTC
gmp.gvm_connection.GVMConnection.cmdSplitter() A

↳ Parent: Project
Complexity

Conditions
Size

Total Lines	27
Code Lines	15
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	3
eloc	15
nop	2
dl	0
loc	27
rs	9.65
c	0
b	0
f	0
# -*- coding: utf-8 -*-
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
# Description:
# GVM-Connection classes for communication with the GVM.
#
# Authors:
# Raphael Grewe <[email protected]>
#
# Copyright:
# Copyright (C) 2017 Greenbone Networks GmbH
#
# 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/>.

import logging
import socket
import ssl
import time
from io import StringIO

from lxml import etree
import paramiko

from gmp.gmp import _gmp

logger = logging.getLogger(__name__)


BUF_SIZE = 1024


class GMPError(Exception):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
    pass


class GVMConnection:

    """Wrapper for GMP

    This class helps users to connect to their GVM via Secure Shell,
    UNIX-Socket or secured connection on port 9390.

    Variables:
        gmp_generator {object} -- Instance of the gmp generator.
        authenticated {bool} -- GMP-User authenticated.
    """

    def __init__(self):
        # GMP Message Creator
        self.gmp_generator = _gmp()

        # Is authenticated on gvm
        self.authenticated = False

        # initialize variables
        self.sock = None

    def readAll(self):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        # just a stub
        pass

    def sendAll(self, cmd):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        # just a stub
        pass

    @staticmethod
    def cmdSplitter(cmd, max_len):

        """ Receive the cmd string longer than max_len
        and insert a new line each max_len.
        As cmd is an XML formatted string, it inserts the new line
        after the last '>' before to count max_len characters.

        Input:
           cmd      The string where the new lines will be inserted.
           max_len  Insert a new line before to count max_len chars again.
        Output:
           cmd      The cmd string with the inserted new lines.
        """
        i_start = 0;

        i_end = max_len
        last = 0
        char_add = 0
        while last != -1:
            last = cmd.rfind('>', i_start, i_end)
            if last == -1:
                break
            cmd = cmd[:last + 1] + '\n' + cmd[last + 1:]
            char_add += 1
            i_start = last + 1
            i_end = last + max_len

        return cmd

    def send(self, cmd):
        """Call the sendAll(string) method.

        Nothing more ;-)

        Arguments:
            cmd {string} -- XML-Source
        """
        try:
            max_len = 4095
            if len(cmd) > max_len:
                cmd = self.cmdSplitter(cmd, max_len)

            self.sendAll(cmd)
            logger.debug(cmd)
        except paramiko.SSHException as e:

            print(e)
        except OSError as e:

            logger.info(e)
            raise

    def read(self):
        """Call the readAll() method of the chosen connection type.

        Try to read all from the open socket connection.
        Check for status attribute in xml code.
        If the program is in shell-mode, then it returns a lxml root element,
        otherwise the plain xml.
        If the response is either None or the length is zero,
        then the connection was terminated from the server.

        Returns:
            lxml.etree._Element or <string> -- Response from server.
        """
        response = self.readAll()
        logger.debug('read() {0} Bytes response: {1}'.format(

            len(response), response))

        if response is None or len(str(response)) == 0:

            raise OSError('Connection was closed by remote server')

        if hasattr(self, 'raw_response') and self.raw_response is True: #pylint: disable=E1101
            return response

        self.checkCommandStatus(response)

        if hasattr(self, 'shell_mode') and self.shell_mode is True: #pylint: disable=E1101

            parser = etree.XMLParser(encoding='utf-8', recover=True)


            logger.info('Shell mode activated')
            f = StringIO(response)

            tree = etree.parse(f, parser)

            return tree.getroot()
        else:
            return response

    def close(self):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        try:
            if self.sock is not None:
                self.sock.close()
        except OSError as e:

            logger.debug('Connection closing error: {0}'.format(e))


    def checkCommandStatus(self, xml):

        """Check gmp response

        Look into the gmp response and check for the status in the root element

        Arguments:
            xml {string} -- XML-Source

        Returns:
            bool -- True if valid, otherwise False
        """

        if xml is 0 or xml is None:
            raise GMPError('XML Command is empty')

        try:
            parser = etree.XMLParser(encoding='utf-8', recover=True)

            if etree.iselement(xml):

                root = etree.ElementTree(xml, parser=parser).getroot()

            else:
                root = etree.XML(xml, parser=parser)

            status = root.attrib['status']
            status_text = root.attrib['status_text']

            if not self.authenticated:
                auth = root.find('authenticate_response')
                if auth is not None:
                    status = auth.attrib['status']
                    status_text = auth.attrib['status_text']
                    if status != '400':
                        self.authenticated = True

            if 'OK' not in status_text:
                logger.info('An error occurred on gvm: ' + status_text)
                raise GMPError(status_text)

        except etree.Error as e:

            logger.error('etree.XML(xml): ' + str(e))
            raise

    def argumentsToString(self, kwargs):
class Foo:
    def some_method(self, x, y):
        return x + y;
        """Convert arguments

        Converts dictionaries into gmp arguments string

        Arguments:
            kwargs {dict} -- Arguments

        Returns:
            string -- Arguments as string
        """
        msg = ''
        for key, value in kwargs.items():
            msg += str(key) + '=\'' + str(value) + '\' '

        return msg

    def ask_yes_or_no(self, text):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        yes = set(['yes', 'y', 'ye', ''])
        no = set(['no', 'n'])


        choice = input(text).lower()
        if choice in yes:

            return True
        elif choice in no:
            return False
        else:
            return self.ask_yes_or_no(text)

    def authenticate(self, username, password, withCommand=''):

        """Authenticate on GVM.

        The generated authenticate command will be send to server.
        After that a response is read from socket.

        Keyword Arguments:
            username {str} -- Username
            password {str} -- Password
            withCommands {str} -- XML commands (default: {''})

        Returns:
            None or <string> -- Response from server.
        """
        cmd = self.gmp_generator.createAuthenticateCommand(
            username=username, password=password,
            withCommands=str(withCommand))

        self.send(cmd)
        return self.read()

    def create_agent(self, installer, signature, name, comment='', copy='',
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
                     howto_install='', howto_use=''):
        cmd = self.gmp_generator.createAgentCommand(
            installer, signature, name, comment, copy, howto_install,
            howto_use)
        self.send(cmd)
        return self.read()

    def create_alert(self, name, condition, event, method, filter_id='',
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
                     copy='', comment=''):
        cmd = self.gmp_generator.createAlertCommand(name, condition, event,
                                                    method, filter_id, copy,
                                                    comment)
        self.send(cmd)
        return self.read()

    def create_asset(self, name, asset_type, comment=''):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        # TODO: Add the missing second method. Also the docs are not complete!

        cmd = self.gmp_generator.createAssetCommand(name, asset_type, comment)
        self.send(cmd)
        return self.read()

    def create_config(self, copy_id, name):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        cmd = self.gmp_generator.createConfigCommand(copy_id, name)
        self.send(cmd)
        return self.read()

    def create_credential(self, name, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        cmd = self.gmp_generator.createCredentialCommand(name, kwargs)
        self.send(cmd)
        return self.read()

    def create_filter(self, name, make_unique, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        cmd = self.gmp_generator.createFilterCommand(name, make_unique, kwargs)
        self.send(cmd)
        return self.read()

    def create_group(self, name, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        cmd = self.gmp_generator.createGroupCommand(name, kwargs)
        self.send(cmd)
        return self.read()

    # TODO: Create notes with comment returns bogus element. Research

    def create_note(self, text, nvt_oid, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        cmd = self.gmp_generator.createNoteCommand(text, nvt_oid, kwargs)
        self.send(cmd)
        return self.read()

    def create_override(self, text, nvt_oid, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        cmd = self.gmp_generator.createOverrideCommand(text, nvt_oid, kwargs)
        self.send(cmd)
        return self.read()

    def create_permission(self, name, subject_id, type, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        cmd = self.gmp_generator.createPermissionCommand(name, subject_id,
                                                         type, kwargs)
        self.send(cmd)
        return self.read()

    def create_port_list(self, name, port_range, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        cmd = self.gmp_generator.createPortListCommand(name, port_range,
                                                       kwargs)
        self.send(cmd)
        return self.read()

    def create_port_range(self, port_list_id, start, end, type, comment=''):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        cmd = self.gmp_generator.createPortRangeCommand(port_list_id, start,
                                                        end, type, comment)
        self.send(cmd)
        return self.read()

    def create_report(self, report_xml_string, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        cmd = self.gmp_generator.createReportCommand(report_xml_string, kwargs)
        self.send(cmd)
        return self.read()

    def create_report_format(self):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        # TODO: Seems to be a complex task. It is needed?

        raise NotImplementedError

    def create_role(self, name, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        cmd = self.gmp_generator.createRoleCommand(name, kwargs)
        self.send(cmd)
        return self.read()

    def create_scanner(self, name, host, port, type, ca_pub, credential_id,
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
                       **kwargs):
        cmd = self.gmp_generator.createScannerCommand(name, host, port, type,
                                                      ca_pub, credential_id,
                                                      kwargs)
        self.send(cmd)
        return self.read()

    def create_schedule(self, name, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        cmd = self.gmp_generator.createScheduleCommand(name, kwargs)
        self.send(cmd)
        return self.read()

    def create_tag(self, name, resource_id, resource_type, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        cmd = self.gmp_generator.createTagCommand(name, resource_id,
                                                  resource_type, kwargs)
        self.send(cmd)
        return self.read()

    def create_target(self, name, make_unique, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        # TODO: Missing variables

        cmd = self.gmp_generator.createTargetCommand(name, make_unique, kwargs)
        self.send(cmd)
        return self.read()

    def create_task(self, name, config_id, target_id, scanner_id, alert_id='', comment=''):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        cmd = self.gmp_generator.createTaskCommand(
            name, config_id, target_id, scanner_id, alert_id, comment)
        self.send(cmd)
        return self.read()

    def create_user(self, name, password, copy='', hosts_allow='0',
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
                    ifaces_allow='0', role_ids=(), hosts=None, ifaces=None):
        cmd = self.gmp_generator.createUserCommand(
            name, password, copy, hosts_allow, ifaces_allow, role_ids,
            hosts, ifaces)
        self.send(cmd)
        return self.read()

    def delete_agent(self, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        self.send('<delete_agent {0}/>'.format(self.argumentsToString(kwargs)))
        return self.read()

    def delete_alert(self, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        # if self.ask_yes_or_no('Are you sure to delete this alert? '):
        self.send(
            '<delete_alert {0}/>'.format(self.argumentsToString(kwargs)))
        return self.read()

    def delete_asset(self, asset_id, ultimate=0):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        # if self.ask_yes_or_no('Are you sure to delete this asset? '):
        self.send('<delete_asset asset_id="{0}" ultimate="{1}"/>'
                  .format(asset_id, ultimate))
        return self.read()

    def delete_config(self, config_id, ultimate=0):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        # if self.ask_yes_or_no('Are you sure to delete this config? '):
        self.send('<delete_config config_id="{0}" ultimate="{1}"/>'
                  .format(config_id, ultimate))
        return self.read()

    def delete_credential(self, credential_id, ultimate=0):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        # if self.ask_yes_or_no('Are you sure to delete this credential? '):
        self.send(
            '<delete_credential credential_id="{0}" ultimate="{1}"/>'.format
            (credential_id, ultimate))
        return self.read()

    def delete_filter(self, filter_id, ultimate=0):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        # if self.ask_yes_or_no('Are you sure to delete this filter? '):
        self.send('<delete_filter filter_id="{0}" ultimate="{1}"/>'
                  .format(filter_id, ultimate))
        return self.read()

    def delete_group(self, group_id, ultimate=0):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        # if self.ask_yes_or_no('Are you sure to delete this group? '):
        self.send('<delete_group group_id="{0}" ultimate="{1}"/>'
                  .format(group_id, ultimate))
        return self.read()

    def delete_note(self, note_id, ultimate=0):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        # if self.ask_yes_or_no('Are you sure to delete this note? '):
        self.send('<delete_note note_id="{0}" ultimate="{1}"/>'
                  .format(note_id, ultimate))
        return self.read()

    def delete_override(self, override_id, ultimate=0):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        # if self.ask_yes_or_no('Are you sure to delete this override? '):
        self.send('<delete_override override_id="{0}" ultimate="{1}"/>'
                  .format(override_id, ultimate))
        return self.read()

    def delete_permission(self, permission_id, ultimate=0):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        # if self.ask_yes_or_no('Are you sure to delete this permission? '):
        self.send('<delete_permission permission_id="{0}" ultimate="{1}"/>'
                  .format(permission_id, ultimate))
        return self.read()

    def delete_port_list(self, port_list_id, ultimate=0):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        # if self.ask_yes_or_no('Are you sure to delete this port_list? '):
        self.send('<delete_port_list port_list_id="{0}" ultimate="{1}"/>'
                  .format(port_list_id, ultimate))
        return self.read()

    def delete_port_range(self, port_range_id):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        # if self.ask_yes_or_no('Are you sure to delete this port_range? '):
        self.send('<delete_port_range port_range_id="{0}"/>'
                  .format(port_range_id))
        return self.read()

    def delete_report(self, report_id):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        # if self.ask_yes_or_no('Are you sure to delete this report? '):
        self.send('<delete_report report_id="{0}"/>'
                  .format(report_id))
        return self.read()

    def delete_report_format(self, report_format_id, ultimate=0):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        # if self.ask_yes_or_no('Are you sure to delete this report_format? '):
        self.send('<delete_report_format report_format_id="{0}" \
                   ultimate="{1}"/>'.format(report_format_id, ultimate))
        return self.read()

    def delete_role(self, role_id, ultimate=0):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        # if self.ask_yes_or_no('Are you sure to delete this role? '):
        self.send('<delete_role role_id="{0}" ultimate="{1}"/>'
                  .format(role_id, ultimate))
        return self.read()

    def delete_scanner(self, scanner_id, ultimate=0):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        # if self.ask_yes_or_no('Are you sure to delete this scanner? '):
        self.send('<delete_scanner scanner_id="{0}" ultimate="{1}"/>'
                  .format(scanner_id, ultimate))
        return self.read()

    def delete_schedule(self, schedule_id, ultimate=0):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        # if self.ask_yes_or_no('Are you sure to delete this schedule? '):
        self.send('<delete_schedule schedule_id="{0}" ultimate="{1}"/>'
                  .format(schedule_id, ultimate))
        return self.read()

    def delete_tag(self, tag_id, ultimate=0):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        # if self.ask_yes_or_no('Are you sure to delete this tag? '):
        self.send('<delete_tag tag_id="{0}" ultimate="{1}"/>'
                  .format(tag_id, ultimate))
        return self.read()

    def delete_target(self, target_id, ultimate=0):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        # if self.ask_yes_or_no('Are you sure to delete this target? '):
        self.send('<delete_target target_id="{0}" ultimate="{1}"/>'
                  .format(target_id, ultimate))
        return self.read()

    def delete_task(self, task_id, ultimate=0):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        # if self.ask_yes_or_no('Are you sure to delete this task? '):
        self.send('<delete_task task_id="{0}" ultimate="{1}"/>'
                  .format(task_id, ultimate))
        return self.read()

    def delete_user(self, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        user_id = kwargs.get('user_id', '')
        if user_id:
            user_id = ' user_id="%s"' % user_id

        name = kwargs.get('name', '')
        if name:
            name = ' name="%s"' % name

        inheritor_id = kwargs.get('inheritor_id', '')
        if inheritor_id:
            inheritor_id = ' inheritor_id="%s"' % inheritor_id

        inheritor_name = kwargs.get('inheritor_name', '')
        if inheritor_name:
            inheritor_name = ' inheritor_name="%s"' % inheritor_name

        self.send('<delete_user{0}{1}{2}{3}/>'
                  .format(user_id, name, inheritor_id, inheritor_name))
        return self.read()

    def describe_auth(self):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        self.send('<describe_auth/>')
        return self.read()

    def empty_trashcan(self):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        self.send('<empty_trashcan/>')
        return self.read()

    def get_agents(self, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        self.send('<get_agents {0}/>'.format(self.argumentsToString(kwargs)))
        return self.read()

    def get_aggregates(self, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        self.send(
            '<get_aggregates {0}/>'.format(self.argumentsToString(kwargs)))
        return self.read()

    def get_alerts(self, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        self.send('<get_alerts {0}/>'.format(self.argumentsToString(kwargs)))
        return self.read()

    def get_assets(self, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        self.send('<get_assets {0}/>'.format(self.argumentsToString(kwargs)))
        return self.read()

    def get_credentials(self, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        self.send(
            '<get_credentials {0}/>'.format(self.argumentsToString(kwargs)))
        return self.read()

    def get_configs(self, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        self.send('<get_configs {0}/>'.format(self.argumentsToString(kwargs)))
        return self.read()

    def get_feeds(self, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        self.send('<get_feeds {0}/>'.format(self.argumentsToString(kwargs)))
        return self.read()

    def get_filters(self, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        self.send('<get_filters {0}/>'.format(self.argumentsToString(kwargs)))
        return self.read()

    def get_groups(self, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        self.send('<get_groups {0}/>'.format(self.argumentsToString(kwargs)))
        return self.read()

    def get_info(self, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        self.send('<get_info {0}/>'.format(self.argumentsToString(kwargs)))
        return self.read()

    def get_notes(self, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        self.send('<get_notes {0}/>'.format(self.argumentsToString(kwargs)))
        return self.read()

    def get_nvts(self, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        self.send('<get_nvts {0}/>'.format(self.argumentsToString(kwargs)))
        return self.read()

    def get_nvt_families(self, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        self.send(
            '<get_nvt_families {0}/>'.format(self.argumentsToString(kwargs)))
        return self.read()

    def get_overrides(self, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        self.send(
            '<get_overrides {0}/>'.format(self.argumentsToString(kwargs)))
        return self.read()

    def get_permissions(self, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        self.send(
            '<get_permissions {0}/>'.format(self.argumentsToString(kwargs)))
        return self.read()

    def get_port_lists(self, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        self.send(
            '<get_port_lists {0}/>'.format(self.argumentsToString(kwargs)))
        return self.read()

    def get_preferences(self, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        self.send(
            '<get_preferences {0}/>'.format(self.argumentsToString(kwargs)))
        return self.read()

    def get_reports(self, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        self.send('<get_reports {0}/>'
                  .format(self.argumentsToString(kwargs)))
        return self.read()

    def get_report_formats(self, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        self.send(
            '<get_report_formats {0}/>'.format(self.argumentsToString(kwargs)))
        return self.read()

    def get_results(self, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        self.send('<get_results {0}/>'.format(self.argumentsToString(kwargs)))
        return self.read()

    def get_roles(self, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        self.send('<get_roles {0}/>'.format(self.argumentsToString(kwargs)))
        return self.read()

    def get_scanners(self, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        self.send('<get_scanners {0}/>'.format(self.argumentsToString(kwargs)))
        return self.read()

    def get_schedules(self, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        self.send(
            '<get_schedules {0}/>'.format(self.argumentsToString(kwargs)))
        return self.read()

    def get_settings(self, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        self.send('<get_settings {0}/>'.format(self.argumentsToString(kwargs)))
        return self.read()

    def get_system_reports(self, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        self.send(
            '<get_system_reports {0}/>'.format(self.argumentsToString(kwargs)))
        return self.read()

    def get_tags(self, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        self.send('<get_tags {0}/>'.format(self.argumentsToString(kwargs)))
        return self.read()

    def get_targets(self, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        self.send('<get_targets {0}/>'.format(self.argumentsToString(kwargs)))
        return self.read()

    def get_tasks(self, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        self.send('<get_tasks {0}/>'.format(self.argumentsToString(kwargs)))
        return self.read()

    def get_users(self, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        self.send('<get_users {0}/>'.format(self.argumentsToString(kwargs)))
        return self.read()

    def get_version(self):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        self.send('<get_version/>')
        return self.read()

    def help(self, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        self.send('<help {0} />'.format(self.argumentsToString(kwargs)))
        return self.read()

    def modify_agent(self, agent_id, name='', comment=''):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        cmd = self.gmp_generator.modifyAgentCommand(agent_id, name, comment)
        self.send(cmd)
        return self.read()

    def modify_alert(self, alert_id, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        cmd = self.gmp_generator.modifyAlertCommand(alert_id, kwargs)
        self.send(cmd)
        return self.read()

    def modify_asset(self, asset_id, comment):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        cmd = '<modify_asset asset_id="%s"><comment>%s</comment>' \
              '</modify_asset>' % (asset_id, comment)
        self.send(cmd)
        return self.read()

    def modify_auth(self, group_name, auth_conf_settings):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        cmd = self.gmp_generator.modifyAuthCommand(group_name,
                                                   auth_conf_settings)
        self.send(cmd)
        return self.read()

    def modify_config(self, selection, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        cmd = self.gmp_generator.modifyConfigCommand(selection, kwargs)
        self.send(cmd)
        return self.read()

    def modify_credential(self, credential_id, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        cmd = self.gmp_generator.modifyCredentialCommand(credential_id, kwargs)
        self.send(cmd)
        return self.read()

    def modify_filter(self, filter_id, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        cmd = self.gmp_generator.modifyFilterCommand(filter_id, kwargs)
        self.send(cmd)
        return self.read()

    def modify_group(self, group_id, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        cmd = self.gmp_generator.modifyGroupCommand(group_id, kwargs)
        self.send(cmd)
        return self.read()

    def modify_note(self, note_id, text, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        cmd = self.gmp_generator.modifyNoteCommand(note_id, text, kwargs)
        self.send(cmd)
        return self.read()

    def modify_override(self, override_id, text, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        cmd = self.gmp_generator.modifyOverrideCommand(override_id, text,
                                                       kwargs)
        self.send(cmd)
        return self.read()

    def modify_permission(self, permission_id, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        cmd = self.gmp_generator.modifyPermissionCommand(permission_id, kwargs)
        self.send(cmd)
        return self.read()

    def modify_port_list(self, port_list_id, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        cmd = self.gmp_generator.modifyPortListCommand(port_list_id, kwargs)
        self.send(cmd)
        return self.read()

    def modify_report(self, report_id, comment):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        cmd = '<modify_report report_id="{0}"><comment>{1}</comment>' \
              '</modify_report>'.format(report_id, comment)
        self.send(cmd)
        return self.read()

    def modify_report_format(self, report_format_id, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        cmd = self.gmp_generator.modifyReportFormatCommand(report_format_id,
                                                           kwargs)
        self.send(cmd)
        return self.read()

    def modify_role(self, role_id, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        cmd = self.gmp_generator.modifyRoleCommand(role_id, kwargs)
        self.send(cmd)
        return self.read()

    def modify_scanner(self, scanner_id, host, port, type, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        cmd = self.gmp_generator.modifyScannerCommand(scanner_id, host, port,
                                                      type, kwargs)
        self.send(cmd)
        return self.read()

    def modify_schedule(self, schedule_id, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        cmd = self.gmp_generator.modifyScheduleCommand(schedule_id, kwargs)
        self.send(cmd)
        return self.read()

    def modify_setting(self, setting_id, name, value):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        cmd = '<modify_setting setting_id="{0}"><name>{1}</name>' \
              '<value>{2}</value></modify_setting>' \
              ''.format(setting_id, name, value)
        self.send(cmd)
        return self.read()

    def modify_tag(self, tag_id, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        cmd = self.gmp_generator.modifyTagCommand(tag_id, kwargs)
        self.send(cmd)
        return self.read()

    def modify_target(self, target_id, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        cmd = self.gmp_generator.modifyTargetCommand(target_id, kwargs)
        self.send(cmd)
        return self.read()

    def modify_task(self, task_id, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        cmd = self.gmp_generator.modifyTaskCommand(task_id, kwargs)
        self.send(cmd)
        return self.read()

    def modify_user(self, **kwargs):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        cmd = self.gmp_generator.modifyUserCommand(kwargs)
        self.send(cmd)
        return self.read()

    def move_task(self, task_id, slave_id):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        self.send('<move_task task_id="{0}" slave_id="{1}"/>'
                  .format(task_id, slave_id))
        return self.read()

    def restore(self, id):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        self.send('<restore id="{0}"/>'.format(id))
        return self.read()

    def resume_task(self, task_id):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        self.send('<resume_task task_id="{0}"/>'.format(task_id))
        return self.read()

    def run_wizard(self):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        # TODO: Is this required?

        raise NotImplementedError

    def start_task(self, task_id):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        self.send('<start_task task_id="{0}"/>'.format(task_id))
        return self.read()

    def stop_task(self, task_id):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        self.send('<stop_task task_id="{0}"/>'.format(task_id))
        return self.read()

    def sync_cert(self):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        self.send('<sync_cert/>')
        return self.read()

    def sync_config(self):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        self.send('<sync_config/>')
        return self.read()

    def sync_feed(self):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        self.send('<sync_feed/>')
        return self.read()

    def sync_scap(self):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        self.send('<sync_scap/>')
        return self.read()

    def test_alert(self, id):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        self.send('<test_alert alert_id="{0}"/>'.format(id))
        return self.read()

    def verify_agent(self, id):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        self.send('<verify_agent agent_id="{0}"/>'.format(id))
        return self.read()

    def verify_report_format(self, id):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        self.send('<verify_report_format report_format_id="{0}"/>'.format(id))
        return self.read()

    def verify_scanner(self, id):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        self.send('<verify_scanner scanner_id="{0}"/>'.format(id))
        return self.read()


class SSHConnection(GVMConnection):

    """SSH Class to connect, read and write from GVM via SSH

    [description]

    Variables:
        sock {[type]} -- Channel from paramiko after successful connection

    """

    def __init__(self, **kwargs):
        super().__init__()
        self.hostname = kwargs.get('hostname', '127.0.0.1')
        self.port = kwargs.get('port', 22)
        self.raw_response = kwargs.get('raw_response', False)
        self.timeout = kwargs.get('timeout', 5)
        self.ssh_user = kwargs.get('ssh_user', 'gmp')
        self.ssh_password = kwargs.get('ssh_password', '')
        self.shell_mode = kwargs.get('shell_mode', False)
        self.sock = paramiko.SSHClient()
        # self.sock.load_system_host_keys()
        # self.sock.set_missing_host_key_policy(paramiko.WarningPolicy())
        self.sock.set_missing_host_key_policy(paramiko.AutoAddPolicy())

        try:
            self.sock.connect(
                hostname=self.hostname,
                username=self.ssh_user,
                password=self.ssh_password,
                timeout=self.timeout,
                port=int(self.port),
                allow_agent=False,
                look_for_keys=False)
            self.channel = self.sock.invoke_shell()

        except (paramiko.BadHostKeyException,

                paramiko.AuthenticationException,
                paramiko.SSHException, OSError) as e:
            logger.debug('SSH Connection failed: ' + str(e))
            raise

    def readAll(self):
        self.first_element = None
class Foo:
    def __init__(self, x=None):
        self.x = x
        self.parser = etree.XMLPullParser(('start', 'end'))
class Foo:
    def __init__(self, x=None):
        self.x = x
        read_bytes = 0
        garbage_bytes = len(self.cmd) +1
        # Remove command string from result
        while not read_bytes == garbage_bytes:

            read_bytes += len(self.channel.recv(garbage_bytes-read_bytes))

        response = b''

        while True:
            data = self.channel.recv(BUF_SIZE)

            # Connection was closed by server
            if not data:
                break

            self.parser.feed(data)

            response += data

            if self.valid_xml():
                break

        return response.decode('utf-8')

    def sendAll(self, cmd):
        logger.debug('SSH:send(): ' + cmd)
        self.cmd = str(cmd) + '\n'
class Foo:
    def __init__(self, x=None):
        self.x = x
        self.channel.sendall(self.cmd)

    def valid_xml(self):
class SomeClass:
    def some_method(self):
        """Do x and return foo."""
        for action, obj in self.parser.read_events():
            if not self.first_element and action in 'start':
                self.first_element = obj.tag
class Foo:
    def __init__(self, x=None):
        self.x = x

            if self.first_element and action in 'end' and str(self.first_element) == str(obj.tag):
                return True
        return False


class TLSConnection(GVMConnection):

    """TLS class to connect, read and write from GVM via tls secured socket

    [description]

    Variables:
        sock {socket.socket} -- Socket that holds the connection
    """

    def __init__(self, **kwargs):
        super().__init__()
        self.hostname = kwargs.get('hostname', '127.0.0.1')
        self.port = kwargs.get('port', 9390)
        self.raw_response = kwargs.get('raw_response', False)
        self.timeout = kwargs.get('timeout', 60)
        self.shell_mode = kwargs.get('shell_mode', False)
        context = ssl.SSLContext(ssl.PROTOCOL_TLSv1_2)
        self.sock = context.wrap_socket(socket.socket(socket.AF_INET))
        self.sock.settimeout(self.timeout)
        self.sock.connect((self.hostname, int(self.port)))

    def sendAll(self, cmd):
        self.sock.send(cmd.encode())

    def readAll(self):
        response = ''
        while True:
            data = self.sock.read(BUF_SIZE)

            response += data.decode(errors='ignore')
            if len(data) < BUF_SIZE:
                break
        return response


class UnixSocketConnection(GVMConnection):

    """UNIX-Socket class to connect, read, write from GVM
    via direct communicating UNIX-Socket

    [description]

    Variables:
        sock {socket.socket} -- Socket that holds the connection
        sockpath {string} -- Path to UNIX-Socket
    """

    def __init__(self, **kwargs):
        super().__init__()
        self.raw_response = kwargs.get('raw_response', False)
        self.sockpath = kwargs.get('sockpath',
                                   '/usr/local/var/run/gvmd.sock')
        self.shell_mode = kwargs.get('shell_mode', False)
        self.timeout = kwargs.get('timeout', 60)
        self.sock = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM) #pylint: disable=E1101
        self.sock.settimeout(self.timeout)
        self.sock.connect(self.sockpath)

    def readAll(self):
        response = ''
        while True:
            data = self.sock.recv(BUF_SIZE)
            # Todo: Why does the sleep helps here? Sometimes it will break
            # here because the message is missing some bytes at the end.
            # Same script and with tls or ssh, then it works flawless without
            # "sleep()"
            time.sleep(0.000001)
            response += data.decode()
            if len(data) < BUF_SIZE:
                break

        return response

    def sendAll(self, cmd):
        self.sock.send(cmd.encode())

1			# -- coding: utf-8 --
			0 ignored issues – show Coding Style introduced 2018-06-12 10:47 UTC by Report Bug Copy Issue Report This module should have a docstring. The coding style of this project requires that you add a docstring to this code element. Below, you find an example for methods: class SomeClass: def some_method(self): """Do x and return foo.""" If you would like to know more about docstrings, we recommend to read PEP-257: Docstring Conventions. Loading history...
2			# Description:
3			# GVM-Connection classes for communication with the GVM.
4			#
5			# Authors:
6			# Raphael Grewe <[email protected]>
7			#
8			# Copyright:
9			# Copyright (C) 2017 Greenbone Networks GmbH
10			#
11			# This program is free software: you can redistribute it and/or modify
12			# it under the terms of the GNU General Public License as published by
13			# the Free Software Foundation, either version 3 of the License, or
14			# (at your option) any later version.
15			#
16			# This program is distributed in the hope that it will be useful,
17			# but WITHOUT ANY WARRANTY; without even the implied warranty of
18			# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19			# GNU General Public License for more details.
20			#
21			# You should have received a copy of the GNU General Public License
22			# along with this program. If not, see <http://www.gnu.org/licenses/>.
23
24			import logging
25			import socket
26			import ssl
27			import time
28			from io import StringIO
29
30			from lxml import etree
31			import paramiko
32
33			from gmp.gmp import _gmp
34
35			logger = logging.getLogger(__name__)
			0 ignored issues – show Coding Style Naming introduced 2018-06-12 10:47 UTC by Report Bug Copy Issue Report The name `logger` does not conform to the constant naming conventions (`(([A-Z_][A-Z0-9_])\|(__.__))$`). This check looks for invalid names for a range of different identifiers. You can set regular expressions to which the identifiers must conform if the defaults do not match your requirements. If your project includes a Pylint configuration file, the settings contained in that file take precedence. To find out more about Pylint, please refer to their site. Loading history...
36
37			BUF_SIZE = 1024
38
greenbone / gvm-tools

Pull Request — master (#55)

gmp.gvm_connection.GVMConnection.cmdSplitter() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
