smb 0.9.0

A Pure Rust SMB Client implementation
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
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
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448

use super::binrw_util::prelude::{PosMarker, SizedWideString};
use binrw::{NullWideString, io::TakeSeekExt, prelude::*};
use modular_bitfield::prelude::*;

/// [MS-DFSC 2.2.2](<https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-dfsc/663c9b38-41b8-4faa-b6f6-a4576b4cea62>):
/// DFS referral requests are sent in the form of an REQ_GET_DFS_REFERRAL message, by using an appropriate transport as specified in section 2.1.
#[binrw::binrw]
#[derive(Debug, PartialEq, Eq)]
pub struct ReqGetDfsReferral {
    /// An integer that indicates the highest DFS referral version understood by the client. The DFS referral versions specified by this document are 1 through 4 inclusive. A DFS client MUST support DFS referral version 1 through the version number set in this field. The referral response messages are referral version dependent and are specified in sections 2.2.5.1 through 2.2.5.4.
    pub max_referral_level: ReferralLevel,
    /// A null-terminated Unicode string specifying the path to be resolved. The specified path MUST NOT be case-sensitive. Its format depends on the type of referral request, as specified in section 3.1.4.2.
    pub request_file_name: NullWideString,
}

/// The DFS referral version supported by the client.
/// See [`ReqGetDfsReferral::max_referral_level`].
#[binrw::binrw]
#[derive(Debug, PartialEq, Eq)]
#[brw(repr(u16))]
pub enum ReferralLevel {
    /// DFS referral version 1
    V1 = 1,
    /// DFS referral version 2
    V2 = 2,
    /// DFS referral version 3
    V3 = 3,
    /// DFS referral version 4
    V4 = 4,
}

#[binrw::binrw]
#[derive(Debug, PartialEq, Eq)]
pub struct ReqGetDfsReferralEx {
    /// An integer that indicates the highest DFS referral version understood by the client. The DFS referral versions specified by this document are 1 through 4 inclusive. A DFS client MUST support DFS referral version 1 through the version number set in this field. The referral response messages are referral version dependent and are specified in sections 2.2.5.1 through 2.2.5.4.
    pub max_referral_level: u16,
    pub request_flags: DfsRequestFlags,
    request_data_length: PosMarker<u32>,
    #[bw(write_with = PosMarker::write_size, args(request_data_length))]
    #[br(map_stream = |s| s.take_seek(request_data_length.value as u64))]
    pub request_data: DfsRequestData,
}

#[bitfield]
#[derive(BinWrite, BinRead, Debug, Default, Clone, Copy, PartialEq, Eq)]
#[bw(map = |&x| Self::into_bytes(x))]
#[br(map = Self::from_bytes)]
pub struct DfsRequestFlags {
    /// SiteName present: The SiteName bit MUST be set to 1 if the packet contains the site name of the client.
    pub site_name: bool,
    #[skip]
    __: B15,
}

/// RequestData is part of the REQ_GET_DFS_REFERRAL_EX message (section 2.2.3).
#[binrw::binrw]
#[derive(Debug, PartialEq, Eq)]
pub struct DfsRequestData {
    #[bw(try_calc = request_file_name.len().try_into())]
    request_file_name_length: u16,
    /// A Unicode string specifying the path to be resolved. The specified path MUST be interpreted in a case-insensitive manner. Its format depends on the type of referral request, as specified in section 3.1.4.2.
    #[br(args(request_file_name_length as u64))]
    request_file_name: SizedWideString,
    #[bw(try_calc = site_name.len().try_into())]
    site_name_length: u16,
    /// A Unicode string specifying the name of the site to which the DFS client computer belongs. The length of this string is determined by the value of the SiteNameLength field.
    #[br(args(site_name_length as u64))]
    site_name: SizedWideString,
}

impl DfsRequestData {
    pub fn get_bin_size(&self) -> usize {
        size_of::<u16>() * 2 // lengths
            + self.request_file_name.len() * size_of::<u16>() // + request_file_name (wstring)
            + self.site_name.len() * size_of::<u16>() // + site_name (wstring)
    }
}

#[binrw::binrw]
#[derive(Debug, PartialEq, Eq)]
pub struct RespGetDfsReferral {
    pub path_consumed: u16,
    #[bw(try_calc = referral_entries.len().try_into())]
    number_of_referrals: u16,
    pub referral_header_flags: ReferralHeaderFlags,
    #[br(count = number_of_referrals)]
    pub referral_entries: Vec<ReferralEntry>,
    // string_buffer is here, but it's use is to provide a buffer for the strings in the referral entries.
}

