Skip to content

Commit 6639672

Browse files
borsbors
committed
Auto merge of rust-lang#117156 - jmillikin:os-unix-socket-ext, r=Amanieu,dtolnay
Convert `Unix{Datagram,Stream}::{set_}passcred()` to per-OS traits These methods are the pre-stabilized API for obtaining peer credentials from an `AF_UNIX` socket, part of the `unix_socket_ancillary_data` feature. Their current behavior is to get/set one of the `SO_PASSCRED` (Linux), `LOCAL_CREDS_PERSISTENT` (FreeBSD), or `LOCAL_CREDS` (NetBSD) socket options. On other targets the `{set_}passcred()` methods do not exist. There are two problems with this approach: 1. Having public methods only exist for certain targets isn't permitted in a stable `std` API. 2. These options have generally similar purposes, but they are non-POSIX and their details can differ in subtle and surprising ways (such as whether they continue to be set after the next call to `recvmsg()`). Splitting into OS-specific extension traits is the preferred solution to both problems.
2 parents a6d93ac + 93f2f2c commit 6639672

File tree

12 files changed

+246
-138
lines changed

12 files changed

+246
-138
lines changed

‎library/std/src/os/android/net.rs

+3
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,8 @@
55
#[stable(feature = "unix_socket_abstract", since = "1.70.0")]
66
pub use crate::os::net::linux_ext::addr::SocketAddrExt;
77

8+
#[unstable(feature = "unix_socket_ancillary_data", issue = "76915")]
9+
pub use crate::os::net::linux_ext::socket::UnixSocketExt;
10+
811
#[unstable(feature = "tcp_quickack", issue = "96256")]
912
pub use crate::os::net::linux_ext::tcp::TcpStreamExt;

‎library/std/src/os/freebsd/mod.rs

+1
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,5 @@
33
#![stable(feature = "raw_ext", since = "1.1.0")]
44

55
pub mod fs;
6+
pub mod net;
67
pub mod raw;

‎library/std/src/os/freebsd/net.rs

+65
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
//! FreeBSD-specific networking functionality.
2+
3+
#![unstable(feature = "unix_socket_ancillary_data", issue = "76915")]
4+
5+
use crate::io;
6+
use crate::os::unix::net;
7+
use crate::sealed::Sealed;
8+
use crate::sys_common::AsInner;
9+
10+
/// FreeBSD-specific functionality for `AF_UNIX` sockets [`UnixDatagram`]
11+
/// and [`UnixStream`].
12+
///
13+
/// [`UnixDatagram`]: net::UnixDatagram
14+
/// [`UnixStream`]: net::UnixStream
15+
#[unstable(feature = "unix_socket_ancillary_data", issue = "76915")]
16+
pub trait UnixSocketExt: Sealed {
17+
/// Query the current setting of socket option `LOCAL_CREDS_PERSISTENT`.
18+
#[unstable(feature = "unix_socket_ancillary_data", issue = "76915")]
19+
fn local_creds_persistent(&self) -> io::Result<bool>;
20+
21+
/// Enable or disable socket option `LOCAL_CREDS_PERSISTENT`.
22+
///
23+
/// This option enables the credentials of the sending process to be
24+
/// received as a control message in [`AncillaryData`].
25+
///
26+
/// [`AncillaryData`]: net::AncillaryData
27+
///
28+
/// # Examples
29+
///
30+
/// ```no_run
31+
/// #![feature(unix_socket_ancillary_data)]
32+
/// use std::os::freebsd::net::UnixSocketExt;
33+
/// use std::os::unix::net::UnixDatagram;
34+
///
35+
/// fn main() -> std::io::Result<()> {
36+
/// let sock = UnixDatagram::unbound()?;
37+
/// sock.set_local_creds_persistent(true).expect("set_local_creds_persistent failed");
38+
/// Ok(())
39+
/// }
40+
/// ```
41+
#[unstable(feature = "unix_socket_ancillary_data", issue = "76915")]
42+
fn set_local_creds_persistent(&self, local_creds_persistent: bool) -> io::Result<()>;
43+
}
44+
45+
#[unstable(feature = "unix_socket_ancillary_data", issue = "76915")]
46+
impl UnixSocketExt for net::UnixDatagram {
47+
fn local_creds_persistent(&self) -> io::Result<bool> {
48+
self.as_inner().local_creds_persistent()
49+
}
50+
51+
fn set_local_creds_persistent(&self, local_creds_persistent: bool) -> io::Result<()> {
52+
self.as_inner().set_local_creds_persistent(local_creds_persistent)
53+
}
54+
}
55+
56+
#[unstable(feature = "unix_socket_ancillary_data", issue = "76915")]
57+
impl UnixSocketExt for net::UnixStream {
58+
fn local_creds_persistent(&self) -> io::Result<bool> {
59+
self.as_inner().local_creds_persistent()
60+
}
61+
62+
fn set_local_creds_persistent(&self, local_creds_persistent: bool) -> io::Result<()> {
63+
self.as_inner().set_local_creds_persistent(local_creds_persistent)
64+
}
65+
}

