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
use std::convert::TryFrom;
use std::io::{self, IoSlice, IoSliceMut};
use std::marker::PhantomData;
use std::mem::{size_of, zeroed};
use std::os::unix::io::RawFd;

#[cfg(target_os = "android")]
use std::ptr::eq;
use std::ptr::read_unaligned;
use std::slice::from_raw_parts;

pub(super) fn recv_vectored_with_ancillary(
    socket: RawFd,
    bufs: &mut [IoSliceMut<'_>],
    ancillary: &mut SocketAncillary<'_>,
) -> std::io::Result<usize> {
    unsafe {
        let mut msg: libc::msghdr = zeroed();
        msg.msg_iov = bufs.as_mut_ptr().cast();
        msg.msg_control = ancillary.buffer.as_mut_ptr().cast();
        #[cfg(any(target_os = "android", all(target_os = "linux", target_env = "gnu")))]
        {
            msg.msg_iovlen = bufs.len() as libc::size_t;
            msg.msg_controllen = ancillary.buffer.len() as libc::size_t;
        }
        #[cfg(any(
            target_os = "dragonfly",
            target_os = "emscripten",
            target_os = "freebsd",
            all(target_os = "linux", target_env = "musl",),
            target_os = "netbsd",
            target_os = "openbsd",
        ))]
        {
            msg.msg_iovlen = bufs.len() as libc::c_int;
            msg.msg_controllen = ancillary.buffer.len() as libc::socklen_t;
        }
        let msg_ptr = &mut msg as *mut libc::msghdr;
        let recvd = libc::recvmsg(socket, msg_ptr, libc::MSG_CMSG_CLOEXEC);
        if recvd == -1 {
            Err(std::io::Error::last_os_error())
        } else {
            ancillary.length = msg.msg_controllen as usize;
            ancillary.truncated = msg.msg_flags & libc::MSG_CTRUNC == libc::MSG_CTRUNC;
            Ok(recvd as usize)
        }
    }
}

pub(super) fn send_vectored_with_ancillary(
    socket: RawFd,
    bufs: &[IoSlice<'_>],
    ancillary: &mut SocketAncillary<'_>,
) -> io::Result<usize> {
    unsafe {
        let mut msg: libc::msghdr = zeroed();
        // SAFETY:  This mut cast is safe because we know it will not be modified.
        msg.msg_iov = bufs.as_ptr() as *mut _;
        msg.msg_control = ancillary.buffer.as_mut_ptr().cast();

        #[cfg(any(target_os = "android", all(target_os = "linux", target_env = "gnu")))]
        {
            msg.msg_iovlen = bufs.len() as libc::size_t;
            msg.msg_controllen = ancillary.length as libc::size_t;
        }
        #[cfg(any(
            target_os = "dragonfly",
            target_os = "emscripten",
            target_os = "freebsd",
            all(target_os = "linux", target_env = "musl",),
            target_os = "netbsd",
            target_os = "openbsd",
        ))]
        {
            msg.msg_iovlen = bufs.len() as libc::c_int;
            msg.msg_controllen = ancillary.length as libc::socklen_t;
        }

        ancillary.truncated = false;
        let msg_ptr = &msg as *const libc::msghdr;
        let sent = libc::sendmsg(socket, msg_ptr, 0);
        if sent == -1 {
            Err(std::io::Error::last_os_error())
        } else {
            Ok(sent as usize)
        }
    }
}

