start-alert-scan.gmp.main() - Code Metrics - Inspection of "Increase coverage" - greenbone/gvm-tools - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#344)

by Jaspar

created 2020-12-21 07:48 UTC

start-alert-scan.gmp.main() B

↳ Parent: start-alert-scan.gmp

Complexity

Conditions

Size

Total Lines	147
Code Lines	98

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	4
eloc	98
nop	2
dl	0
loc	147
rs	7.0654
c	0
b	0
f	0

How to fix Long Method

# -*- coding: utf-8 -*-
# Copyright (C) 2018 Henning Häcker
#
# 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/>.

from typing import List
from argparse import ArgumentParser, RawTextHelpFormatter


HELP_TEXT = """
        This script makes an E-Mail alert scan.

        Usage examples: 
            $ gvm-script --gmp-username name --gmp-password pass ssh --hostname
            ... start-alert-scan.gmp.py +h
            ... start-alert-scan.gmp.py ++target-name ++hosts ++ports \
                    ++port-list-name +C ++recipient ++sender
            ... start-alert-scan.gmp.py ++target-name ++hosts ++port-list-id \
                    +C ++recipient ++sender
            ... start-alert-scan.gmp.py ++target-id +C ++recipient ++sender
    """


def get_config(gmp, config, debug=False):
    # get all configs of the openvas instance
    # filter for all rows!
    res = gmp.get_configs(filter="rows=-1")

    if config < 0 or config > 4:
        raise ValueError("Wrong config identifier. Choose between [0,4].")
    # match the config abbreviation to accepted config names
    config_list = [
        'Full and fast',
        'Full and fast ultimate',
        'Full and very deep',
        'Full and very deep ultimate',
        'System Discovery',
    ]
    template_abbreviation_mapper = {
        0: config_list[0],
        1: config_list[1],
        2: config_list[2],
        3: config_list[3],
        4: config_list[4],
    }

    for conf in res.xpath('config'):
        cid = conf.xpath('@id')[0]
        name = conf.xpath('name/text()')[0]

        # get the config id of the desired template
        if template_abbreviation_mapper.get(config) == name:
            config_id = cid
            if debug:
                print(name + ": " + config_id)
            break

    return config_id



def get_target(
    gmp,
    target_name: str = None,
    hosts: List[str] = None,
    ports: str = None,
    port_list_name: str = None,
    port_list_id: str = None,
    debug: bool = False,
):
    targets = gmp.get_targets()
    counter = 0
    exists = True
    # iterate over existing targets and find a vacant targetName
    while exists:
        exists = False
        if target_name is None:
            target_name = "target_{}".format(str(counter))
        for target in targets.xpath('target'):
            name = target.xpath('name/text()')[0]
            if name == target_name:
                exists = True
                break
        counter += 1

    if debug:
        print("target name: {}".format(target_name))

    if not port_list_id:
        # iterate over existing port lists and find a vacant name
        existing_port_lists = [""]
        for name in gmp.get_port_lists().findall("port_list/name"):
            existing_port_lists.append(str(name.text))

        if port_list_name is None:
            port_list_name = "portlist_{}".format(str(counter))
        counter = 0
        while True:
            if port_list_name not in existing_port_lists:
                break
            counter += 1

        # create port list
        portlist = gmp.create_port_list(port_list_name, ports)
        port_list_id = portlist.xpath('@id')[0]
        if debug:
            print("New Portlist-name:\t{}".format(str(port_list_name)))
            print("New Portlist-id:\t{}".format(str(port_list_id)))

    # integrate port list id into create_target
    res = gmp.create_target(target_name, hosts=hosts, port_list_id=port_list_id)
    return res.xpath('@id')[0]