#[bitfield]
#[derive(BinWrite, BinRead, Debug, Default, Clone, Copy, PartialEq, Eq)]
#[bw(map = |&x| Self::into_bytes(x))]
#[br(map = Self::from_bytes)]
pub struct ReferralHeaderFlags {
    /// Whether all of the targets in the referral entries returned are DFS root targets capable of handling DFS referral requests.
    pub referral_servers: bool,
    /// Whether all of the targets in the referral response can be accessed without requiring further referral requests.
    pub storage_servers: bool,
    /// Whether DFS client target failback is enabled for all targets in this referral response. This value used only in version 4.
    pub target_failbacl: bool,
    #[skip]
    __: B29,
}

#[binrw::binrw]
#[derive(Debug, PartialEq, Eq)]
pub struct ReferralEntry {
    #[bw(calc = value.get_version())]
    pub version: u16,
    #[bw(calc = PosMarker::default())]
    _size: PosMarker<u16>,
    #[br(args(version))]
    #[bw(write_with = PosMarker::write_size, args(&_size))]
    pub value: ReferralEntryValue,
}

impl ReferralEntry {
    /// The size of the common part of the referral entry - version + size.
    pub const COMMON_PART_SIZE: usize = std::mem::size_of::<u16>() * 2;
}

macro_rules! gen_ref_entry_val {
    (
        $($ver:literal,)+
    ) => {
        paste::paste! {
        #[binrw::binrw]
        #[derive(Debug, PartialEq, Eq)]
        #[br(import(version: u16))]
        pub enum ReferralEntryValue {
            $(
                #[doc = concat!("A DFS referral version", stringify!($ver), "Entry")]
                #[br(pre_assert(version == $ver))]
                [<V $ver>]([<ReferralEntryValueV $ver>]),
            )+
        }

        impl ReferralEntryValue {
            fn get_version(&self) -> u16 {
                match self {
                    $(
                        Self::[<V $ver>](_) => $ver,
                    )+
                }
            }
        }
                }
    };
}

gen_ref_entry_val!(1, 2, 3, 4,);

#[binrw::binrw]
#[derive(Debug, PartialEq, Eq)]
pub struct ReferralEntryValueV1 {
    /// Type of server hosting the target
    pub server_type: DfsServerType,
    #[bw(calc = 0)]
    _referral_entry_flags: u16,
    /// The DFS target.
    pub share_name: NullWideString,
}

/// Type of server hosting the target
#[binrw::binrw]
#[derive(Debug, PartialEq, Eq)]
#[brw(repr(u16))]
pub enum DfsServerType {
    /// Non-root targets returned.
    NonRoot = 0x0,
    /// Root targets returned.
    Root = 0x1,
}

/// DO NOT use this struct directly when bin read/writing.
/// Use an instance of [`ReferralEntry`] instead.
#[binrw::binrw]
#[derive(Debug, PartialEq, Eq)]
pub struct ReferralEntryValueV2 {
    #[bw(calc = PosMarker::default())]
    _start: PosMarker<()>,
    /// Type of server hosting the target
    pub server_type: DfsServerType,
    #[bw(calc = 0)]
    _referral_entry_flags: u16,
    #[bw(calc = 0)]
    _proximity: u32,

    /// The time-out value, in seconds, of the DFS root or DFS link.
    pub time_to_live: u32,
    #[br(assert(dfs_path_offset.value >= ReferralEntry::COMMON_PART_SIZE as u16))]
    #[bw(calc = PosMarker::default())]
    dfs_path_offset: PosMarker<u16>,
    #[br(assert(dfs_alternate_path_offset.value >= ReferralEntry::COMMON_PART_SIZE as u16))]
    #[bw(calc = PosMarker::default())]
    dfs_alternate_path_offset: PosMarker<u16>,
    #[br(assert(network_address_offset.value >= ReferralEntry::COMMON_PART_SIZE as u16))]
    #[bw(calc = PosMarker::default())]
    network_address_offset: PosMarker<u16>,

    #[bw(calc = PosMarker::default())]
    _restore_position: PosMarker<()>,

