macOS: docs++

mitmproxy-macos/README.md

@@ -8,4 +8,10 @@ This package contains the following precompiled binaries for macOS:
 ## Redirector Development Setup
 
 The macOS Network System Extension needs to be signed and notarized during development.
-You need to reconfigure the XCode project to use your own (paid) Apple Developer Account.
+You need to reconfigure the XCode project to use your own (paid) Apple Developer Account.
+
+- Clicking "Build" in XCode should automatically install `/Applications/Mitmproxy Redirector.app`.
+- Run mitmproxy with an `MITMPROXY_KEEP_REDIRECTOR=1` env var to keep the development version.
+  mitmproxy should start with "Using existing mitmproxy redirector app."
+- ⚠️ Bump the network extension version on changes, otherwise existing installations will not be replaced
+  on upgrade, see https://github.com/mitmproxy/mitmproxy_rs/pull/227.

mitmproxy-macos/redirector/ipc/mitmproxy_ipc.pb.swift

@@ -112,6 +112,7 @@ struct MitmproxyIpc_FromProxy: Sendable {
 }
 
 /// Packet (macOS UDP Stream)
+/// ⚠️ Bump network extension version on changes, https://github.com/mitmproxy/mitmproxy_rs/pull/227.
 struct MitmproxyIpc_Packet: @unchecked Sendable {
   // SwiftProtobuf.Message conformance is added in an extension below. See the
   // `Message` and `Message+*Additions` files in the SwiftProtobuf library for
@@ -125,6 +126,7 @@ struct MitmproxyIpc_Packet: @unchecked Sendable {
 }
 
 /// Intercept conf (macOS Control Stream)
+/// ⚠️ Bump network extension version on changes, https://github.com/mitmproxy/mitmproxy_rs/pull/227.
 struct MitmproxyIpc_InterceptConf: Sendable {
   // SwiftProtobuf.Message conformance is added in an extension below. See the
   // `Message` and `Message+*Additions` files in the SwiftProtobuf library for
@@ -138,6 +140,7 @@ struct MitmproxyIpc_InterceptConf: Sendable {
 }
 
 /// New flow (macOS TCP/UDP Stream)
+/// ⚠️ Bump network extension version on changes, https://github.com/mitmproxy/mitmproxy_rs/pull/227.
 struct MitmproxyIpc_NewFlow: Sendable {
   // SwiftProtobuf.Message conformance is added in an extension below. See the
   // `Message` and `Message+*Additions` files in the SwiftProtobuf library for
@@ -172,6 +175,7 @@ struct MitmproxyIpc_NewFlow: Sendable {
   init() {}
 }
 
+/// ⚠️ Bump network extension version on changes, https://github.com/mitmproxy/mitmproxy_rs/pull/227.
 struct MitmproxyIpc_TcpFlow: Sendable {
   // SwiftProtobuf.Message conformance is added in an extension below. See the
   // `Message` and `Message+*Additions` files in the SwiftProtobuf library for
@@ -203,6 +207,7 @@ struct MitmproxyIpc_TcpFlow: Sendable {
   fileprivate var _tunnelInfo: MitmproxyIpc_TunnelInfo? = nil
 }
 
+/// ⚠️ Bump network extension version on changes, https://github.com/mitmproxy/mitmproxy_rs/pull/227.
 struct MitmproxyIpc_UdpFlow: Sendable {
   // SwiftProtobuf.Message conformance is added in an extension below. See the
   // `Message` and `Message+*Additions` files in the SwiftProtobuf library for

src/ipc/mitmproxy_ipc.proto

@@ -25,24 +25,29 @@ message FromProxy {
   }
 }
 // Packet (macOS UDP Stream)
+// ⚠️ Bump network extension version on changes, https://github.com/mitmproxy/mitmproxy_rs/pull/227.
 message Packet {
   bytes data = 1;
 }
 // Intercept conf (macOS Control Stream)
+// ⚠️ Bump network extension version on changes, https://github.com/mitmproxy/mitmproxy_rs/pull/227.
 message InterceptConf {
   repeated string actions = 1;
 }
 // New flow (macOS TCP/UDP Stream)
+// ⚠️ Bump network extension version on changes, https://github.com/mitmproxy/mitmproxy_rs/pull/227.
 message NewFlow {
   oneof message {
     TcpFlow tcp = 1;
     UdpFlow udp = 2;
   }
 }
+// ⚠️ Bump network extension version on changes, https://github.com/mitmproxy/mitmproxy_rs/pull/227.
 message TcpFlow {
   Address remote_address = 1;
   TunnelInfo tunnel_info = 2;
 }
+// ⚠️ Bump network extension version on changes, https://github.com/mitmproxy/mitmproxy_rs/pull/227.
 message UdpFlow {
   optional Address local_address = 1;
   TunnelInfo tunnel_info = 3;

src/ipc/mitmproxy_ipc.rs

@@ -37,18 +37,21 @@ pub mod from_proxy {
     }
 }
 /// Packet (macOS UDP Stream)
+/// ⚠️ Bump network extension version on changes, <https://github.com/mitmproxy/mitmproxy_rs/pull/227.>
 #[derive(Clone, PartialEq, ::prost::Message)]
 pub struct Packet {
     #[prost(bytes = "bytes", tag = "1")]
     pub data: ::prost::bytes::Bytes,
 }
 /// Intercept conf (macOS Control Stream)
+/// ⚠️ Bump network extension version on changes, <https://github.com/mitmproxy/mitmproxy_rs/pull/227.>
 #[derive(Clone, PartialEq, ::prost::Message)]
 pub struct InterceptConf {
     #[prost(string, repeated, tag = "1")]
     pub actions: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
 }
 /// New flow (macOS TCP/UDP Stream)
+/// ⚠️ Bump network extension version on changes, <https://github.com/mitmproxy/mitmproxy_rs/pull/227.>
 #[derive(Clone, PartialEq, ::prost::Message)]
 pub struct NewFlow {
     #[prost(oneof = "new_flow::Message", tags = "1, 2")]
@@ -64,13 +67,15 @@ pub mod new_flow {
         Udp(super::UdpFlow),
     }
 }
+/// ⚠️ Bump network extension version on changes, <https://github.com/mitmproxy/mitmproxy_rs/pull/227.>
 #[derive(Clone, PartialEq, ::prost::Message)]
 pub struct TcpFlow {
     #[prost(message, optional, tag = "1")]
     pub remote_address: ::core::option::Option<Address>,
     #[prost(message, optional, tag = "2")]
     pub tunnel_info: ::core::option::Option<TunnelInfo>,
 }
+/// ⚠️ Bump network extension version on changes, <https://github.com/mitmproxy/mitmproxy_rs/pull/227.>
 #[derive(Clone, PartialEq, ::prost::Message)]
 pub struct UdpFlow {
     #[prost(message, optional, tag = "1")]