def get_alert(
    gmp,
    sender_email: str,
    recipient_email: str,
    alert_name: str = None,
    debug=False,
):

    # create alert if necessary
    alert_object = gmp.get_alerts(filter='name={}'.format(alert_name))
    alert = alert_object.xpath('alert')

    if len(alert) == 0:
        print("creating new alert {}".format(alert_name))
        gmp.create_alert(
            alert_name,
            event=gmp.types.AlertEvent.TASK_RUN_STATUS_CHANGED,
            event_data={"status": "Done"},
            condition=gmp.types.AlertCondition.ALWAYS,
            method=gmp.types.AlertMethod.EMAIL,
            method_data={
                """Task '$n': $e

After the event $e,
the following condition was met: $c

This email escalation is configured to attach report format '$r'.
Full details and other report formats are available on the scan engine.

$t

Note:
This email was sent to you as a configured security scan escalation.
Please contact your local system administrator if you think you
should not have received it.
""": "message",
                "2": "notice",
                sender_email: "from_address",
                "[OpenVAS-Manager] Task": "subject",
                "c402cc3e-b531-11e1-9163-406186ea4fc5": "notice_attach_format",
                recipient_email: "to_address",
            },
        )

        alert_object = gmp.get_alerts(filter='name={}'.format(recipient_email))
        alert = alert_object.xpath('alert')

    alert_id = alert[0].get('id', 'no id found')
    if debug:
        print("alert_id: {}".format(str(alert_id)))

    return alert_id


def get_scanner(gmp):
    res = gmp.get_scanners()
    scanner_ids = res.xpath('scanner/@id')
    return scanner_ids[1]  # default scanner


def create_and_start_task(
    gmp,
    config_id: str,
    target_id: str,
    scanner_id: str,
    alert_id: str,
    alert_name: str,
    debug: bool = False,
):
    # Create the task
    tasks = gmp.get_tasks(filter="name~{}".format(alert_name))
    task_name = "Alert Scan for Alert {}".format(alert_name)
    if tasks:
        task_name = "Alert Scan for Alert {} ({})".format(
            alert_name, len(tasks.xpath('tasks/@id'))
        )
    task_comment = "Alert Scan"
    res = gmp.create_task(
        task_name,
        config_id,
        target_id,
        scanner_id,
        alert_ids=[alert_id],
        comment=task_comment,
    )

    # Start the task
    task_id = res.xpath('@id')[0]
    gmp.start_task(task_id)

    print('Task started: ' + task_name)

    if debug:
        # Stop the task (for performance reasons)
        gmp.stop_task(task_id)
        print('Task stopped')


def main(gmp, args):
    # pylint: disable=undefined-variable, unused-argument

    parser = ArgumentParser(
        prefix_chars="+",
        add_help=False,
        formatter_class=RawTextHelpFormatter,
        description=HELP_TEXT,
    )

    parser.add_argument(
        "+h",
        "++help",
        action="help",
        help="Show this help message and exit.",
    )

    target = parser.add_mutually_exclusive_group(required=True)

    target.add_argument(
        "++target-id",
        type=str,
        dest="target_id",
        help="Use an existing by target id",
    )

    target.add_argument(
        "++target-name",
        type=str,
        dest="target_name",
        help="Create a target by name",
    )

    parser.add_argument(
        "++hosts",
        nargs='+',
        dest='hosts',
        help="Host(s) for the new target",
    )

    ports = parser.add_mutually_exclusive_group()

    ports.add_argument(
        "++port-list-id",
        type=str,
        dest="port_list_id",
        help="An existing portlist id for the new target",
    )
    ports.add_argument(
        "++ports",
        type=str,
        dest='ports',
        help="Ports in the new target: e.g. T:80-80,8080",
    )

    parser.add_argument(
        "++port-list-name",
        type=str,
        dest="port_list_name",
        help="Name for the new portlist in the new target",
    )

    config = parser.add_mutually_exclusive_group()

    config.add_argument(
        "+C",
        "++scan_config",
        default=0,
        type=int,
        dest='config',
        help="Choose from existing scan config:"
        " 0: Full and fast"
        " 1: Full and fast ultimate"
        " 2: Full and very deep"
        " 3: Full and very deep ultimate"
        " 4: System Discovery",
    )

    config.add_argument(
        "++scan_config_id",
        default=0,
        type=int,
        dest='scan_config_id',
        help="Use existing scan config  by id",
    )

    parser.add_argument(
        "++recipient",
        required=True,
        dest='recipient_email',
        type=str,
        help="Alert recipient E-Mail address",
    )

    parser.add_argument(
        "++sender",
        required=True,
        dest='sender_email',
        type=str,
        help="Alert senders E-Mail address",
    )

    parser.add_argument(
        "++alert-name",
        dest='alert_name',
        type=str,
        help="Optional Alert name",
    )

    script_args, _ = parser.parse_known_args()

    # set alert_name to recipient email if no other name
    # is given
    if script_args.alert_name is None:
        script_args.alert_name = script_args.recipient_email

    # use existing config from argument
    if not script_args.scan_config_id:
        config_id = get_config(gmp, script_args.config)
    else:
        config_id = script_args.scan_config_id

    # create new target or use existing one from id
    if not script_args.target_id:
        target_id = get_target(
            gmp,
            target_name=script_args.target_id,
            hosts=script_args.hosts,
            ports=script_args.ports,
            port_list_name=script_args.port_list_name,
            port_list_id=script_args.port_list_id,
        )
    else:
        target_id = script_args.target_id
    alert_id = get_alert(
        gmp,
        script_args.sender_email,
        script_args.recipient_email,
        script_args.alert_name,
    )
    scanner_id = get_scanner(gmp)

    create_and_start_task(
        gmp, config_id, target_id, scanner_id, alert_id, script_args.alert_name
    )

    print("\nScript finished\n")


