hackboard-ussu321 1.0.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- hackboard_ussu321-1.0.0/LICENSE +21 -0
- hackboard_ussu321-1.0.0/MANIFEST.in +10 -0
- hackboard_ussu321-1.0.0/PKG-INFO +480 -0
- hackboard_ussu321-1.0.0/README.md +425 -0
- hackboard_ussu321-1.0.0/docs/installation.md +40 -0
- hackboard_ussu321-1.0.0/docs/plugins.md +32 -0
- hackboard_ussu321-1.0.0/docs/usage.md +47 -0
- hackboard_ussu321-1.0.0/hackboard/__init__.py +26 -0
- hackboard_ussu321-1.0.0/hackboard/__main__.py +8 -0
- hackboard_ussu321-1.0.0/hackboard/analytics.py +1075 -0
- hackboard_ussu321-1.0.0/hackboard/app.py +2373 -0
- hackboard_ussu321-1.0.0/hackboard/assets/animations.json +32 -0
- hackboard_ussu321-1.0.0/hackboard/assets/banner.txt +14 -0
- hackboard_ussu321-1.0.0/hackboard/assets/styles.css +266 -0
- hackboard_ussu321-1.0.0/hackboard/cli.py +154 -0
- hackboard_ussu321-1.0.0/hackboard/launcher.py +45 -0
- hackboard_ussu321-1.0.0/hackboard/osint_tools.py +516 -0
- hackboard_ussu321-1.0.0/hackboard/security_tools.py +1115 -0
- hackboard_ussu321-1.0.0/hackboard/utils.py +847 -0
- hackboard_ussu321-1.0.0/hackboard_ussu321.egg-info/PKG-INFO +480 -0
- hackboard_ussu321-1.0.0/hackboard_ussu321.egg-info/SOURCES.txt +31 -0
- hackboard_ussu321-1.0.0/hackboard_ussu321.egg-info/dependency_links.txt +1 -0
- hackboard_ussu321-1.0.0/hackboard_ussu321.egg-info/entry_points.txt +2 -0
- hackboard_ussu321-1.0.0/hackboard_ussu321.egg-info/requires.txt +20 -0
- hackboard_ussu321-1.0.0/hackboard_ussu321.egg-info/top_level.txt +1 -0
- hackboard_ussu321-1.0.0/install.sh +248 -0
- hackboard_ussu321-1.0.0/pyproject.toml +108 -0
- hackboard_ussu321-1.0.0/requirements.txt +12 -0
- hackboard_ussu321-1.0.0/setup.cfg +60 -0
- hackboard_ussu321-1.0.0/tests/__init__.py +4 -0
- hackboard_ussu321-1.0.0/tests/test_security_tools.py +145 -0
- hackboard_ussu321-1.0.0/tests/test_utils.py +121 -0
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2024-2026 issu321
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
include README.md
|
|
2
|
+
include LICENSE
|
|
3
|
+
include requirements.txt
|
|
4
|
+
include install.sh
|
|
5
|
+
recursive-include hackboard/assets *
|
|
6
|
+
recursive-include docs *.md
|
|
7
|
+
recursive-include tests *.py
|
|
8
|
+
global-exclude __pycache__
|
|
9
|
+
global-exclude *.py[co]
|
|
10
|
+
global-exclude .DS_Store
|
|
@@ -0,0 +1,480 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: hackboard-ussu321
|
|
3
|
+
Version: 1.0.0
|
|
4
|
+
Summary: Professional Cybersecurity Intelligence Platform
|
|
5
|
+
Home-page: https://github.com/issu321/hackboard
|
|
6
|
+
Author: issu321
|
|
7
|
+
Author-email: issu321 <jaafreeusman@gmail.com>
|
|
8
|
+
Maintainer-email: issu321 <jaafreeusman@gmail.com>
|
|
9
|
+
License: MIT
|
|
10
|
+
Project-URL: Homepage, https://github.com/issu321
|
|
11
|
+
Project-URL: Documentation, https://github.com/issu321/hackboard#readme
|
|
12
|
+
Project-URL: Repository, https://github.com/issu321/Hackboard
|
|
13
|
+
Project-URL: Issues, https://github.com/issu321/Hackboard/issues
|
|
14
|
+
Keywords: cybersecurity,ethical-hacking,security,osint,threat-intelligence,penetration-testing,streamlit,dashboard
|
|
15
|
+
Classifier: Development Status :: 4 - Beta
|
|
16
|
+
Classifier: Intended Audience :: Information Technology
|
|
17
|
+
Classifier: Intended Audience :: System Administrators
|
|
18
|
+
Classifier: Intended Audience :: Education
|
|
19
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
20
|
+
Classifier: Operating System :: OS Independent
|
|
21
|
+
Classifier: Operating System :: POSIX :: Linux
|
|
22
|
+
Classifier: Programming Language :: Python :: 3
|
|
23
|
+
Classifier: Programming Language :: Python :: 3.9
|
|
24
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
25
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
26
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
27
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
28
|
+
Classifier: Topic :: Security
|
|
29
|
+
Classifier: Topic :: System :: Networking :: Monitoring
|
|
30
|
+
Classifier: Topic :: Utilities
|
|
31
|
+
Classifier: Typing :: Typed
|
|
32
|
+
Requires-Python: >=3.9
|
|
33
|
+
Description-Content-Type: text/markdown
|
|
34
|
+
License-File: LICENSE
|
|
35
|
+
Requires-Dist: streamlit>=1.28.0
|
|
36
|
+
Requires-Dist: plotly>=5.17.0
|
|
37
|
+
Requires-Dist: pandas>=2.0.0
|
|
38
|
+
Requires-Dist: numpy>=1.24.0
|
|
39
|
+
Requires-Dist: psutil>=5.9.0
|
|
40
|
+
Requires-Dist: python-whois>=0.8.0
|
|
41
|
+
Requires-Dist: dnspython>=2.4.0
|
|
42
|
+
Requires-Dist: networkx>=3.1
|
|
43
|
+
Requires-Dist: requests>=2.31.0
|
|
44
|
+
Requires-Dist: rich>=13.5.0
|
|
45
|
+
Requires-Dist: scapy>=2.5.0
|
|
46
|
+
Requires-Dist: certifi>=2023.7.22
|
|
47
|
+
Provides-Extra: dev
|
|
48
|
+
Requires-Dist: pytest>=7.4.0; extra == "dev"
|
|
49
|
+
Requires-Dist: pytest-cov>=4.1.0; extra == "dev"
|
|
50
|
+
Requires-Dist: black>=23.7.0; extra == "dev"
|
|
51
|
+
Requires-Dist: flake8>=6.1.0; extra == "dev"
|
|
52
|
+
Requires-Dist: mypy>=1.5.0; extra == "dev"
|
|
53
|
+
Requires-Dist: pre-commit>=3.4.0; extra == "dev"
|
|
54
|
+
Dynamic: license-file
|
|
55
|
+
|
|
56
|
+
# π‘οΈ HackBoard
|
|
57
|
+
|
|
58
|
+
> **Professional Cybersecurity Intelligence Platform**
|
|
59
|
+
|
|
60
|
+
[](https://python.org)
|
|
61
|
+
[](https://streamlit.io)
|
|
62
|
+
[](LICENSE)
|
|
63
|
+
[](https://github.com/issu321/hackboard)
|
|
64
|
+
|
|
65
|
+
```
|
|
66
|
+
ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
|
|
67
|
+
β β
|
|
68
|
+
β βββ βββ ββββββ ββββββββββ ββββββββββ βββββββ ββββββ βββββββ β
|
|
69
|
+
β βββ ββββββββββββββββββββββ βββββββββββββββββββββββββββββββββββββ β
|
|
70
|
+
β βββββββββββββββββββ βββββββ βββββββββββ ββββββββββββββ βββ β
|
|
71
|
+
β βββββββββββββββββββ βββββββ βββββββββββ ββββββββββββββ βββ β
|
|
72
|
+
β βββ ββββββ ββββββββββββββ βββββββββββββββββββββββ βββββββββββ β
|
|
73
|
+
β βββ ββββββ βββ ββββββββββ ββββββββββ βββββββ βββ ββββββββββ β
|
|
74
|
+
β β
|
|
75
|
+
β CYBERSECURITY INTELLIGENCE PLATFORM β
|
|
76
|
+
ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
---
|
|
80
|
+
|
|
81
|
+
## π Overview
|
|
82
|
+
|
|
83
|
+
**HackBoard** is a professional cybersecurity intelligence platform designed for **educational**, **defensive**, and **ethical hacking** purposes. Built as a futuristic cyberpunk SOC dashboard, it combines AI-inspired security analysis, advanced network scanning, OSINT intelligence, threat analytics, and comprehensive reporting β all within an immersive Streamlit interface.
|
|
84
|
+
|
|
85
|
+
### Key Capabilities
|
|
86
|
+
|
|
87
|
+
- π€ **AI Security Insights** β Contextual AI-like analysis across all security vectors
|
|
88
|
+
- π **Network Scanner** β Safe TCP port scanning with topology visualization
|
|
89
|
+
- π **OSINT Intelligence** β WHOIS, DNS, SSL, subdomain enumeration
|
|
90
|
+
- π **Password Analyzer** β Entropy scoring with pattern detection
|
|
91
|
+
- π§ͺ **Hashing Laboratory** β 8 algorithms, file/text hashing, integrity verification
|
|
92
|
+
- π **File Security Analyzer** β Static analysis with entropy and magic bytes
|
|
93
|
+
- β οΈ **Vulnerability Assessment** β Simulated CVSS scoring and recommendations
|
|
94
|
+
- π **Packet Analytics** β Protocol distribution and traffic visualization
|
|
95
|
+
- π§ **Threat Intelligence** β Kill chain visualization and threat radars
|
|
96
|
+
- π» **System Monitor** β Real-time CPU, RAM, disk, and process telemetry
|
|
97
|
+
|
|
98
|
+
---
|
|
99
|
+
|
|
100
|
+
## π Installation
|
|
101
|
+
|
|
102
|
+
### Prerequisites
|
|
103
|
+
|
|
104
|
+
- **Python 3.9+**
|
|
105
|
+
- **pip** package manager
|
|
106
|
+
- **Git** (for cloning)
|
|
107
|
+
|
|
108
|
+
### Quick Install (pip)
|
|
109
|
+
|
|
110
|
+
```bash
|
|
111
|
+
pip install hackboard
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
### Development Install (from source)
|
|
115
|
+
|
|
116
|
+
```bash
|
|
117
|
+
git clone https://github.com/issu321/hackboard.git
|
|
118
|
+
cd hackboard
|
|
119
|
+
pip install -e .
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
### Linux / Kali Linux / Ubuntu / Debian
|
|
123
|
+
|
|
124
|
+
```bash
|
|
125
|
+
git clone https://github.com/issu321/hackboard.git
|
|
126
|
+
cd hackboard
|
|
127
|
+
bash install.sh
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
The installer will:
|
|
131
|
+
1. β
Detect Python and pip
|
|
132
|
+
2. β
Check virtual environment
|
|
133
|
+
3. β
Create `~/.config/hackboard/` directories
|
|
134
|
+
4. β
Install all dependencies
|
|
135
|
+
5. β
Launch HackBoard automatically
|
|
136
|
+
|
|
137
|
+
**System dependencies (if scapy fails):**
|
|
138
|
+
```bash
|
|
139
|
+
sudo apt-get update
|
|
140
|
+
sudo apt-get install -y libpcap-dev
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
### Windows 10 / 11
|
|
144
|
+
|
|
145
|
+
```powershell
|
|
146
|
+
git clone https://github.com/issu321/hackboard.git
|
|
147
|
+
cd hackboard
|
|
148
|
+
pip install -e .
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
**Note for Windows:**
|
|
152
|
+
- Install [Npcap](https://npcap.com/) for full packet capture features
|
|
153
|
+
- Run as Administrator for raw socket operations
|
|
154
|
+
- The app gracefully falls back to simulated data without admin rights
|
|
155
|
+
|
|
156
|
+
---
|
|
157
|
+
|
|
158
|
+
## π₯οΈ Usage
|
|
159
|
+
|
|
160
|
+
### Launch the Dashboard
|
|
161
|
+
|
|
162
|
+
```bash
|
|
163
|
+
# After pip install
|
|
164
|
+
hackboard
|
|
165
|
+
|
|
166
|
+
# Or with options
|
|
167
|
+
hackboard --port 8080 --host 0.0.0.0
|
|
168
|
+
hackboard --no-browser
|
|
169
|
+
|
|
170
|
+
# Or as a Python module
|
|
171
|
+
python -m hackboard
|
|
172
|
+
```
|
|
173
|
+
|
|
174
|
+
### CLI Options
|
|
175
|
+
|
|
176
|
+
```
|
|
177
|
+
usage: hackboard [-h] [--version] [--port PORT] [--host HOST] [--no-browser] [--headless] [--config-dir]
|
|
178
|
+
|
|
179
|
+
HackBoard β Professional Cybersecurity Intelligence Platform
|
|
180
|
+
|
|
181
|
+
options:
|
|
182
|
+
-h, --help Show this help message and exit
|
|
183
|
+
--version, -v Show version and exit
|
|
184
|
+
--port PORT, -p PORT
|
|
185
|
+
Port to run the Streamlit server on (default: 8501)
|
|
186
|
+
--host HOST, -H HOST
|
|
187
|
+
Host to bind the server to (default: localhost)
|
|
188
|
+
--no-browser, -n
|
|
189
|
+
Do not open browser automatically
|
|
190
|
+
--headless Run in headless mode
|
|
191
|
+
--config-dir Print the configuration directory path and exit
|
|
192
|
+
```
|
|
193
|
+
|
|
194
|
+
---
|
|
195
|
+
|
|
196
|
+
## πΈ Screenshots
|
|
197
|
+
|
|
198
|
+
> *Screenshots will be added here. The dashboard features:*
|
|
199
|
+
> - Animated terminal boot sequence
|
|
200
|
+
> - Live SOC feed with simulated alerts
|
|
201
|
+
> - Interactive Plotly charts with cyberpunk dark theme
|
|
202
|
+
> - Network topology node graphs
|
|
203
|
+
> - Risk gauges and system telemetry
|
|
204
|
+
|
|
205
|
+
---
|
|
206
|
+
|
|
207
|
+
## π§© Features
|
|
208
|
+
|
|
209
|
+
| Module | Description |
|
|
210
|
+
|--------|-------------|
|
|
211
|
+
| π **Dashboard** | Central command center with live metrics, threat radar, attack chain |
|
|
212
|
+
| π **Network Scanner** | TCP port scanning with topology maps and risk scoring |
|
|
213
|
+
| π **Domain Intelligence** | WHOIS, DNS, SSL certificate analysis |
|
|
214
|
+
| π‘ **Subdomain Intelligence** | Subdomain enumeration with relationship graphs |
|
|
215
|
+
| π **Password Analyzer** | Entropy & strength analysis with AI recommendations |
|
|
216
|
+
| π§ͺ **Hashing Laboratory** | Multi-algorithm hashing (MD5, SHA family, BLAKE2) |
|
|
217
|
+
| π **File Security Analyzer** | Upload & analyze file security with static analysis |
|
|
218
|
+
| β οΈ **Vulnerability Intelligence** | Simulated vulnerability assessment with CVSS |
|
|
219
|
+
| π **Packet Analytics** | Network traffic visualization and protocol distribution |
|
|
220
|
+
| π§ **Threat Intelligence** | Attack chains, threat radars, and heatmaps |
|
|
221
|
+
| π» **System Monitor** | Real-time CPU, RAM, disk, and process monitoring |
|
|
222
|
+
| π **Upload Center** | Import logs and data files (CSV, JSON, TXT, PCAP) |
|
|
223
|
+
| π₯ **Download Center** | Export reports in CSV, JSON, TXT formats |
|
|
224
|
+
| π **Cyber Analytics** | Custom chart generation engine |
|
|
225
|
+
| π **DNS Intelligence** | Multi-record DNS lookups with visualization |
|
|
226
|
+
| π°οΈ **Network Topology** | Interactive node graphs from scan data |
|
|
227
|
+
| π **Reports Center** | View and manage all generated reports |
|
|
228
|
+
| π€ **AI Security Insights** | Cross-domain AI analysis and correlation |
|
|
229
|
+
|
|
230
|
+
---
|
|
231
|
+
|
|
232
|
+
## π Plugin Development
|
|
233
|
+
|
|
234
|
+
HackBoard supports a plugin architecture. Place Python files in the `plugins/` directory and they will be automatically discovered and loaded.
|
|
235
|
+
|
|
236
|
+
### Example Plugin
|
|
237
|
+
|
|
238
|
+
```python
|
|
239
|
+
# plugins/my_plugin.py
|
|
240
|
+
|
|
241
|
+
PLUGIN_NAME = "My Plugin"
|
|
242
|
+
PLUGIN_VERSION = "1.0.0"
|
|
243
|
+
PLUGIN_DESCRIPTION = "A custom security plugin for HackBoard."
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
def register(app_context: dict) -> None:
|
|
247
|
+
"""Register the plugin with HackBoard."""
|
|
248
|
+
print(f"[PLUGIN] {PLUGIN_NAME} v{PLUGIN_VERSION} loaded")
|
|
249
|
+
# Add your custom logic here
|
|
250
|
+
```
|
|
251
|
+
|
|
252
|
+
### Plugin Interface
|
|
253
|
+
|
|
254
|
+
- `PLUGIN_NAME` (str): Human-readable plugin name
|
|
255
|
+
- `PLUGIN_VERSION` (str): Plugin version
|
|
256
|
+
- `PLUGIN_DESCRIPTION` (str): Brief description
|
|
257
|
+
- `register(app_context)`: Function called with the application context
|
|
258
|
+
|
|
259
|
+
---
|
|
260
|
+
|
|
261
|
+
## π οΈ Developer Guide
|
|
262
|
+
|
|
263
|
+
### Project Structure
|
|
264
|
+
|
|
265
|
+
```
|
|
266
|
+
hackboard/
|
|
267
|
+
βββ hackboard/
|
|
268
|
+
β βββ __init__.py # Package init, version, config dirs
|
|
269
|
+
β βββ __main__.py # Entry point for python -m hackboard
|
|
270
|
+
β βββ app.py # Main Streamlit application (18 pages)
|
|
271
|
+
β βββ cli.py # CLI launcher (hackboard command)
|
|
272
|
+
β βββ launcher.py # Programmatic launch API
|
|
273
|
+
β βββ security_tools.py # Network scanner, password, hashing, file, vuln
|
|
274
|
+
β βββ osint_tools.py # WHOIS, DNS, subdomains, IP, SSL, metadata
|
|
275
|
+
β βββ analytics.py # Plotly charts, heatmaps, graphs, gauges
|
|
276
|
+
β βββ utils.py # Config, logging, exports, SOC feed, AI insights
|
|
277
|
+
β βββ assets/
|
|
278
|
+
β β βββ banner.txt # ASCII art banner
|
|
279
|
+
β β βββ styles.css # Cyberpunk theme styles
|
|
280
|
+
β β βββ animations.json # Boot sequence & SOC alert configs
|
|
281
|
+
β βββ plugins/
|
|
282
|
+
β βββ __init__.py
|
|
283
|
+
β βββ example_plugin.py
|
|
284
|
+
βββ tests/
|
|
285
|
+
β βββ __init__.py
|
|
286
|
+
β βββ test_utils.py
|
|
287
|
+
β βββ test_security_tools.py
|
|
288
|
+
βββ docs/
|
|
289
|
+
βββ config/
|
|
290
|
+
βββ pyproject.toml # Modern setuptools packaging
|
|
291
|
+
βββ setup.cfg # Backup setuptools config
|
|
292
|
+
βββ MANIFEST.in # Package manifest
|
|
293
|
+
βββ requirements.txt # Dependencies
|
|
294
|
+
βββ install.sh # Linux automated installer
|
|
295
|
+
βββ LICENSE # MIT License
|
|
296
|
+
βββ README.md # This file
|
|
297
|
+
```
|
|
298
|
+
|
|
299
|
+
### Configuration
|
|
300
|
+
|
|
301
|
+
HackBoard stores user settings in `~/.config/hackboard/`:
|
|
302
|
+
|
|
303
|
+
```
|
|
304
|
+
~/.config/hackboard/
|
|
305
|
+
βββ logs/ # Rotating application logs
|
|
306
|
+
βββ reports/ # Auto-saved reports (YYYY-MM-DD/)
|
|
307
|
+
βββ history/ # Threat logs and session history
|
|
308
|
+
βββ settings/ # User preferences
|
|
309
|
+
```
|
|
310
|
+
|
|
311
|
+
### Logging
|
|
312
|
+
|
|
313
|
+
Logs are automatically written to `~/.config/hackboard/logs/hackboard.log` with rotation (5 backups, 5MB each).
|
|
314
|
+
|
|
315
|
+
```python
|
|
316
|
+
from hackboard.utils import logger
|
|
317
|
+
logger.info("Custom log message")
|
|
318
|
+
```
|
|
319
|
+
|
|
320
|
+
### Running Tests
|
|
321
|
+
|
|
322
|
+
```bash
|
|
323
|
+
pytest
|
|
324
|
+
# Or with coverage
|
|
325
|
+
pytest --cov=hackboard --cov-report=html
|
|
326
|
+
```
|
|
327
|
+
|
|
328
|
+
### Code Style
|
|
329
|
+
|
|
330
|
+
```bash
|
|
331
|
+
# Format with black
|
|
332
|
+
black hackboard/
|
|
333
|
+
|
|
334
|
+
# Type check with mypy
|
|
335
|
+
mypy hackboard/
|
|
336
|
+
|
|
337
|
+
# Lint with flake8
|
|
338
|
+
flake8 hackboard/
|
|
339
|
+
```
|
|
340
|
+
|
|
341
|
+
---
|
|
342
|
+
|
|
343
|
+
## π‘οΈ Ethical Hacking Disclaimer
|
|
344
|
+
|
|
345
|
+
```
|
|
346
|
+
ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
|
|
347
|
+
β THIS PROJECT IS STRICTLY FOR EDUCATIONAL AND DEFENSIVE USE β
|
|
348
|
+
β ONLY. β
|
|
349
|
+
β β
|
|
350
|
+
β β’ Only scan systems you OWN or have WRITTEN AUTHORIZATION β
|
|
351
|
+
β to test. β
|
|
352
|
+
β β’ All tools are designed for AUTHORIZED LAB ENVIRONMENTS. β
|
|
353
|
+
β β’ No malware, ransomware, or destructive payloads included. β
|
|
354
|
+
β β’ No credential theft or illegal persistence mechanisms. β
|
|
355
|
+
β β’ Use responsibly and in compliance with all applicable laws. β
|
|
356
|
+
ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
|
|
357
|
+
```
|
|
358
|
+
|
|
359
|
+
By using this software, you agree to use it only on systems you own or have explicit permission to test, and for learning, teaching, and defensive hardening only.
|
|
360
|
+
|
|
361
|
+
---
|
|
362
|
+
|
|
363
|
+
## π¦ Packaging
|
|
364
|
+
|
|
365
|
+
### pip Install (Local)
|
|
366
|
+
|
|
367
|
+
```bash
|
|
368
|
+
cd hackboard
|
|
369
|
+
pip install .
|
|
370
|
+
```
|
|
371
|
+
|
|
372
|
+
### pip Install (Editable)
|
|
373
|
+
|
|
374
|
+
```bash
|
|
375
|
+
cd hackboard
|
|
376
|
+
pip install -e .
|
|
377
|
+
```
|
|
378
|
+
|
|
379
|
+
### Build Distribution
|
|
380
|
+
|
|
381
|
+
```bash
|
|
382
|
+
cd hackboard
|
|
383
|
+
python -m build
|
|
384
|
+
```
|
|
385
|
+
|
|
386
|
+
This produces `dist/hackboard-1.0.0-py3-none-any.whl` and `dist/hackboard-1.0.0.tar.gz`.
|
|
387
|
+
|
|
388
|
+
### APT Package (Future)
|
|
389
|
+
|
|
390
|
+
The project is structured to be easily converted to a Debian package:
|
|
391
|
+
|
|
392
|
+
```bash
|
|
393
|
+
# Future command
|
|
394
|
+
sudo apt install hackboard
|
|
395
|
+
```
|
|
396
|
+
|
|
397
|
+
The `install.sh` script and `pyproject.toml` provide the foundation for APT packaging.
|
|
398
|
+
|
|
399
|
+
---
|
|
400
|
+
|
|
401
|
+
## πΊοΈ Future Roadmap
|
|
402
|
+
|
|
403
|
+
- [ ] **Real-time packet capture** with Scapy integration (admin mode)
|
|
404
|
+
- [ ] **CVE database integration** for live vulnerability lookup
|
|
405
|
+
- [ ] **Shodan API integration** for internet-facing asset discovery
|
|
406
|
+
- [ ] **MITRE ATT&CK mapping** for threat intelligence
|
|
407
|
+
- [ ] **PDF report generation** with professional formatting
|
|
408
|
+
- [ ] **Multi-language support** (internationalization)
|
|
409
|
+
- [ ] **Dark/Light theme toggle**
|
|
410
|
+
- [ ] **User authentication** and session management
|
|
411
|
+
- [ ] **REST API endpoint** for programmatic access
|
|
412
|
+
- [ ] **Docker containerization** for one-click deployment
|
|
413
|
+
- [ ] **APT package** for Debian/Ubuntu/Kali Linux
|
|
414
|
+
|
|
415
|
+
---
|
|
416
|
+
|
|
417
|
+
## π€ Contributing
|
|
418
|
+
|
|
419
|
+
We welcome contributions from the cybersecurity community!
|
|
420
|
+
|
|
421
|
+
1. **Fork** the repository
|
|
422
|
+
2. **Create a branch** (`git checkout -b feature/amazing-feature`)
|
|
423
|
+
3. **Commit** your changes (`git commit -m 'Add amazing feature'`)
|
|
424
|
+
4. **Push** to the branch (`git push origin feature/amazing-feature`)
|
|
425
|
+
5. **Open a Pull Request**
|
|
426
|
+
|
|
427
|
+
### Guidelines
|
|
428
|
+
- All contributions must remain **educational and defensive**
|
|
429
|
+
- No malicious or destructive code will be accepted
|
|
430
|
+
- Follow PEP 8 style guidelines
|
|
431
|
+
- Add docstrings to all functions
|
|
432
|
+
- Ensure cross-platform compatibility (Linux & Windows)
|
|
433
|
+
|
|
434
|
+
---
|
|
435
|
+
|
|
436
|
+
## π License
|
|
437
|
+
|
|
438
|
+
This project is licensed under the **MIT License**. See [LICENSE](LICENSE) for details.
|
|
439
|
+
|
|
440
|
+
```
|
|
441
|
+
MIT License
|
|
442
|
+
|
|
443
|
+
Copyright (c) 2024-2026 issu321
|
|
444
|
+
|
|
445
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
446
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
447
|
+
in the Software without restriction, including without limitation the rights
|
|
448
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
449
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
450
|
+
furnished to do so, subject to the following conditions:
|
|
451
|
+
|
|
452
|
+
The above copyright notice and this permission notice shall be included in all
|
|
453
|
+
copies or substantial portions of the Software.
|
|
454
|
+
```
|
|
455
|
+
|
|
456
|
+
---
|
|
457
|
+
|
|
458
|
+
## π€ Developer
|
|
459
|
+
|
|
460
|
+
**Developed by [issu321](https://github.com/issu321)**
|
|
461
|
+
|
|
462
|
+
[](https://github.com/issu321)
|
|
463
|
+
[](https://github.com/issu321/hackboard)
|
|
464
|
+
|
|
465
|
+
---
|
|
466
|
+
|
|
467
|
+
<div align="center">
|
|
468
|
+
|
|
469
|
+
```
|
|
470
|
+
ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
|
|
471
|
+
β STAY ETHICAL. STAY CURIOUS. STAY SECURE. β
|
|
472
|
+
β β
|
|
473
|
+
β HackBoard β Cybersecurity Intelligence Platform β
|
|
474
|
+
β Developed by issu321 β
|
|
475
|
+
ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
|
|
476
|
+
```
|
|
477
|
+
|
|
478
|
+
**β Star this repo if you find it useful! β**
|
|
479
|
+
|
|
480
|
+
</div>
|