    /// The DFS path that corresponds to the DFS root or the DFS link for which target information is returned.
    #[br(seek_before = _start.seek_from((dfs_path_offset.value as usize - ReferralEntry::COMMON_PART_SIZE).try_into().unwrap()))]
    pub dfs_path: NullWideString,
    /// The DFS path that corresponds to the DFS root or the DFS link for which target information is returned.
    #[br(seek_before = _start.seek_from((dfs_alternate_path_offset.value as usize - ReferralEntry::COMMON_PART_SIZE).try_into().unwrap()))]
    pub dfs_alternate_path: NullWideString,
    /// The DFS target that corresponds to this entry.
    #[br(seek_before = _start.seek_from((network_address_offset.value as usize - ReferralEntry::COMMON_PART_SIZE).try_into().unwrap()))]
    pub network_address: NullWideString,

    #[br(seek_before = _restore_position.seek_from(0))]
    #[bw(calc = ())]
    __: (),
}

#[binrw::binrw]
#[derive(Debug, PartialEq, Eq)]
pub struct ReferralEntryValueV3 {
    /// Type of server hosting the target
    pub server_type: DfsServerType,
    pub referral_entry_flags: ReferralEntryFlags,
    /// The time-out value, in seconds, of the DFS root or DFS link.
    pub time_to_live: u32,
    #[br(args(referral_entry_flags))]
    pub value: EntryV3Value,
}

impl ReferralEntryValueV3 {
    /// The size of the common part of the referral entry - version + size.
    pub const COMMON_PART_SIZE: usize = std::mem::size_of::<u16>() * 2 + std::mem::size_of::<u32>();
}

#[bitfield]
#[derive(BinWrite, BinRead, Debug, Default, Clone, Copy, PartialEq, Eq)]
#[bw(map = |&x| Self::into_bytes(x))]
#[br(map = Self::from_bytes)]
pub struct ReferralEntryFlags {
    #[skip]
    __: bool,
    pub name_list_referral: bool,
    #[skip]
    __: B14,
}

#[binrw::binrw]
#[derive(Debug, PartialEq, Eq)]
#[br(import(flags: ReferralEntryFlags))]
pub enum EntryV3Value {
    /// The DFS path that corresponds to the DFS root or the DFS link for which target information is returned.
    #[br(pre_assert(flags.name_list_referral()))]
    DfsPath(EntryV3V4DfsPaths),
    /// The DFS target that corresponds to this entry.
    #[br(pre_assert(!flags.name_list_referral()))]
    NetworkAddress(EntryV3DCRefs),
}

impl EntryV3Value {
    /// (Internal)
    ///
    /// The offset of EntryV3Value from the beginning of the [`ReferralEntry`] structure.
    /// This is used to calculate the offsets of the fields in the structure.
    const OFFSET_FROM_ENTRY_START: u16 =
        (ReferralEntry::COMMON_PART_SIZE + ReferralEntryValueV3::COMMON_PART_SIZE) as u16;
}

/// 2.2.5.3.1 NameListReferral Flag Set to 0
#[binrw::binrw]
#[derive(Debug, PartialEq, Eq)]
pub struct EntryV3V4DfsPaths {
    #[bw(calc = PosMarker::default())]
    _start: PosMarker<()>,
    #[br(assert(dfs_path_offset.value >= EntryV3Value::OFFSET_FROM_ENTRY_START))]
    #[bw(calc = PosMarker::default())]
    dfs_path_offset: PosMarker<u16>,
    #[br(assert(dfs_alternate_path_offset.value >= EntryV3Value::OFFSET_FROM_ENTRY_START))]
    #[bw(calc = PosMarker::default())]
    dfs_alternate_path_offset: PosMarker<u16>,
    #[br(assert(network_address_offset.value >= EntryV3Value::OFFSET_FROM_ENTRY_START))]
    #[bw(calc = PosMarker::default())]
    network_address_offset: PosMarker<u16>,
    #[bw(calc = 0)]
    _service_site_guid: u128,

    #[bw(calc = PosMarker::default())]
    _restore_position: PosMarker<()>,

    /// The DFS path that corresponds to the DFS root or the DFS link for which target information is returned.
    #[br(seek_before = _start.seek_from((dfs_path_offset.value - EntryV3Value::OFFSET_FROM_ENTRY_START).into()))]
    pub dfs_path: NullWideString,
    /// The DFS path that corresponds to the DFS root or the DFS link for which target information is returned.
    #[br(seek_before = _start.seek_from((dfs_alternate_path_offset.value - EntryV3Value::OFFSET_FROM_ENTRY_START).into()))]
    pub dfs_alternate_path: NullWideString,
    /// The DFS target that corresponds to this entry.
    #[br(seek_before = _start.seek_from((network_address_offset.value - EntryV3Value::OFFSET_FROM_ENTRY_START).into()))]
    pub network_address: NullWideString,