if __name__ == '__gmp__':
    main(gmp, args)



1			# -- coding: utf-8 --
2			# Copyright (C) 2018 Henning Häcker
3			#
4			# SPDX-License-Identifier: GPL-3.0-or-later
5			#
6			# This program is free software: you can redistribute it and/or modify
7			# it under the terms of the GNU General Public License as published by
8			# the Free Software Foundation, either version 3 of the License, or
9			# (at your option) any later version.
10			#
11			# This program is distributed in the hope that it will be useful,
12			# but WITHOUT ANY WARRANTY; without even the implied warranty of
13			# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14			# GNU General Public License for more details.
15			#
16			# You should have received a copy of the GNU General Public License
17			# along with this program. If not, see <http://www.gnu.org/licenses/>.
18
19			from typing import List
20			from argparse import ArgumentParser, RawTextHelpFormatter
21
22
23			HELP_TEXT = """
24			This script makes an E-Mail alert scan.
25
26			Usage examples:
27			$ gvm-script --gmp-username name --gmp-password pass ssh --hostname
28			... start-alert-scan.gmp.py +h
29			... start-alert-scan.gmp.py ++target-name ++hosts ++ports \
30			++port-list-name +C ++recipient ++sender
31			... start-alert-scan.gmp.py ++target-name ++hosts ++port-list-id \
32			+C ++recipient ++sender
33			... start-alert-scan.gmp.py ++target-id +C ++recipient ++sender
34			"""
35
36
37			def get_config(gmp, config, debug=False):
38			# get all configs of the openvas instance
39			# filter for all rows!
40			res = gmp.get_configs(filter="rows=-1")
41
42			if config < 0 or config > 4:
43			raise ValueError("Wrong config identifier. Choose between [0,4].")
44			# match the config abbreviation to accepted config names
45			config_list = [
46			'Full and fast',
47			'Full and fast ultimate',
48			'Full and very deep',
49			'Full and very deep ultimate',
50			'System Discovery',
51			]
52			template_abbreviation_mapper = {
53			0: config_list[0],
54			1: config_list[1],
55			2: config_list[2],
56			3: config_list[3],
57			4: config_list[4],
58			}
59
60			for conf in res.xpath('config'):
61			cid = conf.xpath('@id')[0]
62			name = conf.xpath('name/text()')[0]
63
64			# get the config id of the desired template
65			if template_abbreviation_mapper.get(config) == name:
66			config_id = cid
67			if debug:
68			print(name + ": " + config_id)
69			break
70
71			return config_id
			0 ignored issues – show introduced 2020-12-08 23:30 UTC by Report Bug Copy Issue Report The variable `config_id` does not seem to be defined for all execution paths. Loading history...
