Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
fportantier committed Dec 30, 2018
1 parent 5f45922 commit 7dd293a
Show file tree
Hide file tree
Showing 2 changed files with 80 additions and 1 deletion.
76 changes: 76 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,7 @@ This can give you some extra info about what habu is doing.
- [fernet.genkey](#habufernetgenkey)
- [fernet](#habufernet)
- [forkbomb](#habuforkbomb)
- [gateway.find](#habugatewayfind)
- [hasher](#habuhasher)
- [ip2asn](#habuip2asn)
- [ip](#habuip)
Expand All @@ -141,6 +142,8 @@ This can give you some extra info about what habu is doing.
- [vhosts](#habuvhosts)
- [virustotal](#habuvirustotal)
- [webid](#habuwebid)
- [web.report](#habuwebreport)
- [web.screenshot](#habuwebscreenshot)
- [whois.domain](#habuwhoisdomain)
- [whois.ip](#habuwhoisip)
- [xor](#habuxor)
Expand Down Expand Up @@ -799,6 +802,40 @@ Options:
```


## habu.gateway.find


``` {.sourceCode .bash}
Usage: habu.gateway.find [OPTIONS] NETWORK
Try to reach an external IP using any host has a router.
Useful to find routers in your network.
First, uses arping to detect alive hosts and obtain MAC addresses.
Later, create a network packet and put each MAC address as destination.
Last, print the devices that forwarded correctly the packets.
Example:
# habu.find.gateway 192.168.0.0/24
192.168.0.1 a4:08:f5:19:17:a4 Sagemcom
192.168.0.7 b0:98:2b:5d:22:70 Sagemcom
192.168.0.8 b0:98:2b:5d:1f:e8 Sagemcom
Options:
-i TEXT Interface to use
--host TEXT Host to reach (default: 8.8.8.8)
--tcp Use TCP instead of ICMP
--dport INTEGER RANGE Destination port for TCP (default: 80)
--timeout INTEGER Timeout in seconds (default: 5)
-v Verbose output
--help Show this message and exit.
```


## habu.hasher


Expand Down Expand Up @@ -1580,6 +1617,45 @@ Options:
```


## habu.web.report


``` {.sourceCode .bash}
Usage: habu.web.report [OPTIONS] [F]
Uses Firefox to take a screenshot of the websites. (you need firefox
installed, obviously)
Makes a report that includes the HTTP headers.
The expected format is one url per line.
Creates a directory called 'report' with the content inside.
$ echo https://www.portantier.com | habu.web.report
Options:
-v Verbose output
--help Show this message and exit.
```


## habu.web.screenshot


``` {.sourceCode .bash}
Usage: habu.web.screenshot [OPTIONS] URL
Uses Firefox to take a screenshot (you need firefox installed, obviously)
$ habu.web.screenshot https://www.portantier.com
Options:
-o TEXT Output file. (default: screenshot.png)
--help Show this message and exit.
```


## habu.whois.domain


Expand Down
5 changes: 4 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

setup(
name='habu',
version='0.0.92',
version='0.0.94',
description='Python Network Hacking Toolkit',
long_description=readme,
long_description_content_type='text/markdown',
Expand Down Expand Up @@ -59,6 +59,7 @@
habu.fernet=habu.cli.cmd_fernet:cmd_fernet
habu.fernet.genkey=habu.cli.cmd_fernet_genkey:cmd_fernet_genkey
habu.forkbomb=habu.cli.cmd_forkbomb:cmd_forkbomb
habu.gateway.find=habu.cli.cmd_gateway_find:cmd_gateway_find
habu.hasher=habu.cli.cmd_hasher:cmd_hasher
habu.ip=habu.cli.cmd_ip:cmd_ip
habu.ip2asn=habu.cli.cmd_ip2asn:cmd_ip2asn
Expand All @@ -83,6 +84,8 @@
habu.vhosts=habu.cli.cmd_vhosts:cmd_vhosts
habu.virustotal=habu.cli.cmd_virustotal:cmd_virustotal
habu.webid=habu.cli.cmd_webid:cmd_webid
habu.web.report=habu.cli.cmd_web_reportt:cmd_web_report
habu.web.screenshot=habu.cli.cmd_web_screenshot:cmd_web_screenshot
habu.whois.domain=habu.cli.cmd_whois_domain:cmd_whois_domain
habu.whois.ip=habu.cli.cmd_whois_ip:cmd_whois_ip
habu.xor=habu.cli.cmd_xor:cmd_xor
Expand Down

0 comments on commit 7dd293a

Please sign in to comment.