Prerequisites
Before installing RelayKing, ensure the following are available on your system:- Python 3.8+ — RelayKing requires Python 3.8 or later.
- git — Used to clone the repository.
- virtualenv — Used to create an isolated Python environment.
Installation Steps
Create a virtual environment
Use
virtualenv to create an isolated Python 3 environment inside the project directory. This prevents dependency conflicts with system packages.Activate the virtual environment
Verify the installation
Confirm RelayKing launches correctly by printing the help menu:You should see the full argument reference output.
Optional: Run the verification script
For a deeper check, run the bundled A successful run ends with:If any check fails, install the missing packages:
verify_installation.py script. It validates your Python version, all dependency imports, RelayKing’s internal modules, and the syntax of every .py file in the project:Dependencies
The following packages are installed fromrequirements.txt:
| Package | Minimum Version | Purpose |
|---|---|---|
impacket | >=0.11.0 | SMB, LDAP, MSSQL protocol implementations |
requests | >=2.28.0 | HTTP/HTTPS scanning |
requests-ntlm | >=1.2.0 | NTLM authentication over HTTP |
dnspython | >=2.3.0 | DNS resolution for hostname lookups |
ldap3 | >=2.9.1 | LDAP operations and AD enumeration |
pyasn1 | >=0.4.8 | ASN.1 encoding (Kerberos/LDAP) |
urllib3 | >=1.26.0 | HTTP client internals |