|
1 | 1 | # darkbox
|
2 | 2 |
|
3 |
| -WIP portable all-in-one cross-platform toolkit. |
| 3 | +This is a work-in-progress, all-in-one, portable, cross-platform, command-line toolkit. It's similar in nature to BusyBox, but is able to run on Windows, Linux, macOS, etc. darkbox is built for hackers, penetration testers, incident responders, and security researchers. It not only comes with many of the standard utilities that you use on a daily basis, but also tools that computer security practitioners know and love. |
4 | 4 |
|
5 |
| -Written by your friendly neighborhood AbnormalSec. |
| 5 | +darkbox is written by your friendly neighborhood AbnormalSec <3 |
| 6 | + |
| 7 | +## How to get darkbox |
| 8 | + |
| 9 | +Pre-built, portable binaries can be downloaded for Linux, Windows, and macOS in the [releases section](https://github.com/AbnormalSec/darkbox/releases). |
| 10 | + |
| 11 | +If you'd like to compile your own binary, darkbox is compiled using [Nuitka](http://nuitka.net/). See the [Nuitka documentation](http://nuitka.net/pages/documentation.html) to learn how to get up and running, and then darkbox can be built like so: `nuitka3 --recurse-all darkbox/darkbox.py` |
| 12 | + |
| 13 | +darkbox is also available on [PyPI](https://pypi.org/project/darkbox/) and can be installed using pip: |
| 14 | +``` |
| 15 | +pip install darkbox |
| 16 | +``` |
| 17 | + |
| 18 | +If you'd like to run darkbox from the git repo source code you can: |
| 19 | +```bash |
| 20 | +$ git clone https://github.com/abnormalsec/darkbox |
| 21 | +$ # use it directly as a module like so |
| 22 | +$ python3 -m darkbox.darkbox -v |
| 23 | +darkbox 0.0.2 |
| 24 | +$ # or manually install it |
| 25 | +$ python3 setup.py install |
| 26 | +$ darkbox -v |
| 27 | +darkbox 0.0.2 |
| 28 | +``` |
| 29 | + |
| 30 | +## Usage |
| 31 | + |
| 32 | +Once you have darkbox it can be used like so: |
| 33 | +``` |
| 34 | +$ darkbox --help |
| 35 | +Usage: darkbox <tool> [OPTIONS] |
| 36 | +Tools: base64, cat, cp, curl, exip, head, hostname, ls, md5sum, mv, nmap, pwd, rm, sha224sum, sha256sum, sha384sum, sha512sum, unzip, xxd, zip |
| 37 | +
|
| 38 | +$ darkbox cat hello.txt |
| 39 | +Hello, world! |
| 40 | +
|
| 41 | +$ darkbox nmap -p22 localhost |
| 42 | +Starting darkbox Nmap v0.0.1 at 2018-14-22 16:14 EST |
| 43 | +Nmap scan report for localhost (127.0.0.1) |
| 44 | +PORT STATE |
| 45 | +22/tcp open |
| 46 | +Nmap done: 1 IP addresses scanned in 0.02 seconds |
| 47 | +
|
| 48 | +$ darkbox md5sum /bin/ls |
| 49 | +d77c1dd5bb8e39c2dd27c96c3fd2263e /bin/ls |
| 50 | +``` |
| 51 | + |
| 52 | +More documentation will be coming, this project is being actively hacked on. :) |
0 commit comments