72
73
74			def get_target(
75			gmp,
76			target_name: str = None,
77			hosts: List[str] = None,
78			ports: str = None,
79			port_list_name: str = None,
80			port_list_id: str = None,
81			debug: bool = False,
82			):
83			targets = gmp.get_targets()
84			counter = 0
85			exists = True
86			# iterate over existing targets and find a vacant targetName
87			while exists:
88			exists = False
89			if target_name is None:
90			target_name = "target_{}".format(str(counter))
91			for target in targets.xpath('target'):
92			name = target.xpath('name/text()')[0]
93			if name == target_name:
94			exists = True
95			break
96			counter += 1
97
98			if debug:
99			print("target name: {}".format(target_name))
100
101			if not port_list_id:
102			# iterate over existing port lists and find a vacant name
103			existing_port_lists = [""]
104			for name in gmp.get_port_lists().findall("port_list/name"):
105			existing_port_lists.append(str(name.text))
106
107			if port_list_name is None:
108			port_list_name = "portlist_{}".format(str(counter))
109			counter = 0
110			while True:
111			if port_list_name not in existing_port_lists:
112			break
113			counter += 1
114
115			# create port list
116			portlist = gmp.create_port_list(port_list_name, ports)
117			port_list_id = portlist.xpath('@id')[0]
118			if debug:
119			print("New Portlist-name:\t{}".format(str(port_list_name)))
120			print("New Portlist-id:\t{}".format(str(port_list_id)))
121
122			# integrate port list id into create_target
123			res = gmp.create_target(target_name, hosts=hosts, port_list_id=port_list_id)
124			return res.xpath('@id')[0]
125
126
127			def get_alert(
128			gmp,
129			sender_email: str,
130			recipient_email: str,
131			alert_name: str = None,
132			debug=False,
133			):
134
135			# create alert if necessary
136			alert_object = gmp.get_alerts(filter='name={}'.format(alert_name))
137			alert = alert_object.xpath('alert')
138
139			if len(alert) == 0:
140			print("creating new alert {}".format(alert_name))
141			gmp.create_alert(
142			alert_name,
143			event=gmp.types.AlertEvent.TASK_RUN_STATUS_CHANGED,
144			event_data={"status": "Done"},
145			condition=gmp.types.AlertCondition.ALWAYS,
146			method=gmp.types.AlertMethod.EMAIL,
147			method_data={
148			"""Task '$n': $e
149
150			After the event $e,
151			the following condition was met: $c
152
153			This email escalation is configured to attach report format '$r'.
154			Full details and other report formats are available on the scan engine.
155
156			$t
157
158			Note:
159			This email was sent to you as a configured security scan escalation.
160			Please contact your local system administrator if you think you
161			should not have received it.
162			""": "message",
163			"2": "notice",
164			sender_email: "from_address",
165			"[OpenVAS-Manager] Task": "subject",
166			"c402cc3e-b531-11e1-9163-406186ea4fc5": "notice_attach_format",
167			recipient_email: "to_address",
168			},
169			)
170
171			alert_object = gmp.get_alerts(filter='name={}'.format(recipient_email))
172			alert = alert_object.xpath('alert')
173
174			alert_id = alert[0].get('id', 'no id found')
175			if debug:
176			print("alert_id: {}".format(str(alert_id)))
177
178			return alert_id
179
180
181			def get_scanner(gmp):
182			res = gmp.get_scanners()
183			scanner_ids = res.xpath('scanner/@id')
184			return scanner_ids[1] # default scanner
185
186
187			def create_and_start_task(
188			gmp,
189			config_id: str,
190			target_id: str,
191			scanner_id: str,
192			alert_id: str,
193			alert_name: str,
194			debug: bool = False,
195			):
196			# Create the task
197			tasks = gmp.get_tasks(filter="name~{}".format(alert_name))
198			task_name = "Alert Scan for Alert {}".format(alert_name)
199			if tasks:
200			task_name = "Alert Scan for Alert {} ({})".format(
201			alert_name, len(tasks.xpath('tasks/@id'))
202			)
203			task_comment = "Alert Scan"
204			res = gmp.create_task(
205			task_name,
206			config_id,
207			target_id,
208			scanner_id,
209			alert_ids=[alert_id],
210			comment=task_comment,
211			)
212
213			# Start the task
214			task_id = res.xpath('@id')[0]
215			gmp.start_task(task_id)
216
217			print('Task started: ' + task_name)
218
219			if debug:
220			# Stop the task (for performance reasons)
221			gmp.stop_task(task_id)
222			print('Task stopped')
223
224
225			def main(gmp, args):
226			# pylint: disable=undefined-variable, unused-argument
227
228			parser = ArgumentParser(
229			prefix_chars="+",
230			add_help=False,
231			formatter_class=RawTextHelpFormatter,
232			description=HELP_TEXT,
233			)
234
235			parser.add_argument(
236			"+h",
237			"++help",
238			action="help",
239			help="Show this help message and exit.",
240			)
241
242			target = parser.add_mutually_exclusive_group(required=True)
243
244			target.add_argument(
245			"++target-id",
246			type=str,
247			dest="target_id",
248			help="Use an existing by target id",
249			)
250
251			target.add_argument(
252			"++target-name",
253			type=str,
254			dest="target_name",
255			help="Create a target by name",
256			)
257
258			parser.add_argument(
259			"++hosts",
260			nargs='+',
261			dest='hosts',
262			help="Host(s) for the new target",
263			)
264
265			ports = parser.add_mutually_exclusive_group()
266
267			ports.add_argument(
268			"++port-list-id",
269			type=str,
270			dest="port_list_id",
271			help="An existing portlist id for the new target",
272			)
273			ports.add_argument(
274			"++ports",
275			type=str,
276			dest='ports',
277			help="Ports in the new target: e.g. T:80-80,8080",
278			)
279
280			parser.add_argument(
281			"++port-list-name",
282			type=str,
283			dest="port_list_name",
284			help="Name for the new portlist in the new target",
285			)
286
287			config = parser.add_mutually_exclusive_group()
288
289			config.add_argument(
290			"+C",
291			"++scan_config",
292			default=0,
293			type=int,
294			dest='config',
295			help="Choose from existing scan config:"
296			" 0: Full and fast"
297			" 1: Full and fast ultimate"
298			" 2: Full and very deep"
299			" 3: Full and very deep ultimate"
300			" 4: System Discovery",
301			)
302
303			config.add_argument(
304			"++scan_config_id",
305			default=0,
306			type=int,
307			dest='scan_config_id',
308			help="Use existing scan config by id",
309			)
310
311			parser.add_argument(
312			"++recipient",
313			required=True,
314			dest='recipient_email',
315			type=str,
316			help="Alert recipient E-Mail address",
317			)
318
319			parser.add_argument(
320			"++sender",
321			required=True,
322			dest='sender_email',
323			type=str,
324			help="Alert senders E-Mail address",
325			)
326
327			parser.add_argument(
328			"++alert-name",
329			dest='alert_name',
330			type=str,
331			help="Optional Alert name",
332			)
333
334			script_args, _ = parser.parse_known_args()
335
336			# set alert_name to recipient email if no other name
337			# is given
338			if script_args.alert_name is None:
339			script_args.alert_name = script_args.recipient_email
340
341			# use existing config from argument
342			if not script_args.scan_config_id:
343			config_id = get_config(gmp, script_args.config)
344			else:
345			config_id = script_args.scan_config_id
346
347			# create new target or use existing one from id
348			if not script_args.target_id:
349			target_id = get_target(
350			gmp,
351			target_name=script_args.target_id,
352			hosts=script_args.hosts,
353			ports=script_args.ports,
354			port_list_name=script_args.port_list_name,
355			port_list_id=script_args.port_list_id,
356			)
357			else:
358			target_id = script_args.target_id
359			alert_id = get_alert(
360			gmp,
361			script_args.sender_email,
362			script_args.recipient_email,
363			script_args.alert_name,
364			)
365			scanner_id = get_scanner(gmp)
366
367			create_and_start_task(
368			gmp, config_id, target_id, scanner_id, alert_id, script_args.alert_name
369			)
370
371			print("\nScript finished\n")
372
373
374			if __name__ == '__gmp__':
375			main(gmp, args)
			0 ignored issues – show Comprehensibility Best Practice introduced 2020-03-19 10:34 UTC by Report Bug Copy Issue Report The variable `args` does not seem to be defined. Loading history... Comprehensibility Best Practice introduced 2020-03-19 10:34 UTC by Report Bug Copy Issue Report The variable `gmp` does not seem to be defined. Loading history...
376

greenbone / gvm-tools

Pull Request — master (#344)

start-alert-scan.gmp.main() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like