| Name | scandeavour JSON |
| Version |
1.1.2
JSON |
| download |
| home_page | None |
| Summary | Dashboard for merging, visualising and filtering network scans |
| upload_time | 2025-02-11 20:18:21 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.12 |
| license | MIT License
Copyright (c) 2024 crackcat
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
|
| keywords |
nmap
nessus
dashboard
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<p align="center"><img src="https://github.com/user-attachments/assets/40965716-558c-4ab9-b8c6-2cb5dbf3e7c8" width="120px" /></p>
<h1 align="center">Scandeavour</h1>
<p align="center">
<a href="https://pypi.org/project/scandeavour/"><img alt="PyPI - Version" src="https://img.shields.io/pypi/v/scandeavour"></a>
<a href="https://github.com/Cr4ckC4t/scandeavour/blob/main/LICENSE"><img alt="PyPI - License" src="https://img.shields.io/pypi/l/scandeavour"></a>
</p>
<p align="center">
Dashboard for merging, visualising and filtering network scans.
</p>
## 🔨 Installation
```
pipx install scandeavour
```
## ✨ Features
- Load Nmap, Nessus and Masscan results (parsers are modular and can be added as plugins)
- View scans, hosts and open ports in an interactive graph with details for every node
- View all merged hosts in a dashboard
- Expand on host details (i.e. related scans, open ports, script outputs)
- Apply tags to hosts for custom prioritisation
- Chain modular drop-down filters to select relevant hosts based on their address, tag, open ports, script outputs, scans, OS, etc.
- Copy identified hosts and open ports to clipboard for a new scan
- Export hosts, ports and services to a CSV (e.g. for import in Word)
- Offline mode - once installed, no internet connection is required (a browser is required to access the dashboard though)
The following scanner outputs are supported. The main focus of this project lies on `nmap` but ingestors for other scanners can be integrated easily. Check out the [existing ingestors here](https://github.com/Cr4ckC4t/scandeavour/tree/main/src/scandeavour/ingestors) if you want to extend one or build your own.
|Tool|Source|Scan information| Open ports | Service detection | Script output |
|---|---|:---:|:---:|:---:|:---:|
|Nmap|`nmap -oX <output>` |✔|✔|✔|✔|
|Nessus|Nessus export|limited|✔|✔|✔|
|Masscan|`masscan -oX <output>` |⛔|✔|⛔|⛔|
|Masscan|`masscan \| tee <output>` |⛔|✔|⛔|⛔|
## 📖 Usage
To visualize your scan results, simply start
```
scandeavour my_project.db
```
This will create a new project database (SQLITE) in the current folder. It will be used to store all your merged scans. You can also checkout the [database schema](https://github.com/Cr4ckC4t/scandeavour/blob/main/src/scandeavour/setup_database.sqlite) if you want to interact with the data manually. The command will also start a Flask webserver running on a local port, exposing the web GUI.
> [!WARNING]
> Do not run the dashboard with administrative capabilities and do not expose the GUI externally. While special inputs are treated with caution, malicious scan results were not considered during development. The dashboard does also not authenticate users.
1. Open http://127.0.0.1:8050/ and start uploading your scan results
<img src="https://github.com/user-attachments/assets/d940a2ea-323a-4a13-97d2-e257d1ede519" width="800" />
2. Switch to the graph tab for an overview
<img src="https://github.com/user-attachments/assets/2b392a38-4a29-4d4e-9354-49a9187bb46c" width="800" />
3. Filter data and view hosts details
<img src="https://github.com/user-attachments/assets/0011a58c-6c52-43b5-8902-34f7f6f4c633" width="800" />
## 📃 License and attribution
Code released under the [MIT License](LICENSE).
Built using [Dash](https://github.com/plotly/dash/tree/dev) (licensed under MIT), [Dash Bootstrap Components](https://github.com/facultyai/dash-bootstrap-components) (licensed under Apache 2.0), and [Bootswatch](https://github.com/thomaspark/bootswatch) (licensed under MIT).
Raw data
{
"_id": null,
"home_page": null,
"name": "scandeavour",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "nmap, nessus, dashboard",
"author": null,
"author_email": "cr4ckc4t <cr4ckc4t@github.com>",
"download_url": "https://files.pythonhosted.org/packages/53/66/e96e6ebcbb37e09feb9036967c96f3ddabd766563b8e8a3e58df8016d6cb/scandeavour-1.1.2.tar.gz",
"platform": null,
"description": "<p align=\"center\"><img src=\"https://github.com/user-attachments/assets/40965716-558c-4ab9-b8c6-2cb5dbf3e7c8\" width=\"120px\" /></p>\n<h1 align=\"center\">Scandeavour</h1>\n<p align=\"center\">\n<a href=\"https://pypi.org/project/scandeavour/\"><img alt=\"PyPI - Version\" src=\"https://img.shields.io/pypi/v/scandeavour\"></a>\n<a href=\"https://github.com/Cr4ckC4t/scandeavour/blob/main/LICENSE\"><img alt=\"PyPI - License\" src=\"https://img.shields.io/pypi/l/scandeavour\"></a>\n</p>\n<p align=\"center\">\nDashboard for merging, visualising and filtering network scans.\n</p>\n\n## \ud83d\udd28 Installation\n\n\n\n\n\n```\npipx install scandeavour\n```\n\n\n## \u2728 Features\n\n- Load Nmap, Nessus and Masscan results (parsers are modular and can be added as plugins)\n- View scans, hosts and open ports in an interactive graph with details for every node\n- View all merged hosts in a dashboard\n- Expand on host details (i.e. related scans, open ports, script outputs)\n- Apply tags to hosts for custom prioritisation\n- Chain modular drop-down filters to select relevant hosts based on their address, tag, open ports, script outputs, scans, OS, etc.\n- Copy identified hosts and open ports to clipboard for a new scan\n- Export hosts, ports and services to a CSV (e.g. for import in Word)\n- Offline mode - once installed, no internet connection is required (a browser is required to access the dashboard though)\n\nThe following scanner outputs are supported. The main focus of this project lies on `nmap` but ingestors for other scanners can be integrated easily. Check out the [existing ingestors here](https://github.com/Cr4ckC4t/scandeavour/tree/main/src/scandeavour/ingestors) if you want to extend one or build your own.\n\n|Tool|Source|Scan information| Open ports | Service detection | Script output |\n|---|---|:---:|:---:|:---:|:---:|\n|Nmap|`nmap -oX <output>` |\u2714|\u2714|\u2714|\u2714|\n|Nessus|Nessus export|limited|\u2714|\u2714|\u2714|\n|Masscan|`masscan -oX <output>` |\u26d4|\u2714|\u26d4|\u26d4|\n|Masscan|`masscan \\| tee <output>` |\u26d4|\u2714|\u26d4|\u26d4|\n\n\n## \ud83d\udcd6 Usage\n\nTo visualize your scan results, simply start\n```\nscandeavour my_project.db\n```\nThis will create a new project database (SQLITE) in the current folder. It will be used to store all your merged scans. You can also checkout the [database schema](https://github.com/Cr4ckC4t/scandeavour/blob/main/src/scandeavour/setup_database.sqlite) if you want to interact with the data manually. The command will also start a Flask webserver running on a local port, exposing the web GUI.\n\n> [!WARNING] \n> Do not run the dashboard with administrative capabilities and do not expose the GUI externally. While special inputs are treated with caution, malicious scan results were not considered during development. The dashboard does also not authenticate users.\n\n1. Open http://127.0.0.1:8050/ and start uploading your scan results\n <img src=\"https://github.com/user-attachments/assets/d940a2ea-323a-4a13-97d2-e257d1ede519\" width=\"800\" />\n\n2. Switch to the graph tab for an overview\n <img src=\"https://github.com/user-attachments/assets/2b392a38-4a29-4d4e-9354-49a9187bb46c\" width=\"800\" />\n\n3. Filter data and view hosts details\n <img src=\"https://github.com/user-attachments/assets/0011a58c-6c52-43b5-8902-34f7f6f4c633\" width=\"800\" />\n\n\n## \ud83d\udcc3 License and attribution\n\nCode released under the [MIT License](LICENSE).\n\nBuilt using [Dash](https://github.com/plotly/dash/tree/dev) (licensed under MIT), [Dash Bootstrap Components](https://github.com/facultyai/dash-bootstrap-components) (licensed under Apache 2.0), and [Bootswatch](https://github.com/thomaspark/bootswatch) (licensed under MIT).\n\n",
"bugtrack_url": null,
"license": "MIT License\n \n Copyright (c) 2024 crackcat\n \n Permission is hereby granted, free of charge, to any person obtaining a copy\n of this software and associated documentation files (the \"Software\"), to deal\n in the Software without restriction, including without limitation the rights\n to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n copies of the Software, and to permit persons to whom the Software is\n furnished to do so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.\n ",
"summary": "Dashboard for merging, visualising and filtering network scans",
"version": "1.1.2",
"project_urls": {
"Homepage": "https://github.com/Cr4ckC4t/scandeavour"
},
"split_keywords": [
"nmap",
" nessus",
" dashboard"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "070270260748354428986a0e36d0ecf1c7f8fd9d6fe132715c047ce3d0111a87",
"md5": "420443857403f7358017346c212d7ed0",
"sha256": "6525ebbdb847a45bb64078528f99fb6a76358bb9dac7cbf09876c24a30760a88"
},
"downloads": -1,
"filename": "scandeavour-1.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "420443857403f7358017346c212d7ed0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 141580,
"upload_time": "2025-02-11T20:18:18",
"upload_time_iso_8601": "2025-02-11T20:18:18.925804Z",
"url": "https://files.pythonhosted.org/packages/07/02/70260748354428986a0e36d0ecf1c7f8fd9d6fe132715c047ce3d0111a87/scandeavour-1.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "5366e96e6ebcbb37e09feb9036967c96f3ddabd766563b8e8a3e58df8016d6cb",
"md5": "7f2e33118cacfa151e63b1b0aa7c368c",
"sha256": "91c50f49a7024fa0f58e0a2b5cd07e2165542542f5971635da3fad2ef6abd9fa"
},
"downloads": -1,
"filename": "scandeavour-1.1.2.tar.gz",
"has_sig": false,
"md5_digest": "7f2e33118cacfa151e63b1b0aa7c368c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 111039,
"upload_time": "2025-02-11T20:18:21",
"upload_time_iso_8601": "2025-02-11T20:18:21.332138Z",
"url": "https://files.pythonhosted.org/packages/53/66/e96e6ebcbb37e09feb9036967c96f3ddabd766563b8e8a3e58df8016d6cb/scandeavour-1.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-11 20:18:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Cr4ckC4t",
"github_project": "scandeavour",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "scandeavour"
}
