Skip to content

Latest commit

 

History

History
80 lines (72 loc) · 2.49 KB

README.md

File metadata and controls

80 lines (72 loc) · 2.49 KB
Raw

AKB-Explorer

A command line tool to search AttackerKB.

How to install

Not much to do, you just have to clone the repo and install the required python libraries.

git clone https://github.com/horshark/akb-explorer/
pip install -r requirements.txt

Then you need to add your AKB API key in config/api.txt. You can retrive it from your AKB profile.

echo "YOUR_AKB_API_KEY_HERE" > config/api.txt

To run from any location in the file system:

export PATH=<install_location>:$PATH
export akb_config=<install_location>
chmod +x <install_location>/akb-explorer.py

example installation in /opt/akb-explorer:

export PATH=/opt/akb-explorer:$PATH
export akb_config=/opt/akb-explorer
chmod +x /opt/akb-explorer/akb-explorer.py

And you are done! :)

How to use

Without instructions to run from anywhere:

This is the help command:

python3 .\akb-explorer.py -h
usage: akb-explorer.py [-h] [-q QUERY] [-cve CVE] [-u USER]

Search through AttackerKB via command line!

optional arguments:
  -h, --help            show this help message and exit
  -q QUERY, --query QUERY
                        Search for a topic (by keywords or CVE-YEAR-XXXX)
  -cve CVE, --cve CVE   Search for a CVE using it's code (CVE-YEAR-XXXX)
  -u USER, --username USER
                        Search for a user

If you installed with the run from anywhere instructions:

This is the help command:

akb-explorer.py -h
usage: akb-explorer.py [-h] [-q QUERY] [-c CVE] [-u USER]

Search through AttackerKB via command line!

optional arguments:
  -h, --help           show this help message and exit
  -q QUERY, --query QUERY
                        Search for a topic (by keywords or CVE-YEAR-XXXX)
  -cve CVE, --cve CVE   Search for a CVE using it's code (CVE-YEAR-XXXX)
  -u USER, --username USER
                        Search for a user

And below are a few explicit examples (omit python3 .\ if installed to run anywhere).

  • To query using keywords:
python3 .\akb-explorer.py -q blue
  • To search for a specific CVE: (it actually does the same at -q but formatted differently, giving something else than a CVE will cause errors for now.)
python3 .\akb-explorer.py -cve CVE-2020-0688
  • To look for a user.
python3 .\akb-explorer.py -u horshark

Credits

Thanks to @kevthehermit for helping me simplify my tool using his python library!

Related projects