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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
#[cfg(test)]
mod tests;

use std::io::{self, Write};

use bitflags::bitflags;
use byteorder::{LittleEndian, ReadBytesExt, WriteBytesExt};
use failure::Fail;
use num_derive::{FromPrimitive, ToPrimitive};
use num_traits::{FromPrimitive, ToPrimitive};

use crate::{impl_from_error, utils::Rectangle, utils::SplitTo, PduBufferParsing, PduParsing};

pub const SURFACE_COMMAND_HEADER_SIZE: usize = 2;

#[derive(Debug, Clone, PartialEq)]
pub enum SurfaceCommand<'a> {
    SetSurfaceBits(SurfaceBitsPdu<'a>),
    FrameMarker(FrameMarkerPdu),
    StreamSurfaceBits(SurfaceBitsPdu<'a>),
}

impl<'a> PduBufferParsing<'a> for SurfaceCommand<'a> {
    type Error = SurfaceCommandsError;

    fn from_buffer_consume(buffer: &mut &'a [u8]) -> Result<Self, Self::Error> {
        let cmd_type = buffer.read_u16::<LittleEndian>()?;
        let cmd_type = SurfaceCommandType::from_u16(cmd_type)
            .ok_or(SurfaceCommandsError::InvalidSurfaceCommandType(cmd_type))?;

        match cmd_type {
            SurfaceCommandType::SetSurfaceBits => Ok(Self::SetSurfaceBits(
                SurfaceBitsPdu::from_buffer_consume(buffer)?,
            )),
            SurfaceCommandType::FrameMarker => Ok(Self::FrameMarker(
                FrameMarkerPdu::from_buffer_consume(buffer)?,
            )),
            SurfaceCommandType::StreamSurfaceBits => Ok(Self::StreamSurfaceBits(
                SurfaceBitsPdu::from_buffer_consume(buffer)?,
            )),
        }
    }

    fn to_buffer_consume(&self, buffer: &mut &mut [u8]) -> Result<(), Self::Error> {
        let cmd_type = SurfaceCommandType::from(self);
        buffer.write_u16::<LittleEndian>(cmd_type.to_u16().unwrap())?;

        match self {
            Self::SetSurfaceBits(pdu) | Self::StreamSurfaceBits(pdu) => {
                pdu.to_buffer_consume(buffer)
            }
            Self::FrameMarker(pdu) => pdu.to_buffer_consume(buffer),
        }
    }

    fn buffer_length(&self) -> usize {
        SURFACE_COMMAND_HEADER_SIZE
            + match self {
                Self::SetSurfaceBits(pdu) | Self::StreamSurfaceBits(pdu) => pdu.buffer_length(),
                Self::FrameMarker(pdu) => pdu.buffer_length(),
            }
    }
}

#[derive(Debug, Clone, PartialEq)]
pub struct SurfaceBitsPdu<'a> {
    pub destination: Rectangle,
    pub extended_bitmap_data: ExtendedBitmapDataPdu<'a>,
}

impl<'a> PduBufferParsing<'a> for SurfaceBitsPdu<'a> {
    type Error = SurfaceCommandsError;

    fn from_buffer_consume(mut buffer: &mut &'a [u8]) -> Result<Self, Self::Error> {
        let destination = Rectangle::from_buffer(&mut buffer)?;
        let extended_bitmap_data = ExtendedBitmapDataPdu::from_buffer_consume(buffer)?;

        Ok(Self {
            destination,
            extended_bitmap_data,
        })
    }

    fn to_buffer_consume(&self, mut buffer: &mut &mut [u8]) -> Result<(), Self::Error> {
        self.destination.to_buffer(&mut buffer)?;
        self.extended_bitmap_data.to_buffer_consume(buffer)?;

        Ok(())
    }

    fn buffer_length(&self) -> usize {
        8 + self.extended_bitmap_data.buffer_length()
    }
}

#[derive(Debug, Clone, PartialEq)]
pub struct FrameMarkerPdu {
    pub frame_action: FrameAction,
    pub frame_id: Option<u32>,
}

impl<'a> PduBufferParsing<'a> for FrameMarkerPdu {
    type Error = SurfaceCommandsError;

    fn from_buffer_consume(buffer: &mut &[u8]) -> Result<Self, Self::Error> {
        let frame_action = buffer.read_u16::<LittleEndian>()?;
        let frame_action = FrameAction::from_u16(frame_action)
            .ok_or(SurfaceCommandsError::InvalidFrameAction(frame_action))?;

        let frame_id = if buffer.is_empty() {
            // Sometimes Windows 10 RDP server sends not complete FrameMarker PDU (without frame ID),
            // so we made frame ID field as optional (not officially)

            None
        } else {
            Some(buffer.read_u32::<LittleEndian>()?)
        };

        Ok(Self {
            frame_action,
            frame_id,
        })
    }

    fn to_buffer_consume(&self, buffer: &mut &mut [u8]) -> Result<(), Self::Error> {
        buffer.write_u16::<LittleEndian>(self.frame_action.to_u16().unwrap())?;
        buffer.write_u32::<LittleEndian>(self.frame_id.unwrap_or(0))?;

        Ok(())
    }

    fn buffer_length(&self) -> usize {
        6
    }
}

#[derive(Debug, Clone, PartialEq)]
pub struct ExtendedBitmapDataPdu<'a> {
    pub bpp: u8,
    pub codec_id: u8,
    pub width: u16,
    pub height: u16,
    pub header: Option<BitmapDataHeader>,
    pub data: &'a [u8],
}

