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
use crate::net::{SocketAddr, TcpListener, TcpStream, ToSocketAddrs, UdpSocket};
use cap_primitives::net::no_socket_addrs;
use cap_primitives::{ipnet, AmbientAuthority};
use std::time::Duration;
use std::{io, net};
/// A pool of network addresses.
///
/// This does not directly correspond to anything in `std`, however its methods
/// correspond to the several functions in [`std::net`].
///
/// `Pool` implements `Clone`, which creates new independent entities that
/// carry the full authority of the originals. This means that in a borrow
/// of a `Pool`, the scope of the authority is not necessarily limited to
/// the scope of the borrow.
///
/// Similarly, the [`cap_net_ext::PoolExt`] class allows creating "binder"
/// and "connecter" objects which represent capabilities to bind and
/// connect to addresses.
///
/// [`cap_net_ext::PoolExt`]: https://docs.rs/cap-net-ext/latest/cap_net_ext/trait.PoolExt.html
#[derive(Clone, Default)]
pub struct Pool {
cap: cap_primitives::net::Pool,
}
impl Pool {
/// Construct a new empty pool.
pub fn new() -> Self {
Self {
cap: cap_primitives::net::Pool::new(),
}
}
/// Add addresses to the pool.
///
/// # Ambient Authority
///
/// This function allows ambient access to any IP address.
pub fn insert<A: ToSocketAddrs>(
&mut self,
addrs: A,
ambient_authority: AmbientAuthority,
) -> io::Result<()> {
self.cap.insert(addrs, ambient_authority)
}
/// Add a specific [`net::SocketAddr`] to the pool.
///
/// # Ambient Authority
///
/// This function allows ambient access to any IP address.
pub fn insert_socket_addr(
&mut self,
addr: net::SocketAddr,
ambient_authority: AmbientAuthority,
) {
self.cap.insert_socket_addr(addr, ambient_authority)
}
/// Add a range of network addresses, accepting any port, to the pool.
///
/// Unlike `insert_ip_net`, this function grants access to any requested
/// port.
///
/// # Ambient Authority
///
/// This function allows ambient access to any IP address.
pub fn insert_ip_net_port_any(
&mut self,
ip_net: ipnet::IpNet,
ambient_authority: AmbientAuthority,
) {
self.cap.insert_ip_net_port_any(ip_net, ambient_authority)
}
/// Add a range of network addresses, accepting a range of ports, to the
/// pool.
///
/// This grants access to the port range starting at `ports_start` and,
/// if `ports_end` is provided, ending before `ports_end`.
///
/// # Ambient Authority
///
/// This function allows ambient access to any IP address.
pub fn insert_ip_net_port_range(
&mut self,
ip_net: ipnet::IpNet,
ports_start: u16,
ports_end: Option<u16>,
ambient_authority: AmbientAuthority,
) {
self.cap
.insert_ip_net_port_range(ip_net, ports_start, ports_end, ambient_authority)
}
/// Add a range of network addresses with a specific port to the pool.
///
/// # Ambient Authority
///
/// This function allows ambient access to any IP address.
pub fn insert_ip_net(
&mut self,
ip_net: ipnet::IpNet,
port: u16,
ambient_authority: AmbientAuthority,
) {
self.cap.insert_ip_net(ip_net, port, ambient_authority)
}
/// Creates a new `TcpListener` which will be bound to the specified
/// address.
///
/// This corresponds to [`std::net::TcpListener::bind`].
#[doc(alias = "bind")]
#[inline]
pub fn bind_tcp_listener<A: ToSocketAddrs>(&self, addr: A) -> io::Result<TcpListener> {
let addrs = addr.to_socket_addrs()?;
let mut last_err = None;
for addr in addrs {
self.cap.check_addr(&addr)?;
// TODO: when compiling for WASI, use WASI-specific methods instead
match net::TcpListener::bind(addr) {
Ok(tcp_listener) => return Ok(TcpListener::from_std(tcp_listener)),
Err(e) => last_err = Some(e),
}
}
match last_err {
Some(e) => Err(e),
None => Err(no_socket_addrs()),
}
}
/// Opens a TCP connection to a remote host.
///
/// This corresponds to [`std::net::TcpStream::connect`].
#[doc(alias = "connect")]
#[inline]
pub fn connect_tcp_stream<A: ToSocketAddrs>(&self, addr: A) -> io::Result<TcpStream> {
let addrs = addr.to_socket_addrs()?;
let mut last_err = None;
for addr in addrs {
self.cap.check_addr(&addr)?;
// TODO: when compiling for WASI, use WASI-specific methods instead
match net::TcpStream::connect(addr) {
Ok(tcp_stream) => return Ok(TcpStream::from_std(tcp_stream)),
Err(e) => last_err = Some(e),
}
}
match last_err {
Some(e) => Err(e),
None => Err(no_socket_addrs()),
}
}
/// Opens a TCP connection to a remote host with a timeout.
///
/// This corresponds to [`std::net::TcpStream::connect_timeout`].
#[doc(alias = "connect")]
#[inline]
pub fn connect_timeout_tcp_stream(
&self,
addr: &SocketAddr,
timeout: Duration,
) -> io::Result<TcpStream> {
self.cap.check_addr(addr)?;
let tcp_stream = net::TcpStream::connect_timeout(addr, timeout)?;
Ok(TcpStream::from_std(tcp_stream))
}
/// Creates a UDP socket from the given address.
///
/// This corresponds to [`std::net::UdpSocket::bind`].
#[doc(alias = "bind")]
#[inline]
pub fn bind_udp_socket<A: ToSocketAddrs>(&self, addr: A) -> io::Result<UdpSocket> {
let addrs = addr.to_socket_addrs()?;
let mut last_err = None;
for addr in addrs {
self.cap.check_addr(&addr)?;
match net::UdpSocket::bind(addr) {
Ok(udp_socket) => return Ok(UdpSocket::from_std(udp_socket)),
Err(e) => last_err = Some(e),
}
}
match last_err {
Some(e) => Err(e),
None => Err(no_socket_addrs()),
}
}
/// Sends data on the socket to the given address. On success, returns the
/// number of bytes written.
///
/// This corresponds to [`std::net::UdpSocket::send_to`].
#[doc(alias = "send_to")]
#[inline]
pub fn send_to_udp_socket_addr<A: ToSocketAddrs>(
&self,
udp_socket: &UdpSocket,
buf: &[u8],
addr: A,
) -> io::Result<usize> {
let mut addrs = addr.to_socket_addrs()?;
// `UdpSocket::send_to` only sends to the first address.
let addr = addrs.next().ok_or_else(no_socket_addrs)?;
self.cap.check_addr(&addr)?;
udp_socket.std.send_to(buf, addr)
}
/// Connects this UDP socket to a remote address, allowing the `send` and
/// `recv` syscalls to be used to send data and also applies filters to
/// only receive data from the specified address.
///
/// This corresponds to [`std::net::UdpSocket::connect`].
#[doc(alias = "connect")]
#[inline]
pub fn connect_udp_socket<A: ToSocketAddrs>(
&self,
udp_socket: &UdpSocket,
addr: A,
) -> io::Result<()> {
let addrs = addr.to_socket_addrs()?;
let mut last_err = None;
for addr in addrs {
self.cap.check_addr(&addr)?;
match udp_socket.std.connect(addr) {
Ok(()) => return Ok(()),
Err(e) => last_err = Some(e),
}
}
match last_err {
Some(e) => Err(e),
None => Err(no_socket_addrs()),
}
}
/// This is for cap-net-ext.
#[doc(hidden)]
pub fn _pool(&self) -> &cap_primitives::net::Pool {
&self.cap
}
}