rconrs 0.2.1

Rust implementation of SRCDS RCON Protocol
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143

pub mod packet_type;

use anyhow::Result;
use bytes::{Buf, BufMut, Bytes, BytesMut};
use num_traits::ToPrimitive;

use crate::error::PacketError::MalformedPacketError;
use crate::packet::packet_type::{RequestPacketType, ResponsePacketType};

#[derive(Debug)]
pub struct Packet {
    pub size: usize,
    pub identifier: i32,
    pub packet_type: i32,
    pub payload: Vec<u8>,
}

impl Default for Packet {
    fn default() -> Self {
        Self {
            size: 10,
            identifier: 0,
            packet_type: ToPrimitive::to_i32(&RequestPacketType::ServerDataAuth).unwrap(),
            payload: vec![],
        }
    }
}

impl Packet {
    pub fn identifier(mut self, identifier: i32) -> Self {
        self.identifier = identifier;
        self
    }

    pub fn request_packet_type(mut self, packet_type: RequestPacketType) -> Self {
        self.packet_type = packet_type as i32;
        self
    }

    pub fn response_packet_type(mut self, packet_type: ResponsePacketType) -> Self {
        self.packet_type = packet_type as i32;
        self
    }

    pub fn payload(mut self, payload: Vec<u8>) -> Self {
        self.size = 10 + payload.len();
        self.payload = payload;
        self
    }
}

impl TryFrom<&mut BytesMut> for Packet {
    type Error = anyhow::Error;

    fn try_from(bytes: &mut BytesMut) -> Result<Packet, Self::Error> {
        let size = bytes.get_i32_le() as usize;
        let identifier = bytes.get_i32_le();
        let packet_type = bytes.get_i32_le();
        let payload = bytes.split_to(size.saturating_sub(10)).into();
        Ok(Packet {
            size,
            identifier,
            packet_type,
            payload,
        })
    }
}

impl TryFrom<Packet> for Bytes {
    type Error = anyhow::Error;

    fn try_from(packet: Packet) -> Result<Bytes, Self::Error> {
        // packet size(4 bytes) + packet itself size(packet.size bytes)
        let mut buffer = BytesMut::with_capacity(packet.size + 4);
        buffer.put_i32_le(packet.size as i32);
        buffer.put_i32_le(packet.identifier);
        let packet_type = ToPrimitive::to_i32(&packet.packet_type)
            .ok_or_else(|| anyhow::Error::new(MalformedPacketError))?;
        buffer.put_i32_le(packet_type);
        buffer.put(packet.payload.as_ref());
        buffer.put_slice(b"\x00\x00");
        Ok(buffer.freeze())
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use num_traits::FromPrimitive;

    #[test]
    fn serialize_packet() -> Result<(), Box<dyn std::error::Error>> {
        let rcon_password = "passwrd".as_bytes().to_vec();
        let auth_packet = Packet::default()
            .identifier(0)
            .request_packet_type(RequestPacketType::ServerDataAuth)
            .payload(rcon_password);
        let auth_packet_bytes = Bytes::try_from(auth_packet)?;
        let want_packet_bytes = Bytes::from_static(&[
            0x11, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x03, 0x00, 0x00, 0x00, 0x70, 0x61,
            0x73, 0x73, 0x77, 0x72, 0x64, 0x00, 0x00,
        ]);
        assert_eq!(*auth_packet_bytes, *want_packet_bytes);

        Ok(())
    }

    #[test]
    fn deserialize_packet() -> Result<(), Box<dyn std::error::Error>> {
        // authentication response is constructed with empty `ResponseValue` and empty `AuthResponse`.

        // Tests empty `ResponseValue`.
        let mut response_value_packet_bytes = BytesMut::from(
            &[
                0x0a, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
            ][..],
        );
        let response_value_packet = Packet::try_from(&mut response_value_packet_bytes)?;
        assert_eq!(response_value_packet.size, 0xa);
        assert_eq!(response_value_packet.identifier, 0);
        let packet_type: ResponsePacketType =
            FromPrimitive::from_i32(response_value_packet.packet_type)
                .ok_or_else(|| anyhow::Error::new(MalformedPacketError))?;
        assert_eq!(packet_type, ResponsePacketType::ServerDataResponseValue);
        assert_eq!(response_value_packet.payload.len(), 0);

        // Tests empty `AuthResponse`.
        let mut auth_response_packet_bytes = BytesMut::from(
            &[
                0x0a, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x02, 0x00, 0x00, 0x00, 0x00, 0x00,
            ][..],
        );
        let auth_packet = Packet::try_from(&mut auth_response_packet_bytes)?;
        assert_eq!(auth_packet.size, 0xa);
        assert_eq!(auth_packet.identifier, 0);
        let packet_type: ResponsePacketType = FromPrimitive::from_i32(auth_packet.packet_type)
            .ok_or_else(|| anyhow::Error::new(MalformedPacketError))?;
        assert_eq!(packet_type, ResponsePacketType::ServerDataAuthResponse);
        assert_eq!(auth_packet.payload.len(), 0);

        Ok(())
    }
}