smb 0.8.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

use binrw::{BinRead, BinWrite};
#[cfg(feature = "async")]
use futures_core::future::BoxFuture;
#[cfg(feature = "async")]
use futures_util::FutureExt;
use std::io::Cursor;

use crate::packets::transport::SmbTcpMessageHeader;

#[allow(async_fn_in_trait)]
pub trait SmbTransport: Send + SmbTransportRead + SmbTransportWrite {
    #[cfg(feature = "async")]
    fn connect<'a>(&'a mut self, endpoint: &'a str) -> BoxFuture<'a, crate::Result<()>>;
    #[cfg(not(feature = "async"))]
    fn connect(&mut self, endpoint: &str) -> crate::Result<()>;

    fn default_port(&self) -> u16;

    /// Splits the transport into two separate transports:
    /// One for reading, and one for writing,
    /// given that the transport has both the reading and writing capabilities.
    fn split(
        self: Box<Self>,
    ) -> crate::Result<(Box<dyn SmbTransportRead>, Box<dyn SmbTransportWrite>)>;
}

pub trait SmbTransportWrite: Send {
    #[cfg(feature = "async")]
    fn send_raw<'a>(&'a mut self, buf: &'a [u8]) -> BoxFuture<'a, crate::Result<()>>;
    #[cfg(not(feature = "async"))]
    fn send_raw(&mut self, buf: &[u8]) -> crate::Result<()>;

    #[cfg(feature = "async")]
    fn send<'a>(&'a mut self, message: &'a [u8]) -> BoxFuture<'a, crate::Result<()>> {
        async {
            // Transport Header
            let header = SmbTcpMessageHeader {
                stream_protocol_length: message.len() as u32,
            };
            let mut header_buf = Vec::with_capacity(SmbTcpMessageHeader::SIZE);
            header.write(&mut Cursor::new(&mut header_buf))?;
            self.send_raw(&header_buf).await?;

            // Content - final response.
            self.send_raw(message).await
        }
        .boxed()
    }
    #[cfg(not(feature = "async"))]
    fn send(&mut self, message: &[u8]) -> crate::Result<()> {
        // Transport Header
        let header = SmbTcpMessageHeader {
            stream_protocol_length: message.len() as u32,
        };
        let mut header_buf = Vec::with_capacity(SmbTcpMessageHeader::SIZE);
        header.write(&mut Cursor::new(&mut header_buf))?;
        self.send_raw(&header_buf)?;

        // Content - final response.
        self.send_raw(message)
    }
}

pub trait SmbTransportWriteExt: SmbTransportWrite {
    #[cfg(feature = "async")]
    /// Use this method to send a SMB message to the server.
    /// This sends the message itself, adding the transport header.
    fn send<'a>(&'a mut self, message: &'a [u8]) -> BoxFuture<'a, crate::Result<()>>;
    #[cfg(not(feature = "async"))]
    /// Use this method to send a SMB message to the server.
    /// This sends the message itself, adding the transport header.
    fn send(&mut self, message: &[u8]) -> crate::Result<()>;
}

pub trait SmbTransportRead: Send {
    #[cfg(feature = "async")]
    fn receive_exact<'a>(&'a mut self, out_buf: &'a mut [u8]) -> BoxFuture<'a, crate::Result<()>>;
    #[cfg(not(feature = "async"))]
    fn receive_exact(&mut self, out_buf: &mut [u8]) -> crate::Result<()>;

    #[cfg(feature = "async")]
    fn receive<'a>(&'a mut self) -> BoxFuture<'a, crate::Result<Vec<u8>>> {
        async {
            // Transport Header
            let mut header_data = [0; SmbTcpMessageHeader::SIZE];
            self.receive_exact(&mut header_data).await?;
            let header = SmbTcpMessageHeader::read(&mut Cursor::new(header_data))?;

            // Content - final response.
            let mut data = vec![0; header.stream_protocol_length as usize];
            self.receive_exact(&mut data).await?;

            log::trace!(
                "Received SMB message of {} bytes from server: {:?}",
                data.len(),
                data
            );

            Ok(data)
        }
        .boxed()
    }

    #[cfg(not(feature = "async"))]
    fn receive(&mut self) -> crate::Result<Vec<u8>> {
        // Transport Header
        let mut header_data = [0; SmbTcpMessageHeader::SIZE];
        self.receive_exact(&mut header_data)?;
        let header = SmbTcpMessageHeader::read(&mut Cursor::new(header_data))?;

        // Content - final response.
        let mut data = vec![0; header.stream_protocol_length as usize];
        self.receive_exact(&mut data)?;

        log::trace!(
            "Received SMB message of {} bytes from server: {:?}",
            data.len(),
            data
        );

        Ok(data)
    }

    /// For synchronous implementations, sets the read timeout for the connection.
    /// This is useful when polling for messages.
    #[cfg(not(feature = "async"))]
    fn set_read_timeout(&self, timeout: std::time::Duration) -> crate::Result<()>;
}

pub trait SmbTransportReadExt: SmbTransportRead {
    #[cfg(feature = "async")]
    /// Use this method to receive a SMB message from the server.
    /// This returns the message itself, dropping the transport header.
    fn receive<'a>(&'a mut self) -> BoxFuture<'a, crate::Result<Vec<u8>>>;
    #[cfg(not(feature = "async"))]
    /// Use this method to receive a SMB message from the server.
    /// This returns the message itself, dropping the transport header.
    fn receive(&mut self) -> crate::Result<Vec<u8>>;
}

impl SmbTransportReadExt for dyn SmbTransportRead + '_ {
    #[cfg(feature = "async")]
    #[inline]
    fn receive<'a>(&'a mut self) -> BoxFuture<'a, crate::Result<Vec<u8>>> {
        self.receive()
    }
    #[cfg(not(feature = "async"))]
    #[inline]
    fn receive(&mut self) -> crate::Result<Vec<u8>> {
        self.receive()
    }
}

impl SmbTransportReadExt for dyn SmbTransport + '_ {
    #[cfg(feature = "async")]
    #[inline]
    fn receive<'a>(&'a mut self) -> BoxFuture<'a, crate::Result<Vec<u8>>> {
        self.receive()
    }
    #[cfg(not(feature = "async"))]
    #[inline]
    fn receive(&mut self) -> crate::Result<Vec<u8>> {
        self.receive()
    }
}