Skip to content

Latest commit

 

History

History
28 lines (21 loc) · 1.07 KB

README.md

File metadata and controls

28 lines (21 loc) · 1.07 KB
Raw

saarctf-client

This library allows accessing the status endpoint as described on https://ctf.saarland/setup

For usage information check out the saarctf_client/client.py, the code should not be too hard to understand.

Request caching

You can optionally cache requests using a redis backend. This makes sense if you have limited bandwidth and start a large amount of processes in parallel or frequently call the functions, since each function equates an HTTP request to the endpoint.

To enable redis caching setup a redis listening on localhost:6379 and set the environment variable export SAARCTF_CLIENT_CACHE=1. You can adjust the default TTL of 5 seconds by setting e.g. SAARCTF_CLIENT_CACHE_EXPIRY=15.

Usage example

The library is not available on pypi.org, instead it can be installed using

pip3 install git+https://github.com/ldruschk/saarctf-client.git

An example program might look as follows:

import sys
from saarctf_client import *

ip = sys.argv[1]
assert_online(ip)

for round, data in get_flag_ids('service_1', ip).items():
    # do stuff
    pass