Skip to main content

A wrapper for the pwn.college API. This allows automating interactions with pwn.college and also includes a command-line-interface(CLI) to list dojos/modules, submit flags, start challenges, run commands in challenge containers and more.

Project description

PyPwnCollege

Run Tests codecov Documentation Status PyPI version

PyPwnCollege is an unofficial Python library to interact with the pwn.college API and website.

Install

pip install pypwncollege

Demo

from pwncollege import PWNClient
# Create an API connection
client = PWNClient(email="user@example.com", password="S3cr3tP455w0rd!")
# Print the User associated with the client
print(client.user)

CLI

The library also comes with a CLI to interact with the API which is a work in progress. It is included in the published pip package and should be available in shell.

Basic usage:

pwncli --help
pwncli login -u test1337 -p test1337
pwncli get --dojos
pwncli challenge -d fundamentals -m program-misuse -c level-1 -f flag{test}

Documentation

The documentation is available here.

Current Features

  • Logging into the API
  • Fetching Dojos, Modules, Challenges
    • Starting a Challenge
    • Running an ssh command on a challenge
    • Submitting flags
  • Getting User details
  • Getting rankings in dojos and modules
  • Getting information about belted users

Contributing

If you find a bug or want to add a feature, feel free to open an issue or a pull request.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pypwncollege-0.1.5.tar.gz (13.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pypwncollege-0.1.5-py3-none-any.whl (15.9 kB view details)

Uploaded Python 3

File details

Details for the file pypwncollege-0.1.5.tar.gz.

File metadata

  • Download URL: pypwncollege-0.1.5.tar.gz
  • Upload date:
  • Size: 13.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.10.12 Linux/6.5.0-17-generic

File hashes

Hashes for pypwncollege-0.1.5.tar.gz
Algorithm Hash digest
SHA256 1f9fd382cda2460a0e333e39dc62df7397637adb4e4164c2054e4cca6b70d3ca
MD5 3b169219faaa2c2f7d00330e17c06e45
BLAKE2b-256 6d55068f4d8d7576ea94045f7b90f156bd1539a0f2d8ab78c542fb1cfff054dc

See more details on using hashes here.

File details

Details for the file pypwncollege-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: pypwncollege-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 15.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.10.12 Linux/6.5.0-17-generic

File hashes

Hashes for pypwncollege-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 9e1f177548907b12ef97acc90ad6252fb99634f8d1f3b130ff3aa05dbc5ea688
MD5 f5d99f96fe729fed58acf4477db969b3
BLAKE2b-256 14b6676c0719444b6161b5b3c61f5c517e67e260fc2c84b5d54e8bdfaf0a7ab9

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page