From 16478d0c3282e44b954ef7b0da97bb4c7337a67b Mon Sep 17 00:00:00 2001
From: Zhang Jingqiang <zhangjingqiang@bytedance.com>
Date: Fri, 20 Jun 2025 10:37:23 +0800
Subject: [PATCH] g3proxy: deprecate transmute_udp_echo_ip in socks proxy
 server config

---
 g3proxy/CHANGELOG                                    |  1 +
 g3proxy/src/config/server/socks_proxy.rs             |  7 ++++++-
 sphinx/g3proxy/configuration/servers/socks_proxy.rst | 10 ++++++++--
 3 files changed, 15 insertions(+), 3 deletions(-)

diff --git a/g3proxy/CHANGELOG b/g3proxy/CHANGELOG
index c14ba36e..a8ea64d0 100644
--- a/g3proxy/CHANGELOG
+++ b/g3proxy/CHANGELOG
@@ -3,6 +3,7 @@ v1.11.8:
  - BUG FIX: fix panic when detect DNS over TLS traffic
  - Deprecated: the following config options are deprecated:
      - emit_duration in statsd config, use emit_interval instead
+     - auto_reply_local_ip_map in socks server config, use transmute_udp_echo_ip instead
      - untrusted_read_limit in server config, use untrusted_read_speed_limit instead
      - tcp_conn_speed_limit/tcp_conn_limit in user config, use tcp_sock_speed_limit instead
      - udp_relay_speed_limit/udp_relay_limit in user config, use udp_sock_speed_limit instead
diff --git a/g3proxy/src/config/server/socks_proxy.rs b/g3proxy/src/config/server/socks_proxy.rs
index 91a57985..de68b0a5 100644
--- a/g3proxy/src/config/server/socks_proxy.rs
+++ b/g3proxy/src/config/server/socks_proxy.rs
@@ -9,6 +9,7 @@ use std::time::Duration;
 
 use anyhow::{Context, anyhow};
 use ascii::AsciiString;
+use log::warn;
 use rustc_hash::FxHashMap;
 use yaml_rust::{Yaml, yaml};
 
@@ -304,7 +305,7 @@ impl SocksProxyServerConfig {
                 self.task_log_flush_interval = Some(interval);
                 Ok(())
             }
-            "transmute_udp_echo_ip" | "auto_reply_local_ip_map" => {
+            "transmute_udp_echo_ip" => {
                 if let Yaml::Hash(_) = v {
                     let map = g3_yaml::value::as_hashmap(
                         v,
@@ -320,6 +321,10 @@ impl SocksProxyServerConfig {
                 }
                 Ok(())
             }
+            "auto_reply_local_ip_map" => {
+                warn!("deprecated config key '{k}', please use 'transmute_udp_echo_ip' instead");
+                self.set("transmute_udp_echo_ip", v)
+            }
             _ => Err(anyhow!("invalid key {k}")),
         }
     }
diff --git a/sphinx/g3proxy/configuration/servers/socks_proxy.rst b/sphinx/g3proxy/configuration/servers/socks_proxy.rst
index fdf33d18..2b031579 100644
--- a/sphinx/g3proxy/configuration/servers/socks_proxy.rst
+++ b/sphinx/g3proxy/configuration/servers/socks_proxy.rst
@@ -136,7 +136,13 @@ If no matched key found in the map, the unspecified ip address of the same famil
 
 For bool value, an empty map will be used if set to true, or disabled if set to false.
 
-**default**: not set, **alias**: auto_reply_local_ip_map
+**default**: not set
 
-.. versionchanged:: 1.7.19 change option name to transmute_udp_echo_ip
 .. versionchanged:: 1.9.9 allow bool value and change to use unspecified ip if no match records
+
+auto_reply_local_ip_map
+-----------------------
+
+**deprecated**
+
+.. versionchanged:: 1.11.8 deprecated, use transmute_udp_echo_ip instead