rename: osproxy -> local redirector (#121)

Cargo.toml

@@ -12,7 +12,7 @@ authors = [
     "Fabio Valentini <[email protected]>",
     "Maximilian Hils <[email protected]>",
 ]
-version = "0.3.11"
+version = "0.4.0"
 publish = false
 repository = "https://github.com/mitmproxy/mitmproxy-rs"
 edition = "2021"

mitmproxy-macos/redirector/README.md

@@ -9,7 +9,7 @@
 
 When starting transparent interception on macOS, the following things happen:
 
-1. mitmproxy-rs' `start_os_proxy` copies the redirector application into `/Applications`,
+1. mitmproxy-rs' `start_local_redirector` copies the redirector application into `/Applications`,
    which is a prerequisite for installing system extensions.
 2. mitmproxy-rs opens a unix socket listener.
 2. mitmproxy-rs starts the `macos-redirector` app, passing the unix socket as an argument.

mitmproxy-rs/mitmproxy_rs/__init__.pyi

@@ -28,13 +28,13 @@ def pubkey(private_key: str) -> str: ...
 
 # Windows
 
-async def start_os_proxy(
+async def start_local_redirector(
     handle_connection: Callable[[TcpStream], Awaitable[None]],
     receive_datagram: Callable[[DatagramTransport, bytes, tuple[str, int], tuple[str, int]], None],
-) -> OsProxy: ...
+) -> LocalRedirector: ...
 
 @final
-class OsProxy:
+class LocalRedirector:
     @staticmethod
     def describe_spec(spec: str) -> None: ...
     def set_intercept(self, spec: str) -> None: ...

mitmproxy-rs/src/lib.rs

@@ -47,8 +47,8 @@ pub fn mitmproxy_rs(py: Python, m: &PyModule) -> PyResult<()> {
     m.add_function(wrap_pyfunction!(util::add_cert, m)?)?;
     m.add_function(wrap_pyfunction!(util::remove_cert, m)?)?;
 
-    m.add_function(wrap_pyfunction!(server::start_os_proxy, m)?)?;
-    m.add_class::<server::OsProxy>()?;
+    m.add_function(wrap_pyfunction!(server::start_local_redirector, m)?)?;
+    m.add_class::<server::LocalRedirector>()?;
 
     m.add_function(wrap_pyfunction!(process_info::active_executables, m)?)?;
     m.add_class::<process_info::Process>()?;

mitmproxy-rs/src/server.rs

@@ -143,13 +143,13 @@ impl Drop for Server {
 
 #[pyclass(module = "mitmproxy_rs")]
 #[derive(Debug)]
-pub struct OsProxy {
+pub struct LocalRedirector {
     server: Server,
     conf_tx: mpsc::UnboundedSender<InterceptConf>,
 }
 
 #[pymethods]
-impl OsProxy {
+impl LocalRedirector {
     /// Return a textual description of the given spec,
     /// or raise a ValueError if the spec is invalid.
     #[staticmethod]
@@ -266,7 +266,7 @@ pub fn start_wireguard_server(
 /// *Availability: Windows*
 #[pyfunction]
 #[allow(unused_variables)]
-pub fn start_os_proxy(
+pub fn start_local_redirector(
     py: Python<'_>,
     handle_connection: PyObject,
     receive_datagram: PyObject,
@@ -284,7 +284,7 @@ pub fn start_os_proxy(
         pyo3_asyncio::tokio::future_into_py(py, async move {
             let (server, conf_tx) = Server::init(conf, handle_connection, receive_datagram).await?;
 
-            Ok(OsProxy { server, conf_tx })
+            Ok(LocalRedirector { server, conf_tx })
         })
     }
     #[cfg(target_os = "macos")]
@@ -312,7 +312,7 @@ pub fn start_os_proxy(
         let conf = MacosConf;
         pyo3_asyncio::tokio::future_into_py(py, async move {
             let (server, conf_tx) = Server::init(conf, handle_connection, receive_datagram).await?;
-            Ok(OsProxy { server, conf_tx })
+            Ok(LocalRedirector { server, conf_tx })
         })
     }
     #[cfg(not(any(windows, target_os = "macos")))]

mitmproxy-rs/src/util.rs

@@ -135,7 +135,7 @@ pub(crate) fn get_tunnel_info(
             "original_dst" => return Ok(socketaddr_to_py(py, *dst_addr)),
             _ => (),
         },
-        TunnelInfo::OsProxy {
+        TunnelInfo::LocalRedirector {
             pid,
             process_name,
             remote_endpoint,

mitmproxy-windows/README.md

@@ -9,5 +9,5 @@ This package contains the following precompiled binaries for Windows:
 ## Redirector Development Setup
 
 1. Run `pip install -e .` to install `mitmproxy_windows` as editable.
-2. Run something along the lines of `mitmdump --mode osproxy:curl`.  
+2. Run something along the lines of `mitmdump --mode local:curl`.  
    You should see a `Development mode: Compiling windows-redirector.exe...` message.

src/messages.rs

@@ -10,7 +10,7 @@ pub enum TunnelInfo {
         src_addr: SocketAddr,
         dst_addr: SocketAddr,
     },
-    OsProxy {
+    LocalRedirector {
         pid: u32,
         process_name: Option<String>,
         /// macOS TCP connections may not have a valid sockname, but

src/packet_sources/macos.rs

@@ -286,7 +286,7 @@ impl ConnectionTask {
             let Some(tun) = flow.tunnel_info else {
                 bail!("no tunnel info")
             };
-            TunnelInfo::OsProxy {
+            TunnelInfo::LocalRedirector {
                 pid: tun.pid,
                 process_name: tun.process_name,
                 remote_endpoint: None,
@@ -374,7 +374,7 @@ impl ConnectionTask {
                 connection_id: self.id,
                 src_addr,
                 dst_addr,
-                tunnel_info: TunnelInfo::OsProxy {
+                tunnel_info: TunnelInfo::LocalRedirector {
                     pid: flow.tunnel_info.as_ref().map(|t| t.pid).unwrap_or(0),
                     process_name: flow.tunnel_info.and_then(|t| t.process_name),
                     remote_endpoint,

src/packet_sources/windows.rs

@@ -185,7 +185,7 @@ impl PacketSourceTask for WindowsTask {
 
                     let event = NetworkEvent::ReceivePacket {
                         packet,
-                        tunnel_info: TunnelInfo::OsProxy {
+                        tunnel_info: TunnelInfo::LocalRedirector {
                             pid,
                             process_name,
                             remote_endpoint: None,