    #[br(seek_before = _restore_position.seek_from(0))]
    #[bw(calc = ())]
    __: (),
}

/// 2.2.5.3.2 NameListReferral Flag Set to 1
#[binrw::binrw]
#[derive(Debug, PartialEq, Eq)]
pub struct EntryV3DCRefs {
    #[bw(calc = PosMarker::default())]
    _start: PosMarker<()>,
    #[br(assert(special_name_offset.value >= EntryV3Value::OFFSET_FROM_ENTRY_START))]
    #[bw(calc = PosMarker::default())]
    special_name_offset: PosMarker<u16>,
    number_of_expanded_names: u16,
    #[br(assert(expanded_name_offset.value >= EntryV3Value::OFFSET_FROM_ENTRY_START))]
    #[bw(calc = PosMarker::default())]
    expanded_name_offset: PosMarker<u16>,

    #[bw(calc = PosMarker::default())]
    _restore_position: PosMarker<()>,

    #[br(seek_before = _start.seek_from((special_name_offset.value - EntryV3Value::OFFSET_FROM_ENTRY_START).into()))]
    pub special_name: NullWideString,
    #[br(seek_before = _start.seek_from((expanded_name_offset.value - EntryV3Value::OFFSET_FROM_ENTRY_START).into()))]
    #[br(count = number_of_expanded_names)]
    pub expanded_names: Vec<NullWideString>,

    #[br(seek_before = _restore_position.seek_from(0))]
    #[bw(calc = ())]
    __: (),
}

#[binrw::binrw]
#[derive(Debug, PartialEq, Eq)]
pub struct ReferralEntryValueV4 {
    /// Type of server hosting the target
    pub server_type: DfsServerType,
    // The ONLY valid flag is TargetSetBoundary.
    #[br(assert((referral_entry_flags & !u16::from_le_bytes(ReferralEntryFlagsV4::new().with_target_set_boundary(true).into_bytes())) == 0))]
    pub referral_entry_flags: u16,
    /// The time-out value, in seconds, of the DFS root or DFS link.
    pub time_to_live: u32,
    // name_list_referral: bool is ALWAYS 0, so we know the type of the value.
    pub refs: EntryV3V4DfsPaths,
}

/// Internal.
#[bitfield]
#[derive(BinWrite, BinRead, Debug, Default, Clone, Copy, PartialEq, Eq)]
#[bw(map = |&x| Self::into_bytes(x))]
#[br(map = Self::from_bytes)]
struct ReferralEntryFlagsV4 {
    #[skip]
    __: B2,
    #[skip(getters)]
    target_set_boundary: bool,
    #[skip]
    __: B13,
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::packets::smb2::IoctlRequestContent;
    use std::io::Cursor;

    #[test]
    pub fn test_write_req() {
        let req = ReqGetDfsReferral {
            max_referral_level: ReferralLevel::V4,
            request_file_name: r"\ADC.aviv.local\dfs\Docs".into(),
        };
        let mut buf = Vec::new();
        req.write_le(&mut Cursor::new(&mut buf)).unwrap();
        assert_eq!(buf.len() as u32, req.get_bin_size());
        assert_eq!(
            buf,
            &[
                0x4, 0x0, 0x5c, 0x0, 0x41, 0x0, 0x44, 0x0, 0x43, 0x0, 0x2e, 0x0, 0x61, 0x0, 0x76,
                0x0, 0x69, 0x0, 0x76, 0x0, 0x2e, 0x0, 0x6c, 0x0, 0x6f, 0x0, 0x63, 0x0, 0x61, 0x0,
                0x6c, 0x0, 0x5c, 0x0, 0x64, 0x0, 0x66, 0x0, 0x73, 0x0, 0x5c, 0x0, 0x44, 0x0, 0x6f,
                0x0, 0x63, 0x0, 0x73, 0x0, 0x0, 0x0
            ]
        );
    }

