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
|
# -*- coding: utf-8 -*-
# SPDX-FileCopyrightText: 2018-2024 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 os
import sys
import traceback
from argparse import Namespace
from gvm import get_version as get_gvm_version
from gvm.protocols.gmp import Gmp
from gvm.protocols.latest import Osp
from gvm.transforms import EtreeCheckCommandTransform
from gvmtools import get_version
from gvmtools.helper import authenticate, do_not_run_as_root, run_script
from gvmtools.parser import (
PROTOCOL_GMP,
PROTOCOL_OSP,
create_connection,
create_parser,
)
HELP_TEXT = """
Command line tool to execute custom GMP (Greenbone Management
Protocol) and OSP (Open Scanner Protocol) scripts.
The protocol specifications for GMP and OSP are available at:
https://docs.greenbone.net/index.html#api_documentation
"""
__version__ = get_version()
__api_version__ = get_gvm_version()
def main():
do_not_run_as_root()
parser = create_parser(description=HELP_TEXT, logfilename="gvm-script.log")
parser.add_protocol_argument()
parser.add_argument(
"scriptname",
metavar="SCRIPT",
help="Path to script to be executed (example: myscript.gmp.py)",
)
parser.add_argument(
"scriptargs", nargs="*", metavar="ARG", help="Arguments for the script"
)
args, script_args = parser.parse_known_args()
connection = create_connection(**vars(args))
transform = EtreeCheckCommandTransform()
global_vars = {
"__version__": __version__,
"__api_version__": __api_version__,
}
username = None
password = None
if args.protocol == PROTOCOL_OSP:
protocol_class = Osp
name = "osp"
else:
protocol_class = Gmp
name = "gmp"
try:
with protocol_class(connection, transform=transform) as protocol:
global_vars[name] = protocol
global_vars["__name__"] = f"__{name}__"
if args.protocol == PROTOCOL_GMP:
if args.gmp_username:
(username, password) = authenticate(
protocol,
username=args.gmp_username,
password=args.gmp_password,
)
argv = [os.path.abspath(args.scriptname), *args.scriptargs]
shell_args = Namespace(
username=username,
password=password,
argv=argv,
# for backwards compatibility we add script here
script=argv,
# the unknown args, which are owned by the script.
script_args=script_args,
)
global_vars["args"] = shell_args
run_script(args.scriptname, global_vars)
except Exception: # pylint: disable=broad-except
print(traceback.format_exc())
sys.exit(1)
sys.exit(0)
if __name__ == "__main__":
main()
|