fn add_to_ancillary_data<T>(
    buffer: &mut [u8],
    length: &mut usize,
    source: &[T],
    cmsg_level: libc::c_int,
    cmsg_type: libc::c_int,
) -> bool {
    let source_len = if let Some(source_len) = source.len().checked_mul(size_of::<T>()) {
        if let Ok(source_len) = u32::try_from(source_len) {
            source_len
        } else {
            return false;
        }
    } else {
        return false;
    };

    unsafe {
        let additional_space = libc::CMSG_SPACE(source_len) as usize;

        let new_length = if let Some(new_length) = additional_space.checked_add(*length) {
            new_length
        } else {
            return false;
        };

        if new_length > buffer.len() {
            return false;
        }

        buffer[*length..new_length].fill(0);

        *length = new_length;

        let mut msg: libc::msghdr = zeroed();
        msg.msg_control = buffer.as_mut_ptr().cast();

        #[cfg(any(target_os = "android", all(target_os = "linux", target_env = "gnu")))]
        {
            msg.msg_controllen = *length as libc::size_t;
        }
        #[cfg(any(
            target_os = "dragonfly",
            target_os = "emscripten",
            target_os = "freebsd",
            all(target_os = "linux", target_env = "musl",),
            target_os = "netbsd",
            target_os = "openbsd",
        ))]
        {
            msg.msg_controllen = *length as libc::socklen_t;
        }

        let mut cmsg = libc::CMSG_FIRSTHDR(&msg);
        let mut previous_cmsg = cmsg;
        while !cmsg.is_null() {
            previous_cmsg = cmsg;
            cmsg = libc::CMSG_NXTHDR(&msg, cmsg);
            // Android return the same pointer if it is the last cmsg.
            // Therefore, check it if the previous pointer is the same as the current one.
            #[cfg(target_os = "android")]
            {
                if cmsg == previous_cmsg {
                    break;
                }
            }
        }

        if previous_cmsg.is_null() {
            return false;
        }

        (*previous_cmsg).cmsg_level = cmsg_level;
        (*previous_cmsg).cmsg_type = cmsg_type;
        #[cfg(any(target_os = "android", all(target_os = "linux", target_env = "gnu")))]
        {
            (*previous_cmsg).cmsg_len = libc::CMSG_LEN(source_len) as libc::size_t;
        }
        #[cfg(any(
            target_os = "dragonfly",
            target_os = "emscripten",
            target_os = "freebsd",
            all(target_os = "linux", target_env = "musl",),
            target_os = "netbsd",
            target_os = "openbsd",
        ))]
        {
            (*previous_cmsg).cmsg_len = libc::CMSG_LEN(source_len) as libc::socklen_t;
        }

        let data = libc::CMSG_DATA(previous_cmsg).cast();

        libc::memcpy(data, source.as_ptr().cast(), source_len as usize);
    }
    true
}

struct AncillaryDataIter<'a, T> {
    data: &'a [u8],
    phantom: PhantomData<T>,
}

impl<'a, T> AncillaryDataIter<'a, T> {
    /// Create `AncillaryDataIter` struct to iterate through the data unit in the control message.
    ///
    /// # Safety
    ///
    /// `data` must contain a valid control message.
    unsafe fn new(data: &'a [u8]) -> AncillaryDataIter<'a, T> {
        AncillaryDataIter {
            data,
            phantom: PhantomData,
        }
    }
}

impl<'a, T> Iterator for AncillaryDataIter<'a, T> {
    type Item = T;

    fn next(&mut self) -> Option<T> {
        if size_of::<T>() <= self.data.len() {
            unsafe {
                let unit = read_unaligned(self.data.as_ptr().cast());
                self.data = &self.data[size_of::<T>()..];
                Some(unit)
            }
        } else {
            None
        }
    }
}

/// This control message contains file descriptors.
///
/// The level is equal to `SOL_SOCKET` and the type is equal to `SCM_RIGHTS`.
pub struct ScmRights<'a>(AncillaryDataIter<'a, RawFd>);

impl<'a> Iterator for ScmRights<'a> {
    type Item = RawFd;

    fn next(&mut self) -> Option<RawFd> {
        self.0.next()
    }
}

/// The error type which is returned from parsing the type a control message.
#[non_exhaustive]
#[derive(Debug)]
pub enum AncillaryError {
    Unknown { cmsg_level: i32, cmsg_type: i32 },
}

/// This enum represent one control message of variable type.
pub enum AncillaryData<'a> {
    ScmRights(ScmRights<'a>),
}

impl<'a> AncillaryData<'a> {
    /// Create a `AncillaryData::ScmRights` variant.
    ///
    /// # Safety
    ///
    /// `data` must contain a valid control message and the control message must be type of
    /// `SOL_SOCKET` and level of `SCM_RIGHTS`.
    unsafe fn from_data(data: &'a [u8]) -> Self {
        let ancillary_data_iter = AncillaryDataIter::new(data);
        let scm_rights = ScmRights(ancillary_data_iter);
        AncillaryData::ScmRights(scm_rights)
    }