    #[test]
    pub fn test_v4_parses_properly() {
        let bytes = [
            0x30, 0x0, 0x2, 0x0, 0x2, 0x0, 0x0, 0x0, 0x4, 0x0, 0x22, 0x0, 0x0, 0x0, 0x4, 0x0, 0x8,
            0x7, 0x0, 0x0, 0x44, 0x0, 0x76, 0x0, 0xa8, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0,
            0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x4, 0x0, 0x22, 0x0, 0x0, 0x0, 0x0, 0x0, 0x8,
            0x7, 0x0, 0x0, 0x22, 0x0, 0x54, 0x0, 0xa8, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0,
            0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0, 0x5c, 0x0, 0x41, 0x0, 0x44, 0x0, 0x43, 0x0,
            0x2e, 0x0, 0x61, 0x0, 0x76, 0x0, 0x69, 0x0, 0x76, 0x0, 0x2e, 0x0, 0x6c, 0x0, 0x6f, 0x0,
            0x63, 0x0, 0x61, 0x0, 0x6c, 0x0, 0x5c, 0x0, 0x64, 0x0, 0x66, 0x0, 0x73, 0x0, 0x5c, 0x0,
            0x44, 0x0, 0x6f, 0x0, 0x63, 0x0, 0x73, 0x0, 0x0, 0x0, 0x5c, 0x0, 0x41, 0x0, 0x44, 0x0,
            0x43, 0x0, 0x2e, 0x0, 0x61, 0x0, 0x76, 0x0, 0x69, 0x0, 0x76, 0x0, 0x2e, 0x0, 0x6c, 0x0,
            0x6f, 0x0, 0x63, 0x0, 0x61, 0x0, 0x6c, 0x0, 0x5c, 0x0, 0x64, 0x0, 0x66, 0x0, 0x73, 0x0,
            0x5c, 0x0, 0x44, 0x0, 0x6f, 0x0, 0x63, 0x0, 0x73, 0x0, 0x0, 0x0, 0x5c, 0x0, 0x41, 0x0,
            0x44, 0x0, 0x43, 0x0, 0x5c, 0x0, 0x53, 0x0, 0x68, 0x0, 0x61, 0x0, 0x72, 0x0, 0x65, 0x0,
            0x73, 0x0, 0x5c, 0x0, 0x44, 0x0, 0x6f, 0x0, 0x63, 0x0, 0x73, 0x0, 0x0, 0x0, 0x5c, 0x0,
            0x46, 0x0, 0x53, 0x0, 0x52, 0x0, 0x56, 0x0, 0x5c, 0x0, 0x53, 0x0, 0x68, 0x0, 0x61, 0x0,
            0x72, 0x0, 0x65, 0x0, 0x73, 0x0, 0x5c, 0x0, 0x4d, 0x0, 0x79, 0x0, 0x53, 0x0, 0x68, 0x0,
            0x61, 0x0, 0x72, 0x0, 0x65, 0x0, 0x0, 0x0,
        ];

        let r = RespGetDfsReferral::read_le(&mut Cursor::new(&bytes)).unwrap();
        assert_eq!(
            r,
            RespGetDfsReferral {
                path_consumed: 48,
                referral_header_flags: ReferralHeaderFlags::new().with_storage_servers(true),
                referral_entries: vec![
                    ReferralEntry {
                        value: ReferralEntryValue::V4(ReferralEntryValueV4 {
                            server_type: DfsServerType::NonRoot,
                            referral_entry_flags: u16::from_le_bytes(
                                ReferralEntryFlagsV4::new()
                                    .with_target_set_boundary(true)
                                    .into_bytes()
                            ),
                            time_to_live: 1800,
                            refs: EntryV3V4DfsPaths {
                                dfs_path: r"\ADC.aviv.local\dfs\Docs".into(),
                                dfs_alternate_path: r"\ADC.aviv.local\dfs\Docs".into(),
                                network_address: r"\ADC\Shares\Docs".into()
                            }
                        })
                    },
                    ReferralEntry {
                        value: ReferralEntryValue::V4(ReferralEntryValueV4 {
                            server_type: DfsServerType::NonRoot,
                            referral_entry_flags: 0,
                            time_to_live: 1800,
                            refs: EntryV3V4DfsPaths {
                                dfs_path: r"\ADC.aviv.local\dfs\Docs".into(),
                                dfs_alternate_path: r"\ADC.aviv.local\dfs\Docs".into(),
                                network_address: r"\FSRV\Shares\MyShare".into()
                            }
                        })
                    }
                ]
            }
        )
    }
}