‎library/std/src/os/linux/net.rs

+3
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,8 @@
55
#[stable(feature = "unix_socket_abstract", since = "1.70.0")]
66
pub use crate::os::net::linux_ext::addr::SocketAddrExt;
77

8+
#[unstable(feature = "unix_socket_ancillary_data", issue = "76915")]
9+
pub use crate::os::net::linux_ext::socket::UnixSocketExt;
10+
811
#[unstable(feature = "tcp_quickack", issue = "96256")]
912
pub use crate::os::net::linux_ext::tcp::TcpStreamExt;

‎library/std/src/os/net/linux_ext/mod.rs

+3
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@
55
#[stable(feature = "unix_socket_abstract", since = "1.70.0")]
66
pub(crate) mod addr;
77

8+
#[unstable(feature = "unix_socket_ancillary_data", issue = "76915")]
9+
pub(crate) mod socket;
10+
811
#[unstable(feature = "tcp_quickack", issue = "96256")]
912
pub(crate) mod tcp;
1013

‎library/std/src/os/net/linux_ext/socket.rs

+63
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
//! Linux and Android-specific socket functionality.
2+
3+
use crate::io;
4+
use crate::os::unix::net;
5+
use crate::sealed::Sealed;
6+
use crate::sys_common::AsInner;
7+
8+
/// Linux-specific functionality for `AF_UNIX` sockets [`UnixDatagram`]
9+
/// and [`UnixStream`].
10+
///
11+
/// [`UnixDatagram`]: net::UnixDatagram
12+
/// [`UnixStream`]: net::UnixStream
13+
#[unstable(feature = "unix_socket_ancillary_data", issue = "76915")]
14+
pub trait UnixSocketExt: Sealed {
15+
/// Query the current setting of socket option `SO_PASSCRED`.
16+
#[unstable(feature = "unix_socket_ancillary_data", issue = "76915")]
17+
fn passcred(&self) -> io::Result<bool>;
18+
19+
/// Enable or disable socket option `SO_PASSCRED`.
20+
///
21+
/// This option enables the credentials of the sending process to be
22+
/// received as a control message in [`AncillaryData`].
23+
///
24+
/// [`AncillaryData`]: net::AncillaryData
25+
///
26+
/// # Examples
27+
///
28+
/// ```no_run
29+
/// #![feature(unix_socket_ancillary_data)]
30+
/// use std::os::linux::net::UnixSocketExt;
31+
/// use std::os::unix::net::UnixDatagram;
32+
///
33+
/// fn main() -> std::io::Result<()> {
34+
/// let sock = UnixDatagram::unbound()?;
35+
/// sock.set_passcred(true).expect("set_passcred failed");
36+
/// Ok(())
37+
/// }
38+
/// ```
39+
#[unstable(feature = "unix_socket_ancillary_data", issue = "76915")]
40+
fn set_passcred(&self, passcred: bool) -> io::Result<()>;
41+
}
42+
43+
#[unstable(feature = "unix_socket_ancillary_data", issue = "76915")]
44+
impl UnixSocketExt for net::UnixDatagram {
45+
fn passcred(&self) -> io::Result<bool> {
46+
self.as_inner().passcred()
47+
}
48+
49+
fn set_passcred(&self, passcred: bool) -> io::Result<()> {
50+
self.as_inner().set_passcred(passcred)
51+
}
52+
}
53+
54+
#[unstable(feature = "unix_socket_ancillary_data", issue = "76915")]
55+
impl UnixSocketExt for net::UnixStream {
56+
fn passcred(&self) -> io::Result<bool> {
57+
self.as_inner().passcred()
58+
}
59+
60+
fn set_passcred(&self, passcred: bool) -> io::Result<()> {
61+
self.as_inner().set_passcred(passcred)
62+
}
63+
}

