Skip to content

🔧 Devkit for quickly creating client bots for remote communications

License

Notifications You must be signed in to change notification settings

dhondta/python-pybots

Repository files navigation

PyBots Tweet

Create your robot clients with Python.

PyPi Read The Docs Build Status Python Versions Known Vulnerabilities License

This library aims to quickly write client bots for communicating with remote hosts in a standardized way using context managers. It implements a few bots for some common protocols (HTTP, JSON, IRC, ...) and for communicating with specific applications (Shodan, Censys, HaveIBeenPwned?, RootMe, RingZer0, ...).

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:

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.

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

👻 Supported Bots

Generic Purpose

All the following bots use the same interface providing uniformized logging.

Name Description
HTTP For browsing and parsing a Web page with BeautifulSoup
IRC For connecting to an IRC server on a given channel with a given nickname
JSON For dealing with a JSON API
TCP For opening a TCP socket

CTF Platforms

Each of these bots is aimed to parse inputs from a challenge and to send the answer computed in the context of the bot to the target website for retrieving the flag.

Name Description
RingZer0 Web bot for all kinds of challenges
RootMe IRC bot for programming challenges
ZSIS Web bot for progrmming challenges

Security Services

These bots are built upon an API layer that defines corresponding interfaces to the online services' functionalities as described in their documentation. The bots implement common operations that may involve multiple calls to the online services' API.

Name Description
Censys JSON bot that checks for IP's and domains
Ghost Project Web bot that checks for emails
HaveIBeenPwned? JSON bot that checks for emails and passwords
HaveIBeenSold? JSON bot that checks for emails
Nuclear Leaks Web bot that checks for emails and domains
Shodan JSON bot that checks for IP's

Utility Services

Name Description
Git Web bot that can retrieve a Git repository
PostBin Web bot that can perform Bin operations

🔍 Examples

Real-Life Projects

CTF

👏 Supporters

Stargazers repo roster for @dhondta/python-pybots

Forkers repo roster for @dhondta/python-pybots

Back to top