broote 0.6.1
General purpose python bruteforce library built on top of perock
Requires Python: >=3.6
Keywords: security,bruteforce,hacking,testing

# broote
Broote is general purpose python bruteforce library built on top of 
[perock](https://github.com/sekgobela-kevin/perock). It aims to make
bruteforcing with python easier and more enjoyable with less code. Everything
will be handled internally with perock letting you focus on what matters.

No more long loops, managing threads or calculating cartesian product
to generate bruteforce data. 
Broote does a good job in handling them without having to worry.  

Steps for using broote library:
- Define bruteforce data e.g passwords or usernames.
- Specify target to bruteforce e.g url, webpage form or file with password.
- Define how to interact/communicate with target(creates response).
- Define what is considered success, failure or error based on response.
- Start bruteforce and wait for results.
 
Broote does not create passwords or usernames but they can be generated
with [brute](https://github.com/rdegges/brute).  
See [perock](https://github.com/sekgobela-kevin/perock) for little more 
about broote library.

> Dont expect broote to perform better than manually written code.


### Install
Broote can be installed with pip in your command-line application.
```bash
pip install broote
```

### Usage
Bruteforce data in broote is represented with fields, records and table.  
```python 
import broote

# Defines field to use with table to create records.
usernames_field = broote.field("username", ["Ben", "Jackson", "Marry"])
passwords_field = broote.field("password", range(10))

# Table contains cartesian product of fields as records.
table = broote.table()
table.add_primary_field(usernames_field)
table.add_field(passwords_field)
```
> See [forcetable](https://github.com/sekgobela-kevin/forcetable) library for more about fields, records and table.  

Forcetable library was integrated into broote but can be used directly 
without problems. 

Primary field is important for making bruteforce much faster. As above, 
username is expected to be tried with password until there is success or run 
out of passwords.

> Always provide primary field to improve performance.


Target in broote can be anything that points to the system to be 
bruteforced. That can be url to webpage, file path or any type of object. 
What matters is being able to use target to perform bruteforce.

Here how we can connect/interact with target pointed by url and then
return response.
```python
import requests

def connector(target, record):
    # target - url to webpage.
    # record - Dict like object with data to pass to request
    return requests.post(target, data=record)

def connector(target, record, session=None):
    # Session may be valuable to make things faster or share data.
    # session - optional session object.
    if session:
        return session.post(target, data=record)
    else:
        return requests.post(target, data=record)
```

Let define success and failure functions to define what is considered
successful or failed bruteforce attempt.
```python
import requests

def success(response):
    return b"logged in as " in response.content

def failure(response):
    return b"Username and password does not match" in response.content
```

Runner is used to execute bruteforce and merge everything together. There
are different runners, some of which are concurrent others running one 
after the other.

`thread_runner` is used to connect/log to website to make things faster 
by using threads.
```python
import broote
import requests

# Defines field to use with table to create records.
usernames_field = broote.field("username", ["Ben", "Jackson", "Marry"])
passwords_field = broote.field("password", range(10))

# Table contains cartesian product of fields as records.
table = broote.table()
table.add_primary_field(usernames_field)
table.add_field(passwords_field)


def connector(target, record, session=None):
    # target - url to webpage.
    # record - Dict with data to pass to request.
    # session - optional session object provided by runner.
    return requests.post(target, data=record)

def success(response):
    return b"logged in as " in response.content

def failure(response):
    return b"Username and password does not match" in response.content


# Creates runner executing in multiple threads.
target = "https://example.com/login"
runner = broote.thread_runner(target, table, connector=connector,success=success, failure=failure)

# Starts bruteforce into target as defined by connector().
runner.start()
runner.get_success_records() # [{'username': 'Marry', 'password': 8}]
```
> The url used '[https://example.com/login](https://example.com/login)' does 
not exists.


Runner is too strict when it comes to `target_reached()`, `success()`, 
`failure()` and `target_error()` functions.  

#### Here is what they mean.
```
Target reached - Determines if target was reached after connecting.
Success - Determines if there was success.
        - Target shoud be reached and no failure or error.
Failure - Determines if attempt failed(e.g wrong password)

Target error - Determines if there was error after reaching target.  
             - Target  needs to be reached as this error originates from 
               target.
Client error - Determines if there was error before reaching target.   
             - Target should not be reached and respose should be exception 
             object.
Error - Determines if there was error when connecting to target.  
      - It should satisfy 'target error' and 'client error'.
```


> Response of `None` wont be allowed and exception object will be taken as 
`client error`.


This shows runner with more functions like `target_reached()` and 
`target_error()` which are also important.
```python
def connector(target, record):
    # Target - url to webpage.
    # Record - Dict with data to pass to request.
    return requests.post(target, data=record)

def target_reached(response):
    return response.status_code == 200

def target_error(response):
    return b"denied" in response.content

def success(response):
    return b"logged in as " in response.content

def failure(response):
    return b"username and password does not match" in response.content


# Creates runner executing in multiple threads.
target = "https://example.com/login"
runner = broote.thread_runner(
    target, 
    table, 
    connector=connector,
    target_reached=target_reached, 
    success=success, 
    failure=failure, 
    target_error=target_error
)

# Starts bruteforce into target as defined by connector().
runner.start()
runner.get_success_records() # [{'username': 'Marry', 'password': 8}]
```


There are other arguments that can be passed to runner including session
or setting maximum success record.

```
optimize: Bool - Enables optimisations, default True.
               - It makes things faster(better leave it as True)

session: Callable | Any - Callable that creates session or any object
                          to use as session.
                        - If callable then it should be method or function.
                        - It may sometimes be better to share certain
                          object e.g session for web request.


# broote.basic_runner does not support 'max_workers' argument.
max_workers: int - Sets maximum workers execute bruteforce, default=10.
                 - Only supported by concurrent runners.

max_retries: int - Sets retries when target is not reached, default 1.
max_success_records: int - Maximum records to match, default None.
max_primary_success_records: int - Maximim records to match for each primary 
                                   field items.
max_success_primary_items: int - Maximum primary items with success records.

max_multiple_primary_items: int - Allows multiple primary items to be be 
                                  tried at same time.
                                - Performs tricks on top of cartesian product
                                  results.
                                - That means multiple usernames tried at
                                  same time.
                                - If using using file field, ensure 
                                  'read_all' argument is enabled.

excluded_primary_items: Iterable - Primary items to be excluded.

comparer: Callable - Influences how arguments like 'success' gets
                         intepreted against response.
                       - It makes it possible to treat the as other objects
                         other than just functions.
                       - e.g lambda: value, response: value(response)

after_connect - Callable - Function called before connecting to target.
after_connect: Callable - Function called after connecting to target.
                        - Great performing something after connecting to
                          target including creating logs.
                        - e.g lambda: record, response: success(respoce)

response_closer: Callable - Function for closing response.
session_closer: Callable - Function for closing session.
```


This simple code shows ways of using `comparer` and `after_attempt`
arguments of runner.
```python
def connector(target, record):
    return requests.post(target, data=record)

def comparer(value, response):
    return value in response.content

def after_connect(record, response):
    if b"logged in as " in response.content:
        username = record.get_item("username")
        password = record.get_item("password")
        print("Logged in as '{}' with '{}'".format(username, password))

# Creates runner executing in multiple threads.
target = "https://example.com/login"
runner = broote.thread_runner(
    target, 
    table, 
    connector=connector,
    target_reached=b"example.com", 
    success=b"logged in as ", 
    failure=b"username and password does not match", 
    target_error=b"denied",
    comparer=comparer
)
``` 


Here is another example not using requests library with response being
string created from record.
```python
def success(response):
    # Matches Username "Ben" and with password containing '1'
    return "Ben" in response and "1" in response

def connector(target, record):
    return "Target is '{}', record is '{}'".format(target, record)

def after(record, response):
    if success(response):
        print("Success:", record)

runner = broote.basic_runner(
    None, 
    table, 
    connector=connector,
    success=success,
    after_connect=after
)
```
> `broote.basic_runner` is not concurrent(attempts wait for each other).

Asyncio version is just similar to thread version but difference is that
the functions passed need to be awaitable.
```python
async def success(response):
    # Matches Username "Ben" and Password 1
    return "Ben" in response and "1" in response

async def connector(target, record):
    return "Target is '{}', record is '{}'".format(target, record)


runner = broote.async_runner(
    None, 
    table, 
    connector=connector,
    success=success,
    max_workers=400
)

# Async runner can be started just like thread runner.
runner.start()
# runner.astart() is awaitable as compared to runner.start().
asyncio.run(runner.astart())
```


Broote has capability to execute multiple runners using multi runners.  

That allows multiple different runners to be executed at the same time no
matter the type of runner.

Each multi runner may do things differenly than others.
`multi_async_runner` will execute runners using asyncio or different 
async thread if runner is not async.
```python
import broote

async_runner = broote.async_runner(...)
thread_runner = broote.basic_runner(...)

multi_runner = multi_async_runner([async_runner, thread_runner])
multi_runner.start()
```
Type of runner does not matter to multi runners. `multi_basic_runner`
can execute `thread_runner` or `async_runner` without problems. Multi
runner can also be used with other multi runner just like regular runner.

Multi runner is not runner and may not contain some features of 
ordinary runner.

> Remember that each runner runs independent of the others.


### Influenced by:
- [perock](https://github.com/sekgobela-kevin/perock)
- [forcetable](https://github.com/sekgobela-kevin/forcetable)

### Similar to broote
- [instaBrute](https://github.com/chinoogawa/instaBrute)
- [Brute_Force](https://github.com/Matrix07ksa/Brute_Force)
- [Instagram Bruter](https://github.com/Bitwise-01/Instagram-)
- [python-bruteForce](https://github.com/Antu7/python-bruteForce)
- [Multi-Threaded-BruteForcer](https://github.com/nasbench/Multi-Threaded-BruteForcer)