forked from greenbone/gvm-tools
-
Notifications
You must be signed in to change notification settings - Fork 0
/
update-task-target.gmp.py
172 lines (130 loc) · 4.84 KB
/
update-task-target.gmp.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
# -*- coding: utf-8 -*-
# Copyright (C) 2017-2021 Greenbone AG
#
# 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/>.
import time
from argparse import ArgumentParser, FileType, Namespace, RawTextHelpFormatter
from typing import List
from gvm.protocols.gmp import Gmp
from gvmtools.helper import error_and_exit
HELP_TEXT = (
"This script will update target hosts information for a desired task.\n"
'The given task needs to have the status "new".\n\n'
"Example for starting up the routine:\n"
" $ gvm-script --gmp-username name --gmp-password pass "
"ssh --hostname <gsm> scripts/update-task-target.gmp.py +hf hosts_file.csv "
"+t 303fa0a6-aa9b-43c4-bac0-66ae0b2d1698"
)
def parse_args(args: Namespace) -> Namespace: # pylint: disable=unused-argument
"""Parsing args ..."""
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.",
)
parser.add_argument(
"+t",
"++task-id",
type=str,
required=True,
dest="task_id",
help="UUID of task to be modified",
)
hosts_args = parser.add_mutually_exclusive_group()
hosts_args.add_argument(
"+hl",
"++host-list",
nargs="+",
type=str,
dest="host_list",
help="Use the given hosts (IPs) for the new target.",
)
hosts_args.add_argument(
"+hf",
"++host-file",
type=FileType("r"),
dest="host_file",
help=".csv file containing desired target hosts separated by ','",
)
script_args, _ = parser.parse_known_args()
return script_args
def load_host_file(filename) -> List[str]:
host_list = list()
try:
for line in filename.readlines():
host = line.split(",")[0]
host = host.strip()
if len(host) == 0:
continue
host_list.append(host)
except IOError as e:
error_and_exit(f"Failed to read host_file: {str(e)} (exit)")
if len(host_list) == 0:
error_and_exit("Host file is empty (exit)")
return host_list
def copy_send_target(gmp, host_list, old_target_id):
keywords = {"hosts": host_list}
keywords["comment"] = (
"This target was automatically "
f'modified: {time.strftime("%Y/%m/%d-%H:%M:%S")}'
)
old_target = gmp.get_target(target_id=old_target_id)[0]
objects = ("reverse_lookup_only", "reverse_lookup_unify", "name")
for obj in objects:
var = old_target.xpath(f"{obj}/text()")[0]
if var == "0":
var = ""
keywords[f"{obj}"] = var
port_list = {}
port_list = old_target.xpath("port_list/@id")[0]
keywords["port_list_id"] = port_list
keywords["name"] += "_copy" # the name must differ from existing names
new_target_id = gmp.create_target(**keywords).xpath("@id")[0]
print("\n New target created!\n")
print(f"Target_id: {new_target_id}")
print(f'Target_name: {keywords["name"]}\n')
return new_target_id
def create_target_hosts(gmp: Gmp, host_file, task_id, old_target_id):
new_target_id = copy_send_target(gmp, host_file, old_target_id)
gmp.modify_task(task_id=task_id, target_id=new_target_id)
print(" Task successfully modified!\n")
def check_to_delete(gmp: Gmp, target_id: str) -> None:
target = gmp.get_target(target_id=target_id)[0]
if "0" in target.xpath("in_use/text()"):
gmp.delete_target(target_id=target_id)
def main(gmp: Gmp, args: Namespace) -> None:
# pylint: disable=undefined-variable
parsed_args = parse_args(args=args)
host_list = parsed_args.host_list
if parsed_args.host_file:
host_list = load_host_file(filename=parsed_args.host_file)
task_id = parsed_args.task_id
task = gmp.get_task(task_id=task_id)[1]
old_target_id = task.xpath("target/@id")[0]
if old_target_id:
create_target_hosts(gmp, host_list, task_id, old_target_id)
check_to_delete(gmp, old_target_id)
else:
error_and_exit("The given task doesn't have an existing target.")
if __name__ == "__gmp__":
main(gmp, args)