‎library/std/src/os/netbsd/mod.rs

+1
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,5 @@
33
#![stable(feature = "raw_ext", since = "1.1.0")]
44

55
pub mod fs;
6+
pub mod net;
67
pub mod raw;

‎library/std/src/os/netbsd/net.rs

+65
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
//! NetBSD-specific networking functionality.
2+
3+
#![unstable(feature = "unix_socket_ancillary_data", issue = "76915")]
4+
5+
use crate::io;
6+
use crate::os::unix::net;
7+
use crate::sealed::Sealed;
8+
use crate::sys_common::AsInner;
9+
10+
/// NetBSD-specific functionality for `AF_UNIX` sockets [`UnixDatagram`]
11+
/// and [`UnixStream`].
12+
///
13+
/// [`UnixDatagram`]: net::UnixDatagram
14+
/// [`UnixStream`]: net::UnixStream
15+
#[unstable(feature = "unix_socket_ancillary_data", issue = "76915")]
16+
pub trait UnixSocketExt: Sealed {
17+
/// Query the current setting of socket option `LOCAL_CREDS`.
18+
#[unstable(feature = "unix_socket_ancillary_data", issue = "76915")]
19+
fn local_creds(&self) -> io::Result<bool>;
20+
21+
/// Enable or disable socket option `LOCAL_CREDS`.
22+
///
23+
/// This option enables the credentials of the sending process to be
24+
/// received as a control message in [`AncillaryData`].
25+
///
26+
/// [`AncillaryData`]: net::AncillaryData
27+
///
28+
/// # Examples
29+
///
30+
/// ```no_run
31+
/// #![feature(unix_socket_ancillary_data)]
32+
/// use std::os::netbsd::net::UnixSocketExt;
33+
/// use std::os::unix::net::UnixDatagram;
34+
///
35+
/// fn main() -> std::io::Result<()> {
36+
/// let sock = UnixDatagram::unbound()?;
37+
/// sock.set_local_creds(true).expect("set_local_creds failed");
38+
/// Ok(())
39+
/// }
40+
/// ```
41+
#[unstable(feature = "unix_socket_ancillary_data", issue = "76915")]
42+
fn set_local_creds(&self, local_creds: bool) -> io::Result<()>;
43+
}
44+
45+
#[unstable(feature = "unix_socket_ancillary_data", issue = "76915")]
46+
impl UnixSocketExt for net::UnixDatagram {
47+
fn local_creds(&self) -> io::Result<bool> {
48+
self.as_inner().local_creds()
49+
}
50+
51+
fn set_local_creds(&self, local_creds: bool) -> io::Result<()> {
52+
self.as_inner().set_local_creds(local_creds)
53+
}
54+
}
55+
56+
#[unstable(feature = "unix_socket_ancillary_data", issue = "76915")]
57+
impl UnixSocketExt for net::UnixStream {
58+
fn local_creds(&self) -> io::Result<bool> {
59+
self.as_inner().local_creds()
60+
}
61+
62+
fn set_local_creds(&self, local_creds: bool) -> io::Result<()> {
63+
self.as_inner().set_local_creds(local_creds)
64+
}
65+
}

