Preparing the project layout and initial, potential configs

This commit is contained in:
Darryl Nixon 2023-09-05 20:51:23 -07:00
parent cf2f5dfcdb
commit 2e9505dc33
8 changed files with 107 additions and 1 deletions

3
.flake8 Normal file
View file

@ -0,0 +1,3 @@
[flake8]
max-line-length = 160
exclude = docs/*, .git, __pycache__, build

28
.pre-commit-config.yaml Normal file
View file

@ -0,0 +1,28 @@
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v3.2.0
hooks:
- id: trailing-whitespace
- id: end-of-file-fixer
- id: check-yaml
- id: check-added-large-files
- repo: https://github.com/asottile/reorder_python_imports
rev: v3.9.0
hooks:
- id: reorder-python-imports
args: [--application-directories, '.:bronzeburner', --py39-plus]
- repo: https://github.com/psf/black
rev: 23.3.0
hooks:
- id: black
language_version: python3.10
- repo: https://github.com/PyCQA/bandit
rev: 1.7.5
hooks:
- id: bandit
args: ["-c", "pyproject.toml"]
additional_dependencies: ["bandit[toml]"]
- repo: https://github.com/pycqa/flake8
rev: 6.0.0
hooks:
- id: flake8

5
192.168.86.145 Normal file
View file

@ -0,0 +1,5 @@
# Nmap 7.94 scan initiated Tue Sep 5 20:07:54 2023 as: nmap -vvv -p 22,80,111,143,443,465,548,587,993,2049,3000,3306,5055,5380,5354,6200,8001,8384,8435,8888,9443,22000,32400,32768,41893,42199,50291,51413,51485 -oG 192.168.86.145 192.168.86.145
# Ports scanned: TCP(29;22,80,111,143,443,465,548,587,993,2049,3000,3306,5055,5354,5380,6200,8001,8384,8435,8888,9443,22000,32400,32768,41893,42199,50291,51413,51485) UDP(0;) SCTP(0;) PROTOCOLS(0;)
Host: 192.168.86.145 () Status: Up
Host: 192.168.86.145 () Ports: 22/open/tcp//ssh///, 80/open/tcp//http///, 111/open/tcp//rpcbind///, 143/open/tcp//imap///, 443/open/tcp//https///, 465/open/tcp//smtps///, 548/open/tcp//afp///, 587/open/tcp//submission///, 993/open/tcp//imaps///, 2049/open/tcp//nfs///, 3000/open/tcp//ppp///, 3306/open/tcp//mysql///, 5055/open/tcp//unot///, 5354/open/tcp//mdnsresponder///, 5380/open/tcp/////, 6200/open/tcp//lm-x///, 8001/open/tcp//vcom-tunnel///, 8384/open/tcp//marathontp///, 8435/open/tcp/////, 8888/open/tcp//sun-answerbook///, 9443/open/tcp//tungsten-https///, 22000/open/tcp//snapenetio///, 32400/open/tcp//plex///, 32768/open/tcp//filenet-tms///, 41893/open/tcp/////, 42199/open/tcp/////, 50291/open/tcp/////, 51413/open/tcp/////, 51485/open/tcp/////
# Nmap done at Tue Sep 5 20:07:54 2023 -- 1 IP address (1 host up) scanned in 0.05 seconds

View file

@ -1,3 +1,32 @@
<div align="center>
<img src="bronzeburner.png" alt="bronzeburner logo">
# bronzeburner # bronzeburner
Offensive Security Lab 2 **bronzeburner** is a humble network scanner
use it to monitor your enterprise's ports over time<br/>
[Installation](#installation) •
[Examples](#examples) •
[Contributing](#contributing) •
[License](#license)
</div>
## Installation
TBD
## Examples
TBD
## Contributing
If you would like to contribute to this project, feel free to submit a pull request or open an issue on GitHub.
This tool was written as part of my coursework for INFA 735 - Offensive Security at Dakota State University. Consequently, I may choose not to maintain this tool beyond the length of the course.
## License
This project is licensed under AGPL 3.0. See the `LICENSE` file for details.

BIN
bronzeburner.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 107 KiB

0
bronzeburner/__init__.py Normal file
View file

17
bronzeburner/cli.py Normal file
View file

@ -0,0 +1,17 @@
import argparse
def main():
pass
def run():
parser = argparse.ArgumentParser(description="A humble network scanner")
args = parser.parse_args()
main(args)
if __name__ == "__main__":
run()

24
pyproject.toml Normal file
View file

@ -0,0 +1,24 @@
[build-system]
requires = ["setuptools>=68.1.2"]
build-backend = "setuptools.build_meta"
[project]
name = "bronzeburner"
version = "0.0.1"
authors = [{ name = "Darryl Nixon", email = "git@nixon.mozmail.com" }]
description = "A humble network scanner"
requires-python = ">=3.9"
license = { text = "AGPL 3.0" }
dependencies = ["sh>=2.0.6", "rocketry>=2.5.1"]
[project.scripts]
bronzeburner = "bronzeburner.cli:run"
[tool.setuptools]
py-modules = ["bronzeburner"]
[tool.bandit]
exclude_dirs = ["/doc", "/build"]
[tool.black]
line-length = 120