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
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
mod connect_initial;
#[cfg(test)]
mod test;

pub use self::connect_initial::{ConnectInitial, ConnectResponse};

use std::io;

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

use crate::{gcc::GccError, per, PduParsing};

pub const RESULT_ENUM_LENGTH: u8 = 16;

const BASE_CHANNEL_ID: u16 = 1001;
const SEND_DATA_PDU_DATA_PRIORITY_AND_SEGMENTATION: u8 = 0x70;

/// The kind of the RDP header message that may carry additional data.
#[derive(Debug, Clone, PartialEq)]
pub enum McsPdu {
    ErectDomainRequest(ErectDomainPdu),
    AttachUserRequest,
    AttachUserConfirm(AttachUserConfirmPdu),
    ChannelJoinRequest(ChannelJoinRequestPdu),
    ChannelJoinConfirm(ChannelJoinConfirmPdu),
    SendDataRequest(SendDataContext),
    SendDataIndication(SendDataContext),
    DisconnectProviderUltimatum(DisconnectUltimatumReason),
}

impl McsPdu {
    pub fn as_short_name(&self) -> &str {
        match self {
            McsPdu::ErectDomainRequest(_) => "Erect Domain Request",
            McsPdu::AttachUserRequest => "Attach User Request",
            McsPdu::AttachUserConfirm(_) => "Attach User Confirm",
            McsPdu::ChannelJoinRequest(_) => "Channel Join Request",
            McsPdu::ChannelJoinConfirm(_) => "Channel Join Confirm",
            McsPdu::SendDataRequest(_) => "Send Data Context",
            McsPdu::SendDataIndication(_) => "Send Data Indication",
            McsPdu::DisconnectProviderUltimatum(_) => "Disconnect Provider Ultimatum",
        }
    }
}

impl PduParsing for McsPdu {
    type Error = McsError;

    fn from_buffer(mut stream: impl io::Read) -> Result<Self, Self::Error> {
        let choice = per::read_choice(&mut stream)?;
        let mcs_pdu = DomainMcsPdu::from_u8(choice >> 2).ok_or(McsError::InvalidDomainMcsPdu)?;

        match mcs_pdu {
            DomainMcsPdu::ErectDomainRequest => Ok(McsPdu::ErectDomainRequest(
                ErectDomainPdu::from_buffer(&mut stream)?,
            )),
            DomainMcsPdu::AttachUserRequest => Ok(McsPdu::AttachUserRequest),
            DomainMcsPdu::AttachUserConfirm => Ok(McsPdu::AttachUserConfirm(
                AttachUserConfirmPdu::from_buffer(&mut stream)?,
            )),
            DomainMcsPdu::ChannelJoinRequest => Ok(McsPdu::ChannelJoinRequest(
                ChannelJoinRequestPdu::from_buffer(&mut stream)?,
            )),
            DomainMcsPdu::ChannelJoinConfirm => Ok(McsPdu::ChannelJoinConfirm(
                ChannelJoinConfirmPdu::from_buffer(&mut stream)?,
            )),
            DomainMcsPdu::DisconnectProviderUltimatum => Ok(McsPdu::DisconnectProviderUltimatum(
                DisconnectUltimatumReason::from_buffer(&mut stream, choice)?,
            )),
            DomainMcsPdu::SendDataRequest => Ok(McsPdu::SendDataRequest(
                SendDataContext::from_buffer(&mut stream)?,
            )),
            DomainMcsPdu::SendDataIndication => Ok(McsPdu::SendDataIndication(
                SendDataContext::from_buffer(&mut stream)?,
            )),
        }
    }