‎library/std/src/os/unix/net/datagram.rs

+12-63
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ use crate::io::{IoSlice, IoSliceMut};
66
use crate::net::Shutdown;
77
use crate::os::unix::io::{AsFd, AsRawFd, BorrowedFd, FromRawFd, IntoRawFd, OwnedFd, RawFd};
88
use crate::path::Path;
9+
use crate::sealed::Sealed;
910
use crate::sys::cvt;
1011
use crate::sys::net::Socket;
1112
use crate::sys_common::{AsInner, FromInner, IntoInner};
@@ -54,6 +55,10 @@ const MSG_NOSIGNAL: libc::c_int = 0x0;
5455
#[stable(feature = "unix_socket", since = "1.10.0")]
5556
pub struct UnixDatagram(Socket);
5657

58+
/// Allows extension traits within `std`.
59+
#[unstable(feature = "sealed", issue = "none")]
60+
impl Sealed for UnixDatagram {}
61+
5762
#[stable(feature = "unix_socket", since = "1.10.0")]
5863
impl fmt::Debug for UnixDatagram {
5964
fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
@@ -802,69 +807,6 @@ impl UnixDatagram {
802807
self.0.set_nonblocking(nonblocking)
803808
}
804809

805-
/// Moves the socket to pass unix credentials as control message in [`SocketAncillary`].
806-
///
807-
/// Set the socket option `SO_PASSCRED`.
808-
///
809-
/// # Examples
810-
///
811-
#[cfg_attr(
812-
any(
813-
target_os = "android",
814-
target_os = "linux",
815-
target_os = "netbsd",
816-
target_os = "freebsd",
817-
),
818-
doc = "```no_run"
819-
)]
820-
#[cfg_attr(
821-
not(any(
822-
target_os = "android",
823-
target_os = "linux",
824-
target_os = "netbsd",
825-
target_os = "freebsd"
826-
)),
827-
doc = "```ignore"
828-
)]
829-
/// #![feature(unix_socket_ancillary_data)]
830-
/// use std::os::unix::net::UnixDatagram;
831-
///
832-
/// fn main() -> std::io::Result<()> {
833-
/// let sock = UnixDatagram::unbound()?;
834-
/// sock.set_passcred(true).expect("set_passcred function failed");
835-
/// Ok(())
836-
/// }
837-
/// ```
838-
#[cfg(any(
839-
doc,
840-
target_os = "android",
841-
target_os = "linux",
842-
target_os = "netbsd",
843-
target_os = "freebsd"
844-
))]
845-
#[unstable(feature = "unix_socket_ancillary_data", issue = "76915")]
846-
pub fn set_passcred(&self, passcred: bool) -> io::Result<()> {
847-
self.0.set_passcred(passcred)
848-
}
849-
850-
/// Get the current value of the socket for passing unix credentials in [`SocketAncillary`].
851-
/// This value can be change by [`set_passcred`].
852-
///
853-
/// Get the socket option `SO_PASSCRED`.
854-
///
855-
/// [`set_passcred`]: UnixDatagram::set_passcred
856-
#[cfg(any(
857-
doc,
858-
target_os = "android",
859-
target_os = "linux",
860-
target_os = "netbsd",
861-
target_os = "freebsd"
862-
))]
863-
#[unstable(feature = "unix_socket_ancillary_data", issue = "76915")]
864-
pub fn passcred(&self) -> io::Result<bool> {
865-
self.0.passcred()
866-
}
867-
868810
/// Set the id of the socket for network filtering purpose
869811
///
870812
#[cfg_attr(
@@ -1038,3 +980,10 @@ impl From<OwnedFd> for UnixDatagram {
1038980
unsafe { Self::from_raw_fd(owned.into_raw_fd()) }
1039981
}
1040982
}
983+
984+
impl AsInner<Socket> for UnixDatagram {
985+
#[inline]
986+
fn as_inner(&self) -> &Socket {
987+
&self.0
988+
}
989+
}

0 commit comments

Comments
 (0)