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
173
174
175
176
177
178
179
180
181
182
183
184
185
|
# -*- 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 code
import logging
import os
import sys
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 gvm.xml import pretty_print
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,
)
__version__ = get_version()
__api_version__ = get_gvm_version()
logger = logging.getLogger(__name__)
HELP_TEXT = """
Command line tool to access services via GMP (Greenbone Management
Protocol) and OSP (Open Scanner Protocol)
gvm-pyshell provides an interactive shell for GMP and OSP services.
Example:
>>> tasks = gmp.get_tasks()
>>> task_names = tasks.xpath('task/name/text()')
>>> print(task_names)
['Scan Task']
>>> pretty_print('<xml/>')
<xml/>
The interactive shell can be exited with:
Ctrl + D on Linux or
Ctrl + Z on Windows
The protocol specifications for GMP and OSP are available at:
https://docs.greenbone.net/index.html#api_documentation"""
class Help(object):
"""Help class to overwrite the help function from python itself."""
def __call__(self):
return print(HELP_TEXT)
def __repr__(self):
# do pwd command
return HELP_TEXT
def main():
do_not_run_as_root()
parser = create_parser(description=HELP_TEXT, logfilename="gvm-pyshell.log")
parser.add_protocol_argument()
parser.add_argument(
"-i",
"--interactive",
action="store_true",
default=False,
help="Start an interactive Python shell",
)
parser.add_argument(
"scriptname",
nargs="?",
metavar="SCRIPT",
help="Path to script to be preloaded (example: myscript.gmp.py)",
)
parser.add_argument(
"scriptargs",
nargs="*",
metavar="ARG",
help="Arguments for preloaded script",
)
args = parser.parse_args()
connection = create_connection(**vars(args))
transform = EtreeCheckCommandTransform()
global_vars = {
"help": Help(),
"pretty_print": pretty_print,
"__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"
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,
)
shell_args = Namespace(username=username, password=password)
global_vars["args"] = shell_args
with_script = args.scriptname and len(args.scriptname) > 0
if with_script:
argv = [os.path.abspath(args.scriptname), *args.scriptargs]
shell_args.argv = argv
# for backwards compatibility we add script here
shell_args.script = argv
no_script_no_interactive = not args.interactive and not with_script
script_and_interactive = args.interactive and with_script
only_interactive = not with_script and args.interactive
only_script = not args.interactive and with_script
if only_interactive or no_script_no_interactive:
enter_interactive_mode(global_vars)
if script_and_interactive or only_script:
if only_script:
print(
"Using gvm-pyshell for running scripts only is deprecated. "
"Please use gvm-script instead",
file=sys.stderr,
)
script_name = args.scriptname
run_script(script_name, global_vars)
if not only_script:
enter_interactive_mode(global_vars)
def enter_interactive_mode(global_vars):
code.interact(
banner=f"GVM Interactive Console {__version__} API {__api_version__}."
'Type "help" to get information about functionality.',
local=dict(global_vars),
)
if __name__ == "__main__":
main()
|