impl<'a> PduBufferParsing<'a> for ExtendedBitmapDataPdu<'a> {
    type Error = SurfaceCommandsError;

    fn from_buffer_consume(buffer: &mut &'a [u8]) -> Result<Self, Self::Error> {
        let bpp = buffer.read_u8()?;
        let flags = BitmapDataFlags::from_bits_truncate(buffer.read_u8()?);
        let _reserved = buffer.read_u8()?;
        let codec_id = buffer.read_u8()?;
        let width = buffer.read_u16::<LittleEndian>()?;
        let height = buffer.read_u16::<LittleEndian>()?;
        let data_length = buffer.read_u32::<LittleEndian>()? as usize;
        let header = if flags.contains(BitmapDataFlags::COMPRESSED_BITMAP_HEADER_PRESENT) {
            Some(BitmapDataHeader::from_buffer_consume(buffer)?)
        } else {
            None
        };

        if buffer.len() < data_length {
            return Err(SurfaceCommandsError::InvalidDataLength {
                expected: data_length,
                actual: buffer.len(),
            });
        }
        let data = buffer.split_to(data_length);

        Ok(Self {
            bpp,
            codec_id,
            width,
            height,
            header,
            data,
        })
    }

    fn to_buffer_consume(&self, buffer: &mut &mut [u8]) -> Result<(), Self::Error> {
        buffer.write_u8(self.bpp)?;

        let flags = if self.header.is_some() {
            BitmapDataFlags::COMPRESSED_BITMAP_HEADER_PRESENT
        } else {
            BitmapDataFlags::empty()
        };
        buffer.write_u8(flags.bits())?;
        buffer.write_u8(0)?; // reserved
        buffer.write_u8(self.codec_id)?;
        buffer.write_u16::<LittleEndian>(self.width)?;
        buffer.write_u16::<LittleEndian>(self.height)?;
        buffer.write_u32::<LittleEndian>(self.data.len() as u32)?;
        if let Some(ref header) = self.header {
            header.to_buffer_consume(buffer)?;
        }
        buffer.write_all(self.data)?;

        Ok(())
    }

    fn buffer_length(&self) -> usize {
        12 + self
            .header
            .as_ref()
            .map(PduBufferParsing::buffer_length)
            .unwrap_or(0)
            + self.data.len()
    }
}

#[derive(Debug, Clone, PartialEq)]
pub struct BitmapDataHeader {
    pub high_unique_id: u32,
    pub low_unique_id: u32,
    pub tm_milliseconds: u64,
    pub tm_seconds: u64,
}

impl<'a> PduBufferParsing<'a> for BitmapDataHeader {
    type Error = SurfaceCommandsError;

    fn from_buffer_consume(buffer: &mut &[u8]) -> Result<Self, Self::Error> {
        let high_unique_id = buffer.read_u32::<LittleEndian>()?;
        let low_unique_id = buffer.read_u32::<LittleEndian>()?;
        let tm_milliseconds = buffer.read_u64::<LittleEndian>()?;
        let tm_seconds = buffer.read_u64::<LittleEndian>()?;

        Ok(Self {
            high_unique_id,
            low_unique_id,
            tm_milliseconds,
            tm_seconds,
        })
    }

    fn to_buffer_consume(&self, buffer: &mut &mut [u8]) -> Result<(), Self::Error> {
        buffer.write_u32::<LittleEndian>(self.high_unique_id)?;
        buffer.write_u32::<LittleEndian>(self.low_unique_id)?;
        buffer.write_u64::<LittleEndian>(self.tm_milliseconds)?;
        buffer.write_u64::<LittleEndian>(self.tm_seconds)?;

        Ok(())
    }

    fn buffer_length(&self) -> usize {
        24
    }
}

#[derive(Debug, Copy, Clone, PartialEq, FromPrimitive, ToPrimitive)]
#[repr(u16)]
enum SurfaceCommandType {
    SetSurfaceBits = 0x01,
    FrameMarker = 0x04,
    StreamSurfaceBits = 0x06,
}

impl<'a> From<&SurfaceCommand<'a>> for SurfaceCommandType {
    fn from(command: &SurfaceCommand<'_>) -> Self {
        match command {
            SurfaceCommand::SetSurfaceBits(_) => Self::SetSurfaceBits,
            SurfaceCommand::FrameMarker(_) => Self::FrameMarker,
            SurfaceCommand::StreamSurfaceBits(_) => Self::StreamSurfaceBits,
        }
    }
}

#[derive(Debug, Copy, Clone, PartialEq, FromPrimitive, ToPrimitive)]
#[repr(u16)]
pub enum FrameAction {
    Begin = 0x00,
    End = 0x01,
}

bitflags! {
    struct BitmapDataFlags: u8 {
        const COMPRESSED_BITMAP_HEADER_PRESENT = 0x01;
    }
}

#[derive(Debug, Fail)]
pub enum SurfaceCommandsError {
    #[fail(display = "IO error: {}", _0)]
    IOError(#[fail(cause)] io::Error),
    #[fail(display = "Invalid Surface Command type: {}", _0)]
    InvalidSurfaceCommandType(u16),
    #[fail(display = "Invalid Frame Marker action: {}", _0)]
    InvalidFrameAction(u16),
    #[fail(
        display = "Input buffer is shorter then the data length: {} < {}",
        actual, expected
    )]
    InvalidDataLength { expected: usize, actual: usize },
}

impl_from_error!(
    io::Error,
    SurfaceCommandsError,
    SurfaceCommandsError::IOError
);