{
"info": {
"author": "Greenbone Networks GmbH",
"author_email": "info@greenbone.net",
"bugtrack_url": null,
"classifiers": [
"Development Status :: 5 - Production/Stable",
"Environment :: Console",
"Intended Audience :: Developers",
"Intended Audience :: System Administrators",
"License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
"Operating System :: OS Independent",
"Programming Language :: Python :: 3.5",
"Programming Language :: Python :: 3.6",
"Programming Language :: Python :: 3.7",
"Programming Language :: Python :: 3.8",
"Topic :: Software Development :: Libraries :: Python Modules"
],
"description": "\n\n# Greenbone Vulnerability Management Tools \n[](https://github.com/greenbone/gvm-tools/releases)\n[](https://pypi.org/project/gvm-tools/)\n[](https://scrutinizer-ci.com/g/greenbone/gvm-tools/?branch=master)\n[](https://codecov.io/gh/greenbone/gvm-tools)\n[](https://circleci.com/gh/greenbone/gvm-tools/tree/master)\n\nThe Greenbone Vulnerability Management Tools or gvm-tools in short\nare a collection of tools that help with remote controlling a\nGreenbone Security Manager (GSM) appliance and its underlying Greenbone\nVulnerability Manager (GVM). The tools essentially aid accessing the\ncommunication protocols GMP (Greenbone Management Protocol) and OSP\n(Open Scanner Protocol).\n\nThis module is comprised of interactive and non-interactive clients.\nThe programming language Python is supported directly for interactive scripting.\nBut it is also possible to issue remote GMP/OSP commands without programming in\nPython.\n\n\n## Table of Contents \n- [Documentation](#documentation)\n- [Installation](#installation)\n - [Requirements](#requirements)\n - [Install using pip](#install-using-pip)\n- [Usage](#usage)\n - [gvm-cli](#gvm-cli)\n - [Example program use](#example-program-use)\n - [gvm-script](#gvm-script)\n - [Example script](#example-script)\n - [More example scripts](#more-example-scripts)\n - [gvm-pyshell](#gvm-pyshell)\n - [Example program use](#example-program-use-1)\n- [Support](#support)\n- [Maintainer](#maintainer)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Documentation\n\nThe documentation for gvm-tools can be found at\n[https://gvm-tools.readthedocs.io/](https://gvm-tools.readthedocs.io/). Please\nalways take a look at the documentation for further details. This README just\ngives you a short overview.\n\n## Installation\n\nSee the [documentation](https://gvm-tools.readthedocs.io/en/latest/install.html)\nfor all supported installation options.\n\n### Requirements\n\nPython 3.5 and later is supported.\n\n### Install using pip\n\nYou can install the latest stable release of gvm-tools from the Python Package\nIndex using [pip](https://pip.pypa.io/):\n\n pip install --user gvm-tools\n\n## Usage\n\nThere are several clients to communicate via GMP/OSP.\n\nAll clients have the ability to build a connection in various ways:\n\n * Unix Socket\n * TLS Connection\n * SSH Connection\n\n### gvm-cli\n\nThis little tool sends plain GMP/OSP commands and prints the result to\nthe standard output. When the program is used without any parameters, it\nasks for an XML command and for the user credentials.\n\n#### Example program use\n\nReturns the current version.\n\n```\ngvm-cli socket --xml \"\"\n```\n\nReturns the current version using a TLS connection with certificates.\n\n```\ngvm-cli tls --hostname 192.168.0.10 --port 1234 --certfile '/tmp/certs/cert.pem' --keyfile '/tmp/certs/key.pem' --cafile '/tmp/certs/cert.pem' --xml \"\"\n```\n\nReturn all\ntasks.\n\n```\ngvm-cli socket --xml \"myusermypass\"\n```\n\nReads a file with GMP commands and return the result.\n\n```\ngvm-cli --gmp-username foo --gmp-password socket bar < myfile.xml\n```\n\nNote that `gvm-cli` will by default raise an exception when a command is\nrejected by the server. If this kind of error handling is not desired, the\nunparsed XML response can be requested using the `--raw` parameter:\n\n```\ngvm-cli socket --raw --xml \"\"\n\n```\n\n### gvm-script\n\nThis tool has a lot more features than the simple gvm-cli client. You\nhave the possibility to create your own custom gmp or osp scripts with commands\nfrom the [python-gvm library](https://github.com/greenbone/python-gvm) and from\nPython 3 itself.\n\n#### Example script\n\n```\n# Retrieve current GMP version\nversion = gmp.get_version()\n\n# Prints the XML in beautiful form\nfrom gvmtools.helper import pretty_print\npretty_print(version)\n\n# Retrieve all tasks\ntasks = gmp.get_tasks()\n\n# Get names of tasks\ntask_names = tasks.xpath('task/name/text()')\npretty_print(task_names)\n```\n\n#### More example scripts\n\nThere is a growing collection of gmp-scripts in the\n[\"scripts/\"](scripts/) folder.\nSome of them might be exactly what you need and all of them help writing\nyour own gmp scripts.\n\n### gvm-pyshell\n\nThis tool is for running gmp or osp scripts interactively. It provides the same\nAPI as [gvm-script](#gvm-script) using the\n[python-gvm library](https://github.com/greenbone/python-gvm).\n\n#### Example program use\n\nConnect with given credentials via a unix domain socket and open an interactive\nshell.\n\n```\ngvm-pyshell socket --gmp-username=user --gmp-password=pass -i\n```\n\nConnect through SSH connection and open the interactive shell.\n\n```\ngvm-pyshell ssh --hostname=127.0.0.1 -i\n```\n\n## Support\n\nFor any question on the usage of gvm-tools or gmp scripts please use the\n[Greenbone Community Portal](https://community.greenbone.net/c/gmp). If you\nfound a problem with the software, please\n[create an issue](https://github.com/greenbone/gvm-tools/issues) on GitHub.\n\n## Maintainer\n\nThis project is maintained by [Greenbone Networks GmbH](https://www.greenbone.net/).\n\n## Contributing\n\nYour contributions are highly appreciated. Please\n[create a pull request](https://github.com/greenbone/gvm-tools/pulls) on GitHub.\nFor bigger changes, please discuss it first in the\n[issues](https://github.com/greenbone/gvm-tools/issues).\n\nFor development you should use [pipenv](https://pipenv.readthedocs.io/en/latest/)\nto keep you python packages separated in different environments. First install\npipenv via pip\n\n pip install --user pipenv\n\nAfterwards run\n\n pipenv install --dev\n\nin the checkout directory of gvm-tools (the directory containing the Pipfile) to\ninstall all dependencies including the packages only required for development.\n\n## License\n\nCopyright (C) 2017-2018 [Greenbone Networks GmbH](https://www.greenbone.net/)\n\nLicensed under the [GNU General Public License v3.0 or later](LICENSE).\n\n\n",
"description_content_type": "text/markdown",
"docs_url": null,
"download_url": "",
"downloads": {
"last_day": -1,
"last_month": -1,
"last_week": -1
},
"home_page": "https://github.com/greenbone/gvm-tools",
"keywords": "",
"license": "",
"maintainer": "",
"maintainer_email": "",
"name": "gvm-tools",
"package_url": "https://pypi.org/project/gvm-tools/",
"platform": "",
"project_url": "https://pypi.org/project/gvm-tools/",
"project_urls": {
"Homepage": "https://github.com/greenbone/gvm-tools"
},
"release_url": "https://pypi.org/project/gvm-tools/2.0.0/",
"requires_dist": [
"python-gvm"
],
"requires_python": ">=3.5",
"summary": "Tools to control a GSM/GVM over GMP or OSP",
"version": "2.0.0"
},
"last_serial": 5855154,
"releases": {
"2.0.0": [
{
"comment_text": "",
"digests": {
"md5": "ec5b4a800356d4141a55283b240c8fa9",
"sha256": "6c064b207fa229ba43a132ee692d651451753c1e3bb7371a041d1cf1eb2d6c95"
},
"downloads": -1,
"filename": "gvm_tools-2.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ec5b4a800356d4141a55283b240c8fa9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.5",
"size": 33255,
"upload_time": "2019-09-19T09:32:51",
"url": "https://files.pythonhosted.org/packages/33/70/a8486e5445ad5ecb06052a21c76c33300e91dbbc57a11c72caac6b7de548/gvm_tools-2.0.0-py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "45a7e99e5f195953272b1ded0504c1d1",
"sha256": "10568c6c60f52da1781d4d11d660294c6413e3e6984ee346bf5d613b417ff126"
},
"downloads": -1,
"filename": "gvm-tools-2.0.0.tar.gz",
"has_sig": false,
"md5_digest": "45a7e99e5f195953272b1ded0504c1d1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.5",
"size": 56658,
"upload_time": "2019-09-19T09:32:53",
"url": "https://files.pythonhosted.org/packages/97/3b/76fe496f2d75cf90ad036484144442969c1ab39da5f19488f5fbb8f972d2/gvm-tools-2.0.0.tar.gz"
}
],
"2.0.0b1": [
{
"comment_text": "",
"digests": {
"md5": "026dcbaa6d54cdaf580cb97a3130bdfe",
"sha256": "5533ee2b042c74531f21de66211e6790cd937198bd27f22d51a9db887b05da2f"
},
"downloads": -1,
"filename": "gvm_tools-2.0.0b1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "026dcbaa6d54cdaf580cb97a3130bdfe",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3",
"size": 25272,
"upload_time": "2018-11-13T09:14:03",
"url": "https://files.pythonhosted.org/packages/70/f0/b64613f452b5b08088dba3b5913535d725b79a1ea33765a5d76238fa77fc/gvm_tools-2.0.0b1-py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "74c0b17617f20e8c2a276cb78350f776",
"sha256": "a7e5d6ae38fe4ccbf5457a49a8859f307af0d46659ef0c9dd753897fc9f981e8"
},
"downloads": -1,
"filename": "gvm-tools-2.0.0b1.tar.gz",
"has_sig": false,
"md5_digest": "74c0b17617f20e8c2a276cb78350f776",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3",
"size": 31924,
"upload_time": "2018-11-13T09:14:05",
"url": "https://files.pythonhosted.org/packages/87/df/84d8bfb6a7f4c01a9e7fdcde3d48edf72242e422f8fd58c63e7492c7d5f4/gvm-tools-2.0.0b1.tar.gz"
}
]
},
"urls": [
{
"comment_text": "",
"digests": {
"md5": "ec5b4a800356d4141a55283b240c8fa9",
"sha256": "6c064b207fa229ba43a132ee692d651451753c1e3bb7371a041d1cf1eb2d6c95"
},
"downloads": -1,
"filename": "gvm_tools-2.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ec5b4a800356d4141a55283b240c8fa9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.5",
"size": 33255,
"upload_time": "2019-09-19T09:32:51",
"url": "https://files.pythonhosted.org/packages/33/70/a8486e5445ad5ecb06052a21c76c33300e91dbbc57a11c72caac6b7de548/gvm_tools-2.0.0-py3-none-any.whl"
},
{
"comment_text": "",
"digests": {
"md5": "45a7e99e5f195953272b1ded0504c1d1",
"sha256": "10568c6c60f52da1781d4d11d660294c6413e3e6984ee346bf5d613b417ff126"
},
"downloads": -1,
"filename": "gvm-tools-2.0.0.tar.gz",
"has_sig": false,
"md5_digest": "45a7e99e5f195953272b1ded0504c1d1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.5",
"size": 56658,
"upload_time": "2019-09-19T09:32:53",
"url": "https://files.pythonhosted.org/packages/97/3b/76fe496f2d75cf90ad036484144442969c1ab39da5f19488f5fbb8f972d2/gvm-tools-2.0.0.tar.gz"
}
]
}