Metadata-Version: 2.1
Name: hackrecon
Version: 1.7
Summary: Reconnaissance tool
Home-page: https://github.com/EmilienPer/HackRecon
Author: Emilien Peretti
Author-email: code@emilienperetti.be
License: AGPLv3
Platform: UNKNOWN
Description-Content-Type: text/markdown
Requires-Dist: setuptools
Requires-Dist: enlighten
Requires-Dist: lxml
Requires-Dist: netaddr

[![PyPi](https://img.shields.io/pypi/v/hackrecon.svg)](https://pypi.org/pypi/hackrecon/)
![License](https://img.shields.io/github/license/EmilienPer/Hackrecon.svg?style=flat)
[![Documentation Status](https://readthedocs.org/projects/hackrecon/badge/?version=latest)](https://hackrecon.readthedocs.io/en/latest/?badge=latest)
[![Known Vulnerabilities](https://snyk.io/test/github/EmilienPer/HackRecon/badge.svg?targetFile=requirements.txt)](https://snyk.io/test/github/EmilienPer/HackRecon?targetFile=requirements.txt)
[![Donate](https://img.shields.io/badge/donate-paypal-orange.svg)](https://www.paypal.me/EmilienPer)
[![Beerpay](https://beerpay.io/EmilienPer/HackRecon/badge.svg?style=flat)](https://beerpay.io/EmilienPer/HackRecon)
## Table of Contents
   * [HackRecon](#hackrecon)
   * [Requirement](#requirement)
   * [Installation](#installation)
   * [Options](#options)
   * [Usage](#usage)
   * [Example](#example)
   * [Issues management](#issues-management)

## HackRecon
Project URL : https://github.com/EmilienPer/HackRecon

HackRecon was created to be used for OSCP certification.
This tool (inspired by the "reconnoitre" tool: https://github.com/codingo/Reconnoitre) makes it possible to scan hosts finally to obtain a maximum of information on these. It is therefore a recognition tool.
Its mechanism can be summarized as follows:

 For each host:
- Create the exploit, proof and scan folders required for OSCP certification
- Determine open ports and related services
- For each port:
    * List exploits related to the product using the port
    *  Start scans according to the protocol
    * Suggest additional scans asking for human intervention or other exploits
- Write an analysis report (HTML and XML format)
## Requirement
HackRecon run on Python 2.7 can't work correctly without the following tools
- Nmap           
- smtp-user-enum 
- whatweb        
- nikto          
- dirb     
## Installation
`sudo pip install hackrecon`

## Options
| Shortcut | option | Required | Default | Description |
| -------- | ------ | -------- | ------- | ----------- |
| |  <ips>    | X | | The Ip(s) address of the host |
| -o | --output |  | .|The output directory|
| -t | --max_threads | |5 |  The maximum number of host handled in the same time |
| | --cache |  | False |Use cache |
| -a | --all |  | False|Scan all ports | 
| | --css |  | |The CSS file to use into the HTML report| 
| | --javascript_header |  | |  The javascript file to use into the header of the HTML report | 
| | --javascript_tail |  | |  The javascript file to use into  the end of the HTML report |
| | --full |  | |  Use all nmap nse scrip for the protocol. The value can be "all" or a list of protocol separated by ";"  |
## Usage
The <ips> param can be 
- An IPv4 address (example: 192.168.0.1)
- An range of IPv4 addresses (example: 192.168.0.0/24 or 192.168.0.1-254)
- A list of IPv4 address separated by ";" (example: 192.168.0.1;198.162.0.2)

Example:
* `hackrecon 192.168.0.1 -o /root/`,
* `hackrecon 192.168.0.0/24 -o /root/`
* `hackrecon 192.168.0.1-254 -o /root/`
* `hackrecon 192.168.0.1;198.162.0.2 -o /root/`
* `hackrecon 192.168.0.1 -o /root/ -t 5 --cache --all `
* `hackrecon 192.168.0.1 -o /root/ --javascript_header javascript_file.js --javascript_tail other_file.js --css shett.css`
* `hackrecon 192.168.0.1 -o /root/ -t 5 --cache --all --full all`
* `hackrecon 192.168.0.1 -o /root/ -t 5 --cache --all  --full http;ssh;smb`
## Example
Example of usage can be found in the "examples" directory
## Issues management 
For contributions or suggestions, please [open an Issue](https://github.com/EmilienPer/HackRecon/issues/new) and clearly explain, using an example or a use case if appropriate. 

