Skip to main content

Scripting SDK for the Red Team Toolkit platform

Project description

RTT Platform Python SDK

This is the formally maintained Python SDK for interacting with a Red Team Toolkit (RTT) Platform C2 server.

This project is currently in BETA status and subject to significant change until finalized

This SDK is based on models generated from the OpenAPI specification for the latest platform server. It will continue to be updated and expanded as more features are finalized in the platform server.

Additional information can be found here

Installation

> pip install rtt-sdk

Examples

Collecting current session information

import asyncio
import rtt_sdk

async def main():
    client = rtt_sdk.SlingshotClient()
    user = await client.context_user(True)
    process = await client.context_process()
    print(f"Running as {user.username} in {process.process_id}")

asyncio.run(main())

Asyncronous Code

This SDK makes use of asyncio for executing tasks and returning results. Almost every function exposed on API clients is an asyncronous co-routine and requires an event loop for execution. The easiest way to accomplish this is to define a wrapper async main() function and use the new asyncio.run() function to establish an event loop, and execute your code within (as seen in the examples section)

Some useful primitives that can be used as part of async:

results = await foo()
await asyncio.waitfor(foo(), timeout=10)
await asyncio.gather([foo(), bar()])

More information can be found here

Requirements

  • Active RTT license and deployed RTT platform server
  • Python 3.7+

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

rtt-sdk-0.1.2.tar.gz (26.7 kB view details)

Uploaded Source

Built Distribution

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

rtt_sdk-0.1.2-py3-none-any.whl (33.2 kB view details)

Uploaded Python 3

File details

Details for the file rtt-sdk-0.1.2.tar.gz.

File metadata

  • Download URL: rtt-sdk-0.1.2.tar.gz
  • Upload date:
  • Size: 26.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.10.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.5

File hashes

Hashes for rtt-sdk-0.1.2.tar.gz
Algorithm Hash digest
SHA256 ac7bbb34750ecb13f5389ce3133052f328cc6502575bfae4a2b551b93b4e5d2d
MD5 8b9e983cda0a8dfb55c94b812883fc8c
BLAKE2b-256 33cffa1913c55be3fa6943b32b9bdb358f7c989293bb470ff1b26c28887f3d0e

See more details on using hashes here.

File details

Details for the file rtt_sdk-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: rtt_sdk-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 33.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.10.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.5

File hashes

Hashes for rtt_sdk-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d8af18b3e4bcd930e895ed8996c7aff772e1ff532a553408d3dd52bedd23d1b5
MD5 38cd64d8a99b2ef27c955ca4f813796f
BLAKE2b-256 b5cf35c50474cd0951744fb3bd1b3ad8a7a2cd7c3b0e4cdba7f9cc63ec49576d

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