pybots


Namepybots JSON
Version 2.0.8 PyPI version JSON
download
home_pagehttps://github.com/dhondta/python-pybots
SummaryDevkit for quickly creating client bots for remote communications
upload_time2020-07-09 12:26:39
maintainer
docs_urlNone
authorAlexandre D'Hondt
requires_python!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*!=3.4.*,<4,>=2.7
licenseAGPLv3
keywords python development programming framework cli devkit
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            [![PyPi](https://img.shields.io/pypi/v/pybots.svg)](https://pypi.python.org/pypi/pybots/)
[![Read The Docs](https://readthedocs.org/projects/python-pybots/badge/?version=latest)](http://python-pybots.readthedocs.io/en/latest/?badge=latest)
[![Build Status](https://travis-ci.org/dhondta/python-pybots.svg?branch=master)](https://travis-ci.org/dhondta/python-pybots)
[![Requirements Status](https://requires.io/github/dhondta/python-pybots/requirements.svg?branch=master)](https://requires.io/github/dhondta/python-pybots/requirements/?branch=master)
[![Known Vulnerabilities](https://snyk.io/test/github/dhondta/python-pybots/badge.svg?targetFile=requirements.txt)](https://snyk.io/test/github/dhondta/python-pybots?targetFile=requirements.txt)
[![Python Versions](https://img.shields.io/pypi/pyversions/pybots.svg)](https://pypi.python.org/pypi/pybots/)
[![License](https://img.shields.io/pypi/l/pybots.svg)](https://pypi.python.org/pypi/pybots/)

# PyBots

This library aims to quickly write client bots for communicating with remote hosts in various ways.

It currently features the following bots:
- Protocol-bound: TCPBot, HTTPBot, JSONBot, IRCBot, EPassport
- Application-specific:
  - CTF: RingZer0Bot, RootMeIRCBot, ZSISBot
  - Security: ShodanBot, VirusTotalBot
  - Miscellaneous: GitRecoveryBot
  

## Installation

```
sudo pip install pybots
```


## Usage

Each bot class is implemented as a context manager and has a logger attached. It can thus be instantiated in a clear and straightforward way. Here is an example:

```py
from pybots import TCPBot

with TCPBot("remote_host", 1234) as bot:
    data = bot.send_receive("Hello!")
    # do something with data
```

Note that, if a bot is used behind a proxy, it will use system's proxy settings. This can be bypassed by using `no_proxy=True` while instantiating the bot.

```py
with TCPBot("LAN_host", 1234, no_proxy=True) as bot:
    # ...
```


## CTF Examples

* [Hacky Easter 2017 (22 & 24)](doc/examples/hacky-easter-2017.md)
* [Hackvent 2017 (Day 06 & 10)](doc/examples/hackvent-2017.md)
* [RingZer0 / Coding (13 & 17)](doc/examples/ringzer0.md)
* [Root-Me / Programming](doc/examples/rootme.md)


## Contribution

For contributions or suggestions, please [open an Issue](https://github.com/dhondta/python-pybots/issues/new) and clearly explain, using an example or a use case if appropriate. 

If you want to get new bots added, please submit a Pull Request.
            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/dhondta/python-pybots",
    "name": "pybots",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*!=3.4.*,<4,>=2.7",
    "maintainer_email": "",
    "keywords": "python,development,programming,framework,cli,devkit",
    "author": "Alexandre D'Hondt",
    "author_email": "alexandre.dhondt@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/1f/cb/f39ce4347f83306ba832b92fe84d1fc64aed8b873523a9573e6515f20c9d/pybots-2.0.8.tar.gz",
    "platform": "",
    "description": "[![PyPi](https://img.shields.io/pypi/v/pybots.svg)](https://pypi.python.org/pypi/pybots/)\n[![Read The Docs](https://readthedocs.org/projects/python-pybots/badge/?version=latest)](http://python-pybots.readthedocs.io/en/latest/?badge=latest)\n[![Build Status](https://travis-ci.org/dhondta/python-pybots.svg?branch=master)](https://travis-ci.org/dhondta/python-pybots)\n[![Requirements Status](https://requires.io/github/dhondta/python-pybots/requirements.svg?branch=master)](https://requires.io/github/dhondta/python-pybots/requirements/?branch=master)\n[![Known Vulnerabilities](https://snyk.io/test/github/dhondta/python-pybots/badge.svg?targetFile=requirements.txt)](https://snyk.io/test/github/dhondta/python-pybots?targetFile=requirements.txt)\n[![Python Versions](https://img.shields.io/pypi/pyversions/pybots.svg)](https://pypi.python.org/pypi/pybots/)\n[![License](https://img.shields.io/pypi/l/pybots.svg)](https://pypi.python.org/pypi/pybots/)\n\n# PyBots\n\nThis library aims to quickly write client bots for communicating with remote hosts in various ways.\n\nIt currently features the following bots:\n- Protocol-bound: TCPBot, HTTPBot, JSONBot, IRCBot, EPassport\n- Application-specific:\n  - CTF: RingZer0Bot, RootMeIRCBot, ZSISBot\n  - Security: ShodanBot, VirusTotalBot\n  - Miscellaneous: GitRecoveryBot\n  \n\n## Installation\n\n```\nsudo pip install pybots\n```\n\n\n## Usage\n\nEach bot class is implemented as a context manager and has a logger attached. It can thus be instantiated in a clear and straightforward way. Here is an example:\n\n```py\nfrom pybots import TCPBot\n\nwith TCPBot(\"remote_host\", 1234) as bot:\n    data = bot.send_receive(\"Hello!\")\n    # do something with data\n```\n\nNote that, if a bot is used behind a proxy, it will use system's proxy settings. This can be bypassed by using `no_proxy=True` while instantiating the bot.\n\n```py\nwith TCPBot(\"LAN_host\", 1234, no_proxy=True) as bot:\n    # ...\n```\n\n\n## CTF Examples\n\n* [Hacky Easter 2017 (22 & 24)](doc/examples/hacky-easter-2017.md)\n* [Hackvent 2017 (Day 06 & 10)](doc/examples/hackvent-2017.md)\n* [RingZer0 / Coding (13 & 17)](doc/examples/ringzer0.md)\n* [Root-Me / Programming](doc/examples/rootme.md)\n\n\n## Contribution\n\nFor contributions or suggestions, please [open an Issue](https://github.com/dhondta/python-pybots/issues/new) and clearly explain, using an example or a use case if appropriate. \n\nIf you want to get new bots added, please submit a Pull Request.",
    "bugtrack_url": null,
    "license": "AGPLv3",
    "summary": "Devkit for quickly creating client bots for remote communications",
    "version": "2.0.8",
    "split_keywords": [
        "python",
        "development",
        "programming",
        "framework",
        "cli",
        "devkit"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "f957a94567f69a6028bd471ae675a0a1",
                "sha256": "ff5ef1977b0a657401f39e7eb69d325a60a5d5c2ac69a4c31b52906802a1ed56"
            },
            "downloads": -1,
            "filename": "pybots-2.0.8.tar.gz",
            "has_sig": false,
            "md5_digest": "f957a94567f69a6028bd471ae675a0a1",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*!=3.4.*,<4,>=2.7",
            "size": 55928,
            "upload_time": "2020-07-09T12:26:39",
            "upload_time_iso_8601": "2020-07-09T12:26:39.953171Z",
            "url": "https://files.pythonhosted.org/packages/1f/cb/f39ce4347f83306ba832b92fe84d1fc64aed8b873523a9573e6515f20c9d/pybots-2.0.8.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2020-07-09 12:26:39",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": null,
    "github_project": "dhondta",
    "error": "Could not fetch GitHub repository",
    "lcname": "pybots"
}
        
Elapsed time: 0.12215s