    fn to_buffer(&self, mut stream: impl io::Write) -> Result<(), Self::Error> {
        let (domain_mcs_pdu, options) = match self {
            McsPdu::ErectDomainRequest(_) => (DomainMcsPdu::ErectDomainRequest, 0),
            McsPdu::AttachUserRequest => (DomainMcsPdu::AttachUserRequest, 0),
            McsPdu::AttachUserConfirm(_) => (DomainMcsPdu::AttachUserConfirm, 2),
            McsPdu::ChannelJoinRequest(_) => (DomainMcsPdu::ChannelJoinRequest, 0),
            McsPdu::ChannelJoinConfirm(_) => (DomainMcsPdu::ChannelJoinConfirm, 2),
            McsPdu::DisconnectProviderUltimatum(reason) => {
                (DomainMcsPdu::DisconnectProviderUltimatum, reason.options())
            }
            McsPdu::SendDataRequest(_) => (DomainMcsPdu::SendDataRequest, 0),
            McsPdu::SendDataIndication(_) => (DomainMcsPdu::SendDataIndication, 0),
        };
        per::write_choice(
            &mut stream,
            (domain_mcs_pdu.to_u8().unwrap() << 2) | options,
        )?;

        match self {
            McsPdu::ErectDomainRequest(erect_domain_request) => {
                erect_domain_request.to_buffer(&mut stream)?
            }
            McsPdu::AttachUserRequest => (),
            McsPdu::AttachUserConfirm(attach_user_confirm_pdu) => {
                attach_user_confirm_pdu.to_buffer(&mut stream)?
            }
            McsPdu::ChannelJoinRequest(channel_join_request_pdu) => {
                channel_join_request_pdu.to_buffer(&mut stream)?
            }
            McsPdu::ChannelJoinConfirm(channel_join_confirm_pdu) => {
                channel_join_confirm_pdu.to_buffer(&mut stream)?
            }
            McsPdu::DisconnectProviderUltimatum(reason) => reason.to_buffer(&mut stream)?,
            McsPdu::SendDataRequest(send_data) => send_data.to_buffer(&mut stream)?,
            McsPdu::SendDataIndication(send_data) => send_data.to_buffer(&mut stream)?,
        };

        Ok(())
    }

    fn buffer_length(&self) -> usize {
        let pdu_length = match self {
            McsPdu::ErectDomainRequest(erect_domain_request) => {
                erect_domain_request.buffer_length()
            }
            McsPdu::AttachUserRequest => 0,
            McsPdu::AttachUserConfirm(attach_user_confirm_pdu) => {
                attach_user_confirm_pdu.buffer_length()
            }
            McsPdu::ChannelJoinRequest(channel_join_request_pdu) => {
                channel_join_request_pdu.buffer_length()
            }
            McsPdu::ChannelJoinConfirm(channel_join_confirm_pdu) => {
                channel_join_confirm_pdu.buffer_length()
            }
            McsPdu::DisconnectProviderUltimatum(reason) => reason.buffer_length(),
            McsPdu::SendDataRequest(send_data) => send_data.buffer_length(),
            McsPdu::SendDataIndication(send_data) => send_data.buffer_length(),
        };

        per::SIZEOF_CHOICE + pdu_length
    }
}

#[repr(u8)]
#[derive(Debug, Clone, PartialEq, FromPrimitive, ToPrimitive)]
enum DomainMcsPdu {
    ErectDomainRequest = 1,
    DisconnectProviderUltimatum = 8,
    AttachUserRequest = 10,
    AttachUserConfirm = 11,
    ChannelJoinRequest = 14,
    ChannelJoinConfirm = 15,
    SendDataRequest = 25,
    SendDataIndication = 26,
}

#[derive(Debug, Clone, PartialEq)]
pub struct ErectDomainPdu {
    sub_height: u32,
    sub_interval: u32,
}

impl PduParsing for ErectDomainPdu {
    type Error = io::Error;

    fn from_buffer(mut stream: impl io::Read) -> Result<Self, Self::Error> {
        let sub_height = per::read_u32(&mut stream)?;
        let sub_interval = per::read_u32(&mut stream)?;

        Ok(Self {
            sub_height,
            sub_interval,
        })
    }

