-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added Rcon and Query API implementation
- Loading branch information
Showing
3 changed files
with
168 additions
and
0 deletions.
There are no files selected for viewing
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,106 @@ | ||
import enum | ||
import struct | ||
import socket | ||
import time | ||
|
||
MAGIC = 0xFEFD | ||
PADDING = 0xFFFFFF01 | ||
LAST_PACKET = 0x80 | ||
SPLIT_PADDING = b'\x01\x70\x6C\x61\x79\x65\x72\x5F\x00\x00' | ||
|
||
|
||
class QueryPacketTypes(enum.IntEnum): | ||
HANDSHAKE = 9 | ||
STAT = 0 | ||
|
||
|
||
def _session_id(): | ||
return int(time.time()) & 0x0F0F0F0F | ||
|
||
def handshake(sock: socket.socket, address: tuple): | ||
# Send request | ||
sess_id = _session_id() | ||
packet = struct.pack('>Hbi', MAGIC, QueryPacketTypes.HANDSHAKE, sess_id) | ||
sock.sendto(packet, address) | ||
|
||
# Receive response | ||
data,_ = sock.recvfrom(18) | ||
r_type, r_sess_id, payload = struct.unpack('>bi{}s'.format(len(data) - 5), data) | ||
|
||
# Check type and session id | ||
if r_type != QueryPacketTypes.HANDSHAKE or r_sess_id != sess_id: | ||
raise Exception("Error while getting the handshake") | ||
|
||
# Parse token | ||
token = int(payload.split(b'\0')[0]) | ||
return token | ||
|
||
def basic_stats(sock: socket.socket, address: tuple, token: int): | ||
# Send request | ||
sess_id = _session_id() | ||
packet = struct.pack('>Hbii', MAGIC, QueryPacketTypes.STAT, sess_id, token) | ||
sock.sendto(packet, address) | ||
|
||
# Receive response | ||
data,_ = sock.recvfrom(4096) | ||
r_type, r_sess_id, payload = struct.unpack('>bi{}s'.format(len(data) - 5), data) | ||
|
||
# Check type and session id | ||
if r_type != QueryPacketTypes.STAT or r_sess_id != sess_id: | ||
raise Exception("Error while getting basic stats") | ||
|
||
# Parse the data | ||
items = payload.rstrip(b'\0').split(b'\0') | ||
items[-1:] = struct.unpack('<h{}s'.format(len(items[-1]) - 2), items[-1]) | ||
motd, gtype, gmap, nplayers, maxplayers, hostp, hostip = items | ||
|
||
# Return response | ||
return { | ||
'motd': motd.decode('ascii'), | ||
'game_type': gtype.decode('ascii'), | ||
'map': gmap.decode('ascii'), | ||
'n_players': (int(nplayers), int(maxplayers)), | ||
'host': (hostip.decode('ascii'), hostp) | ||
} | ||
|
||
def full_stats(sock: socket.socket, address: tuple, token: int): | ||
# Send request | ||
sess_id = _session_id() | ||
packet = struct.pack('>HbiiI', MAGIC, QueryPacketTypes.STAT, sess_id, token, PADDING) | ||
sock.sendto(packet, address) | ||
|
||
# Receive response | ||
fpayload = bytes() | ||
while 1: | ||
data,_ = sock.recvfrom(4096) | ||
r_type, r_sess_id, _, r_last_pkt, _, payload = struct.unpack('>bi9sBb{}s'.format(len(data) - 16), data) | ||
|
||
# Check type and session id | ||
if r_type != QueryPacketTypes.STAT or r_sess_id != sess_id: | ||
raise Exception("Error while getting full stats") | ||
|
||
# Add data and check if end | ||
fpayload += payload | ||
if r_last_pkt == LAST_PACKET: | ||
break | ||
|
||
# Parse data | ||
info, players = fpayload.split(SPLIT_PADDING) | ||
split_info = info.rstrip(b'\0').split(b'\0') | ||
split_players = players.rstrip(b'\0').split(b'\0') | ||
|
||
info = dict([(split_info[i].decode('ascii'), split_info[i+1]) for i in range(0, len(split_info), 2)]) | ||
players = [p.decode('ascii') for p in split_players if p] | ||
|
||
# Return response | ||
return { | ||
'motd': info['hostname'].decode('ascii'), | ||
'game_type': info['gametype'].decode('ascii'), | ||
'game_id': info['game_id'].decode('ascii'), | ||
'version': info['version'].decode('ascii'), | ||
'plugins': info['plugins'].decode('ascii'), | ||
'map': info['map'].decode('ascii'), | ||
'n_players': (int(info['numplayers']), int(info['maxplayers'])), | ||
'host': (info['hostip'].decode('ascii'), int(info['hostport'])), | ||
'players': players | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
import struct | ||
import enum | ||
import socket | ||
import time | ||
|
||
class RconPacketTypes(enum.IntEnum): | ||
SERVERDATA_AUTH = 3 | ||
SERVERDATA_EXECOMMAND = 2 | ||
SERVERDATA_AUTH_RESPONSE = 2 | ||
SERVERDATA_RESPONSE_VALUE = 0 | ||
|
||
|
||
def _request_id(): | ||
return int(time.time()) | ||
|
||
def _write_packet(sock: socket.socket, _type: int, payload: str): | ||
# Prepare packet | ||
req_id = _request_id() | ||
packet = struct.pack('<ii{}s2s'.format(len(payload)), req_id, _type, payload.encode('ascii'), b'\0\0') | ||
header = struct.pack('<i', len(packet)) | ||
|
||
# Send packet | ||
data_sent = sock.send(header + packet) | ||
return req_id, data_sent | ||
|
||
def _read_packet(sock: socket.socket): | ||
# Recv data | ||
length_bytes = sock.recv(4) | ||
length = struct.unpack('<i', length_bytes)[0] | ||
data = bytes() | ||
|
||
# Ensure that all the data was read | ||
while length > len(data): | ||
data += sock.recv(length - len(data)) | ||
|
||
# Parse data | ||
r_req_id, r_type, payload = struct.unpack('<ii{}s'.format(len(data) - 8), data) | ||
return r_req_id, r_type, payload | ||
|
||
def authenticate(sock: socket.socket, password: str): | ||
req_id = _write_packet(sock, RconPacketTypes.SERVERDATA_AUTH, password)[0] | ||
|
||
r_req_id, r_type, _ = _read_packet(sock) | ||
|
||
if r_type != RconPacketTypes.SERVERDATA_AUTH_RESPONSE or r_req_id == -1: | ||
raise Exception('Authentication failed') | ||
|
||
def run_command(sock: socket.socket, command: str): | ||
req_id = _write_packet(sock, RconPacketTypes.SERVERDATA_EXECOMMAND, command)[0] | ||
|
||
fpayload = bytes() | ||
try: | ||
# Receive message until no more | ||
while 1: | ||
r_req_id, r_type, payload = _read_packet(sock) | ||
|
||
if r_type != RconPacketTypes.SERVERDATA_RESPONSE_VALUE or r_req_id != req_id: | ||
raise Exception('Error occured while executing a command') | ||
|
||
fpayload += payload | ||
finally: | ||
return fpayload.decode('ascii') |