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
186
187
188
|
(tools)=
# Provided Tools
Currently, {program}`gvm-tools` comes with three command line interface
programs:
- {ref}`gvm-cli <gvm-cli>`
- {ref}`gvm-script <gvm-script>`
- {ref}`gvm-pyshell <gvm-pyshell>`
All of these programs are clients communicating either via
{term}`Greenbone Management Protocol (GMP) <GMP>`
or {term}`Open Scanner Protocol (OSP) <OSP>`. The
{ref}`connection <connection_types>` is established using a
{ref}`TLS <tls_connection_type>`, {ref}`SSH <ssh_connection_type>` or
{ref}`Unix Domain Socket <socket_connection_type>` communication channel.
All tools take several arguments and parameters. {program}`gvm-tools` allows
setting defaults for most of these in a configuration file. See {doc}`config`
for details about the possible settings and capabilities.
(gvm-cli)=
## gvm-cli
{program}`gvm-cli` is a low level tool which offers sending and receiving
commands and responses for the XML-based {term}`GMP <GMP>` and {term}`OSP <OSP>`
directly via the command line. It is intended for {ref}`simple scripting <xml_scripting>`
via shell.
```shell
> gvm-cli --help
usage: gvm-cli [-h] [-c [CONFIG]]
[--log [{DEBUG,INFO,WARNING,ERROR,CRITICAL}]]
[--timeout TIMEOUT] [--gmp-username GMP_USERNAME]
[--gmp-password GMP_PASSWORD] [-V]
CONNECTION_TYPE ...
optional arguments:
-h, --help show this help message and exit
-c [CONFIG], --config [CONFIG]
Configuration file path (default: ~/.config/gvm-
tools.conf)
--log [{DEBUG,INFO,WARNING,ERROR,CRITICAL}]
Activate logging (default level: None)
--timeout TIMEOUT Response timeout in seconds, or -1 to wait
indefinitely (default: 60)
--gmp-username GMP_USERNAME
Username for GMP service (default: '')
--gmp-password GMP_PASSWORD
Password for GMP service (default: '')
-V, --version Show version information and exit
connections:
valid connection types
CONNECTION_TYPE Connection type to use
ssh Use SSH to connect to service
tls Use TLS secured connection to connect to service
socket Use UNIX Domain socket to connect to service
```
Examples:
```shell
> gvm-cli socket --xml "<get_version/>"
<get_version_response status="200" status_text="OK"><version>7.0</version></get_version_response>
> gvm-cli socket --xml "<get_tasks/>"
<get_tasks_response status="200" status_text="OK">
...
</get_tasks_response>
> gvm-cli socket < commands.xml
```
(gvm-script)=
## gvm-script
```{versionadded} 2.0
```
{program}`gvm-script` allows running {ref}`gvm scripts <gvm_scripting>`
which are Python based scripts calling the [python-gvm API]. Depending on the
{command}`--protocol` argument a global gmp or osp object is passed to the
script.
```{note}
{program}`gvm-script` is only available with {program}`gvm-tools` version 2.0 and beyond.
```
```shell
usage: gvm-script [-h] [-c [CONFIG]]
[--log [{DEBUG,INFO,WARNING,ERROR,CRITICAL}]]
[--timeout TIMEOUT] [--gmp-username GMP_USERNAME]
[--gmp-password GMP_PASSWORD] [-V] [--protocol {GMP,OSP}]
CONNECTION_TYPE ...
optional arguments:
-h, --help show this help message and exit
-c [CONFIG], --config [CONFIG]
Configuration file path (default: ~/.config/gvm-
tools.conf)
--log [{DEBUG,INFO,WARNING,ERROR,CRITICAL}]
Activate logging (default level: None)
--timeout TIMEOUT Response timeout in seconds, or -1 to wait
indefinitely (default: 60)
--gmp-username GMP_USERNAME
Username for GMP service (default: '')
--gmp-password GMP_PASSWORD
Password for GMP service (default: '')
-V, --version Show version information and exit
--protocol {GMP,OSP} Service protocol to use (default: GMP)
connections:
valid connection types
CONNECTION_TYPE Connection type to use
ssh Use SSH to connect to service
tls Use TLS secured connection to connect to service
socket Use UNIX Domain socket to connect to service
```
(gvm-pyshell)=
## gvm-pyshell
{program}`gvm-pyshell` is a tool to use the [python-gvm API] interactively.
Running the tool will open a Python interpreter in the [interactive mode](https://docs.python.org/3/tutorial/interpreter.html#interactive-mode)
providing a global gmp or osp object depending on the {command}`--protocol`
argument.
The interactive shell can be exited with:
- {kbd}`Ctrl+D` on Linux or
- {kbd}`Ctrl+Z` on Windows
```shell
> gvm-pyshell --help
usage: gvm-pyshell [-h] [-c [CONFIG]]
[--log [{DEBUG,INFO,WARNING,ERROR,CRITICAL}]]
[--timeout TIMEOUT] [--gmp-username GMP_USERNAME]
[--gmp-password GMP_PASSWORD] [-V] [--protocol {GMP,OSP}]
CONNECTION_TYPE ...
optional arguments:
-h, --help show this help message and exit
-c [CONFIG], --config [CONFIG]
Configuration file path (default: ~/.config/gvm-
tools.conf)
--log [{DEBUG,INFO,WARNING,ERROR,CRITICAL}]
Activate logging (default level: None)
--timeout TIMEOUT Response timeout in seconds, or -1 to wait
indefinitely (default: 60)
--gmp-username GMP_USERNAME
Username for GMP service (default: '')
--gmp-password GMP_PASSWORD
Password for GMP service (default: '')
-V, --version Show version information and exit
--protocol {GMP,OSP} Service protocol to use (default: GMP)
connections:
valid connection types
CONNECTION_TYPE Connection type to use
ssh Use SSH to connect to service
tls Use TLS secured connection to connect to service
socket Use UNIX Domain socket to connect to service
```
Example:
```python
> gvm-pyshell socket
GVM Interactive Console 2.0.0 API 1.0.0. Type "help" to get information about functionality.
>>> gmp.get_protocol_version()
'7'
>>> gmp.get_version().get('status')
'200'
>>> gmp.get_version()[0].text
'7.0'
>>> [t.find('name').text for t in tasks.xpath('task')]
['Scan Task', 'Simple Scan', 'Host Discovery']
```
[python-gvm api]: https://greenbone.github.io/python-gvm/
|