    fn try_from_cmsghdr(cmsg: &'a libc::cmsghdr) -> Result<Self, AncillaryError> {
        unsafe {
            #[cfg(any(
                target_os = "android",
                all(target_os = "linux", target_env = "gnu"),
                all(target_os = "linux", target_env = "uclibc"),
            ))]
            let cmsg_len_zero = libc::CMSG_LEN(0) as libc::size_t;
            #[cfg(any(
                target_os = "dragonfly",
                target_os = "emscripten",
                target_os = "freebsd",
                all(target_os = "linux", target_env = "musl",),
                target_os = "netbsd",
                target_os = "openbsd",
            ))]
            let cmsg_len_zero = libc::CMSG_LEN(0) as libc::socklen_t;

            let data_len = (*cmsg).cmsg_len - cmsg_len_zero;
            let data = libc::CMSG_DATA(cmsg).cast();
            let data = from_raw_parts(data, data_len as usize);

            match (*cmsg).cmsg_level {
                libc::SOL_SOCKET => match (*cmsg).cmsg_type {
                    libc::SCM_RIGHTS => Ok(AncillaryData::from_data(data)),
                    cmsg_type => Err(AncillaryError::Unknown {
                        cmsg_level: libc::SOL_SOCKET,
                        cmsg_type,
                    }),
                },
                cmsg_level => Err(AncillaryError::Unknown {
                    cmsg_level,
                    cmsg_type: (*cmsg).cmsg_type,
                }),
            }
        }
    }
}

/// This struct is used to iterate through the control messages.
pub struct Messages<'a> {
    buffer: &'a [u8],
    current: Option<&'a libc::cmsghdr>,
}

impl<'a> Iterator for Messages<'a> {
    type Item = Result<AncillaryData<'a>, AncillaryError>;

    fn next(&mut self) -> Option<Self::Item> {
        unsafe {
            let mut msg: libc::msghdr = zeroed();
            msg.msg_control = self.buffer.as_ptr() as *mut _;

            #[cfg(any(target_os = "android", all(target_os = "linux", target_env = "gnu")))]
            {
                msg.msg_controllen = self.buffer.len() as libc::size_t;
            }
            #[cfg(any(
                target_os = "dragonfly",
                target_os = "emscripten",
                target_os = "freebsd",
                all(target_os = "linux", target_env = "musl",),
                target_os = "netbsd",
                target_os = "openbsd",
            ))]
            {
                msg.msg_controllen = self.buffer.len() as libc::socklen_t;
            }

            let cmsg = if let Some(current) = self.current {
                libc::CMSG_NXTHDR(&msg, current)
            } else {
                libc::CMSG_FIRSTHDR(&msg)
            };

            let cmsg = cmsg.as_ref()?;
            // Android return the same pointer if it is the last cmsg.
            // Therefore, check it if the previous pointer is the same as the current one.
            #[cfg(target_os = "android")]
            {
                if let Some(current) = self.current {
                    if eq(current, cmsg) {
                        return None;
                    }
                }
            }

            self.current = Some(cmsg);
            let ancillary_result = AncillaryData::try_from_cmsghdr(cmsg);
            Some(ancillary_result)
        }
    }
}

/// A Unix socket Ancillary data struct.
#[derive(Debug)]
pub struct SocketAncillary<'a> {
    buffer: &'a mut [u8],
    length: usize,
    truncated: bool,
}

impl<'a> SocketAncillary<'a> {
    /// Create an ancillary data with the given buffer.
    pub fn new(buffer: &'a mut [u8]) -> Self {
        SocketAncillary {
            buffer,
            length: 0,
            truncated: false,
        }
    }

    /// Returns the capacity of the buffer.
    #[allow(dead_code)]
    pub fn capacity(&self) -> usize {
        self.buffer.len()
    }

    /// Returns the number of used bytes.
    #[allow(dead_code)]
    pub fn len(&self) -> usize {
        self.length
    }

    /// Returns the iterator of the control messages.
    pub fn messages(&self) -> Messages<'_> {
        Messages {
            buffer: &self.buffer[..self.length],
            current: None,
        }
    }

    /// Is `true` if during a recv operation the ancillary was truncated.
    #[allow(dead_code)]
    pub fn truncated(&self) -> bool {
        self.truncated
    }

    /// Add file descriptors to the ancillary data.
    ///
    /// The function returns `true` if there was enough space in the buffer.
    /// If there was not enough space then no file descriptors was appended.
    /// Technically, that means this operation adds a control message with the level `SOL_SOCKET`
    /// and type `SCM_RIGHTS`.
    pub fn add_fds(&mut self, fds: &[RawFd]) -> bool {
        self.truncated = false;
        add_to_ancillary_data(
            &mut self.buffer,
            &mut self.length,
            fds,
            libc::SOL_SOCKET,
            libc::SCM_RIGHTS,
        )
    }

    /// Clears the ancillary data, removing all values.
    #[allow(dead_code)]
    pub fn clear(&mut self) {
        self.length = 0;
        self.truncated = false;
    }
}