    fn to_buffer(&self, mut stream: impl io::Write) -> Result<(), Self::Error> {
        per::write_u32(&mut stream, self.sub_height)?;
        per::write_u32(&mut stream, self.sub_interval)?;

        Ok(())
    }
    fn buffer_length(&self) -> usize {
        per::sizeof_u32(self.sub_height) + per::sizeof_u32(self.sub_interval)
    }
}

#[derive(Debug, Clone, PartialEq)]
pub struct AttachUserConfirmPdu {
    pub user_id: u16,
    result: u8,
}

impl PduParsing for AttachUserConfirmPdu {
    type Error = io::Error;

    fn from_buffer(mut stream: impl io::Read) -> Result<Self, Self::Error> {
        let result = per::read_enum(&mut stream, RESULT_ENUM_LENGTH)?;
        let user_id = per::read_u16(&mut stream, BASE_CHANNEL_ID)?;

        Ok(Self { result, user_id })
    }
    fn to_buffer(&self, mut stream: impl io::Write) -> Result<(), Self::Error> {
        per::write_enum(&mut stream, self.result)?;
        per::write_u16(&mut stream, self.user_id, BASE_CHANNEL_ID)?;

        Ok(())
    }
    fn buffer_length(&self) -> usize {
        per::SIZEOF_ENUM + per::SIZEOF_U16
    }
}

#[derive(Debug, Clone, PartialEq)]
pub struct ChannelJoinRequestPdu {
    user_id: u16,
    channel_id: u16,
}

impl PduParsing for ChannelJoinRequestPdu {
    type Error = io::Error;

    fn from_buffer(mut stream: impl io::Read) -> Result<Self, Self::Error> {
        let user_id = per::read_u16(&mut stream, BASE_CHANNEL_ID)?;
        let channel_id = per::read_u16(&mut stream, 0)?;

        Ok(Self {
            user_id,
            channel_id,
        })
    }
    fn to_buffer(&self, mut stream: impl io::Write) -> Result<(), Self::Error> {
        per::write_u16(&mut stream, self.user_id, BASE_CHANNEL_ID)?;
        per::write_u16(&mut stream, self.channel_id, 0)?;

        Ok(())
    }
    fn buffer_length(&self) -> usize {
        per::SIZEOF_U16 * 2
    }
}

#[derive(Debug, Clone, PartialEq)]
pub struct ChannelJoinConfirmPdu {
    pub channel_id: u16,
    result: u8,
    initiator_id: u16,
    requested_channel_id: u16,
}

impl PduParsing for ChannelJoinConfirmPdu {
    type Error = io::Error;

    fn from_buffer(mut stream: impl io::Read) -> Result<Self, Self::Error> {
        let result = per::read_enum(&mut stream, RESULT_ENUM_LENGTH)?;
        let initiator_id = per::read_u16(&mut stream, BASE_CHANNEL_ID)?;
        let requested_channel_id = per::read_u16(&mut stream, 0)?;
        let channel_id = per::read_u16(&mut stream, 0)?;

        Ok(Self {
            result,
            initiator_id,
            requested_channel_id,
            channel_id,
        })
    }
    fn to_buffer(&self, mut stream: impl io::Write) -> Result<(), Self::Error> {
        per::write_enum(&mut stream, self.result)?;
        per::write_u16(&mut stream, self.initiator_id, BASE_CHANNEL_ID)?;
        per::write_u16(&mut stream, self.requested_channel_id, 0)?;
        per::write_u16(&mut stream, self.channel_id, 0)?;

        Ok(())
    }
    fn buffer_length(&self) -> usize {
        per::SIZEOF_ENUM + per::SIZEOF_U16 * 3
    }
}

/// Contains the channel ID and the length of the data. This structure is a part of the
/// [`RdpHeaderMessage`](enum.RdpHeaderMessage.html).
#[derive(Debug, Clone, PartialEq)]
pub struct SendDataContext {
    pub pdu: Vec<u8>,
    pub initiator_id: u16,
    pub channel_id: u16,
}

