Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 45 additions & 19 deletions src/backend/libc/net/addr.rs
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,26 @@ impl SocketAddrUnix {
})
}

/// Construct a new unnamed address.
///
/// The kernel will assign an abstract Unix-domain address to the socket when you call
/// [`bind_unix()`][crate::net::bind_unix]. You can inspect the assigned name with
/// [`getsockname`][crate::net::getsockname].
///
/// # References
/// - [Linux]
///
/// [Linux]: https://www.man7.org/linux/man-pages/man7/unix.7.html
#[cfg(linux_kernel)]
#[inline]
pub fn new_unnamed() -> Self {
Self {
unix: Self::init(),
#[cfg(not(any(bsd, target_os = "haiku")))]
len: offsetof_sun_path() as _,
}
}

const fn init() -> c::sockaddr_un {
c::sockaddr_un {
#[cfg(any(
Expand Down Expand Up @@ -101,19 +121,10 @@ impl SocketAddrUnix {
/// For a filesystem path address, return the path.
#[inline]
pub fn path(&self) -> Option<&CStr> {
let len = self.len();
if len != 0 && self.unix.sun_path[0] != 0 {
let end = len as usize - offsetof_sun_path();
let bytes = &self.unix.sun_path[..end];
// SAFETY: `from_raw_parts` to convert from `&[c_char]` to `&[u8]`.
// And `from_bytes_with_nul_unchecked` since the string is
// NUL-terminated.
unsafe {
Some(CStr::from_bytes_with_nul_unchecked(slice::from_raw_parts(
bytes.as_ptr().cast(),
bytes.len(),
)))
}
let bytes = self.bytes()?;
if !bytes.is_empty() && bytes[0] != 0 {
// SAFETY: `from_bytes_with_nul_unchecked` since the string is NUL-terminated.
Some(unsafe { CStr::from_bytes_with_nul_unchecked(bytes) })
} else {
None
}
Expand All @@ -123,17 +134,20 @@ impl SocketAddrUnix {
#[cfg(linux_kernel)]
#[inline]
pub fn abstract_name(&self) -> Option<&[u8]> {
let len = self.len();
if len != 0 && self.unix.sun_path[0] == 0 {
let end = len as usize - offsetof_sun_path();
let bytes = &self.unix.sun_path[1..end];
// SAFETY: `from_raw_parts` to convert from `&[c_char]` to `&[u8]`.
unsafe { Some(slice::from_raw_parts(bytes.as_ptr().cast(), bytes.len())) }
if let [0, ref bytes @ ..] = self.bytes()? {
Some(bytes)
} else {
None
}
}

/// `true` if the socket address is unnamed.
#[cfg(linux_kernel)]
#[inline]
pub fn is_unnamed(&self) -> bool {
self.bytes() == Some(&[])
}

#[inline]
pub(crate) fn addr_len(&self) -> c::socklen_t {
#[cfg(not(any(bsd, target_os = "haiku")))]
Expand All @@ -150,6 +164,18 @@ impl SocketAddrUnix {
pub(crate) fn len(&self) -> usize {
self.addr_len() as usize
}

#[inline]
fn bytes(&self) -> Option<&[u8]> {
let len = self.len() as usize;
if len != 0 {
let bytes = &self.unix.sun_path[..len - offsetof_sun_path()];
// SAFETY: `from_raw_parts` to convert from `&[c_char]` to `&[u8]`.
Some(unsafe { slice::from_raw_parts(bytes.as_ptr().cast(), bytes.len()) })
} else {
None
}
}
}

#[cfg(unix)]
Expand Down
63 changes: 44 additions & 19 deletions src/backend/linux_raw/net/addr.rs
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,26 @@ impl SocketAddrUnix {
}
}

/// Construct a new unnamed address.
///
/// The kernel will assign an abstract Unix-domain address to the socket when you call
/// [`bind_unix()`][crate::net::bind_unix]. You can inspect the assigned name with
/// [`getsockname`][crate::net::getsockname].
///
/// # References
/// - [Linux]
///
/// [Linux]: https://www.man7.org/linux/man-pages/man7/unix.7.html
#[cfg(linux_kernel)]
#[inline]
pub fn new_unnamed() -> Self {
Self {
unix: Self::init(),
#[cfg(not(any(bsd, target_os = "haiku")))]
len: offsetof_sun_path() as _,
}
}

const fn init() -> c::sockaddr_un {
c::sockaddr_un {
sun_family: c::AF_UNIX as _,
Expand All @@ -72,17 +92,10 @@ impl SocketAddrUnix {
/// For a filesystem path address, return the path.
#[inline]
pub fn path(&self) -> Option<&CStr> {
let len = self.len();
if len != 0 && self.unix.sun_path[0] as u8 != b'\0' {
let end = len as usize - offsetof_sun_path();
let bytes = &self.unix.sun_path[..end];

// SAFETY: Convert `&[c_char]` to `&[u8]`.
let bytes = unsafe { slice::from_raw_parts(bytes.as_ptr().cast::<u8>(), bytes.len()) };

// SAFETY: `from_bytes_with_nul_unchecked` since the string is
// NUL-terminated.
unsafe { Some(CStr::from_bytes_with_nul_unchecked(bytes)) }
let bytes = self.bytes()?;
if !bytes.is_empty() && bytes[0] != 0 {
// SAFETY: `from_bytes_with_nul_unchecked` since the string is NUL-terminated.
Some(unsafe { CStr::from_bytes_with_nul_unchecked(bytes) })
} else {
None
}
Expand All @@ -91,20 +104,20 @@ impl SocketAddrUnix {
/// For an abstract address, return the identifier.
#[inline]
pub fn abstract_name(&self) -> Option<&[u8]> {
let len = self.len();
if len != 0 && self.unix.sun_path[0] as u8 == b'\0' {
let end = len as usize - offsetof_sun_path();
let bytes = &self.unix.sun_path[1..end];

// SAFETY: Convert `&[c_char]` to `&[u8]`.
let bytes = unsafe { slice::from_raw_parts(bytes.as_ptr().cast::<u8>(), bytes.len()) };

if let [0, ref bytes @ ..] = self.bytes()? {
Some(bytes)
} else {
None
}
}

/// `true` if the socket address is unnamed.
#[cfg(linux_kernel)]
#[inline]
pub fn is_unnamed(&self) -> bool {
self.bytes() == Some(&[])
}

#[inline]
pub(crate) fn addr_len(&self) -> c::socklen_t {
self.len
Expand All @@ -114,6 +127,18 @@ impl SocketAddrUnix {
pub(crate) fn len(&self) -> usize {
self.addr_len() as usize
}

#[inline]
fn bytes(&self) -> Option<&[u8]> {
let len = self.len() as usize;
if len != 0 {
let bytes = &self.unix.sun_path[..len - offsetof_sun_path()];
// SAFETY: `from_raw_parts` to convert from `&[c_char]` to `&[u8]`.
Some(unsafe { slice::from_raw_parts(bytes.as_ptr().cast(), bytes.len()) })
} else {
None
}
}
}

impl PartialEq for SocketAddrUnix {
Expand Down
26 changes: 25 additions & 1 deletion tests/net/unix.rs
Original file line number Diff line number Diff line change
Expand Up @@ -419,6 +419,7 @@ fn test_abstract_unix_msg_unconnected() {
}

#[cfg(not(any(target_os = "redox", target_os = "wasi")))]
#[cfg(feature = "pipe")]
#[test]
fn test_unix_msg_with_scm_rights() {
crate::init();
Expand Down Expand Up @@ -649,7 +650,7 @@ fn test_unix_peercred_explicit() {
/// Like `test_unix_peercred_explicit`, but relies on the fact that
/// `set_socket_passcred` enables passing of the credentials implicitly
/// instead of passing an explicit message to `sendmsg`.
#[cfg(all(feature = "process", linux_kernel))]
#[cfg(all(feature = "pipe", feature = "process", linux_kernel))]
#[test]
fn test_unix_peercred_implicit() {
crate::init();
Expand Down Expand Up @@ -707,6 +708,7 @@ fn test_unix_peercred_implicit() {
/// Like `test_unix_msg_with_scm_rights`, but with multiple file descriptors
/// over multiple control messages.
#[cfg(not(any(target_os = "redox", target_os = "wasi")))]
#[cfg(feature = "pipe")]
#[test]
fn test_unix_msg_with_combo() {
crate::init();
Expand Down Expand Up @@ -915,3 +917,25 @@ fn test_unix_msg_with_combo() {
client.join().unwrap();
server.join().unwrap();
}

/// Bind socket to an unnamed Unix-domain address, and assert that an abstract Unix-domain name was
/// assigned by the kernel.
#[cfg(linux_kernel)]
#[test]
fn test_bind_unnamed_address() {
let address = SocketAddrUnix::new_unnamed();
assert!(address.is_unnamed());
assert_eq!(address.abstract_name(), None);
assert_eq!(address.path(), None);
let sock = socket(AddressFamily::UNIX, SocketType::DGRAM, None).unwrap();
bind_unix(&sock, &address).unwrap();

let address = rustix::net::getsockname(&sock).unwrap();
let address = match address {
rustix::net::SocketAddrAny::Unix(address) => address,
address => panic!("expected Unix address, got {address:?}"),
};
assert!(!address.is_unnamed());
assert_ne!(address.abstract_name(), None);
assert_eq!(address.path(), None);
}
2 changes: 2 additions & 0 deletions tests/net/unix_alloc.rs
Original file line number Diff line number Diff line change
Expand Up @@ -417,6 +417,7 @@ fn test_abstract_unix_msg_unconnected() {
}

#[cfg(not(any(target_os = "redox", target_os = "wasi")))]
#[cfg(feature = "pipe")]
#[test]
fn test_unix_msg_with_scm_rights() {
crate::init();
Expand Down Expand Up @@ -652,6 +653,7 @@ fn test_unix_peercred() {
/// Like `test_unix_msg_with_scm_rights`, but with multiple file descriptors
/// over multiple control messages.
#[cfg(not(any(target_os = "redox", target_os = "wasi")))]
#[cfg(feature = "pipe")]
#[test]
fn test_unix_msg_with_combo() {
crate::init();
Expand Down