impl PduParsing for SendDataContext {
    type Error = io::Error;

    fn from_buffer(mut stream: impl io::Read) -> Result<Self, Self::Error> {
        let initiator_id = per::read_u16(&mut stream, BASE_CHANNEL_ID)?;
        let channel_id = per::read_u16(&mut stream, 0)?;
        let _data_priority_and_segmentation = stream.read_u8()?;
        let (length, _) = per::read_length(&mut stream)?;

        let mut pdu = vec![0; length as usize];
        stream.read_exact(&mut pdu)?;

        Ok(Self {
            pdu,
            initiator_id,
            channel_id,
        })
    }

    fn to_buffer(&self, mut stream: impl io::Write) -> Result<(), Self::Error> {
        per::write_u16(&mut stream, self.initiator_id, BASE_CHANNEL_ID)?;
        per::write_u16(&mut stream, self.channel_id, 0)?;
        stream.write_u8(SEND_DATA_PDU_DATA_PRIORITY_AND_SEGMENTATION)?;
        per::write_length(&mut stream, self.pdu.len() as u16)?;
        stream.write_all(self.pdu.as_ref())?;

        Ok(())
    }
    fn buffer_length(&self) -> usize {
        per::SIZEOF_U16 * 2 + 1 + per::sizeof_length(self.pdu.len() as u16) + self.pdu.len()
    }
}

/// The reason of [`DisconnectProviderUltimatum`](enum.RdpHeaderMessage.html).
#[repr(u8)]
#[derive(Debug, Clone, PartialEq, FromPrimitive, ToPrimitive)]
pub enum DisconnectUltimatumReason {
    DomainDisconnected = 0,
    ProviderInitiated = 1,
    TokenPurged = 2,
    UserRequested = 3,
    ChannelPurged = 4,
}

impl DisconnectUltimatumReason {
    fn from_buffer(mut stream: impl io::Read, choice: u8) -> Result<Self, McsError> {
        let b = per::read_choice(&mut stream)?;

        Self::from_u8(((choice & 0x01) << 1) | (b >> 7))
            .ok_or(McsError::InvalidDisconnectProviderUltimatum)
    }

    fn to_buffer(&self, mut stream: impl io::Write) -> Result<(), McsError> {
        let enumerated = match self {
            DisconnectUltimatumReason::UserRequested
            | DisconnectUltimatumReason::ProviderInitiated => 0x80,
            _ => 0x40,
        };
        per::write_enum(&mut stream, enumerated)?;

        Ok(())
    }
    fn buffer_length(&self) -> usize {
        per::SIZEOF_CHOICE
    }

    fn options(&self) -> u8 {
        match self {
            DisconnectUltimatumReason::TokenPurged | DisconnectUltimatumReason::UserRequested => 1,
            _ => 0,
        }
    }
}

#[derive(Debug, Fail)]
pub enum McsError {
    #[fail(display = "IO error: {}", _0)]
    IOError(#[fail(cause)] io::Error),
    #[fail(display = "GCC block error: {}", _0)]
    GccError(#[fail(cause)] GccError),
    #[fail(display = "Invalid disconnect provider ultimatum")]
    InvalidDisconnectProviderUltimatum,
    #[fail(display = "Invalid domain MCS PDU")]
    InvalidDomainMcsPdu,
    #[fail(display = "Invalid MCS Connection Sequence PDU: {}", _0)]
    InvalidPdu(String),
    #[fail(display = "Invalid invalid MCS channel id: {}", _0)]
    UnexpectedChannelId(String),
}

impl_from_error!(io::Error, McsError, McsError::IOError);
impl_from_error!(GccError, McsError, McsError::GccError);

impl From<McsError> for io::Error {
    fn from(e: McsError) -> io::Error {
        io::Error::new(
            io::ErrorKind::Other,
            format!("MCS Connection Sequence error: {}", e),
        )
    }
}