diff --git a/README.md b/README.md index c29dfa4..bde5150 100644 --- a/README.md +++ b/README.md @@ -817,7 +817,7 @@ Host: the IP or domain name of the proxy Port: the port of the proxy ### 2.7 Specify Outgoing IP -When the TCP proxy is a superior type (parameter: -T) is tcp, it supports the specified exit IP. Using the `--bind-listen` parameter, you can open the client to connect with the portal IP, and use the portal IP as the outgoing IP to access the target website. If an incorrect IP is bound, the proxy will not work, the proxy will try to bind the target without binding the IP, and the log will prompt. +When the TCP proxy is a superior type (parameter: -T) is tcp, it supports the specified outgoing IP. Using the `--bind-listen` parameter, you can open the client to connect with the portal IP, and use the portal IP as the outgoing IP to access the target website. If an incorrect IP is bound, the proxy will not work, the proxy will try to bind the target without binding the IP, and the log will prompt. `proxy tcp -p ":33080" -T tcp -P" 192.168.22.33:22" -B` @@ -836,7 +836,7 @@ In addition, the `IP` part of the `--bind-ip` parameter supports specifying the - Specify the network interface name, such as: `--bind-ip eth0:7777`, then the client accesses the `7777` port, and the egress IP is the IP of the eth0 network interface. - The network interface name supports wildcards, for example: `--bind-ip eth0.*:7777`, then the client accesses the `7777` port, and the egress IP is a randomly selected one of the network interface IPs starting with `eth0.`. -- IP supports wildcards, such as: `--bind-ip 192.168.?.*:7777`, then the client accesses the `7777` port, and the exit IP is all the IPs of the machine, matching the IP of `192.168.?.*` A randomly selected one. +- IP supports wildcards, such as: `--bind-ip 192.168.?.*:7777`, then the client accesses the `7777` port, and the outgoing IP is all the IPs of the machine, matching the IP of `192.168.?.*` A randomly selected one. - It can also be multiple combinations of network interface name and IP, separated by half-width commas, such as: `--bind-ip pppoe??,192.168.?.*:7777`, then the client accesses the port `7777`, The outgoing IP is the machine's network interface name matching `pppoe??` It is a randomly selected one among all IPs of the machine that matches `192.168.?.*`. - The wildcard character `*` represents 0 to any number of characters, and `?` represents 1 character. @@ -1365,7 +1365,7 @@ In addition, the `IP` part of the `--bind-ip` parameter supports specifying the - Specify the network interface name, such as: `--bind-ip eth0:7777`, then the client accesses the `7777` port, and the egress IP is the IP of the eth0 network interface. - The network interface name supports wildcards, for example: `--bind-ip eth0.*:7777`, then the client accesses the `7777` port, and the egress IP is a randomly selected one of the network interface IPs starting with `eth0.`. -- IP supports wildcards, such as: `--bind-ip 192.168.?.*:7777`, then the client accesses the `7777` port, and the exit IP is all the IPs of the machine, matching the IP of `192.168.?.*` A randomly selected one. +- IP supports wildcards, such as: `--bind-ip 192.168.?.*:7777`, then the client accesses the `7777` port, and the outgoing IP is all the IPs of the machine, matching the IP of `192.168.?.*` A randomly selected one. - It can also be multiple combinations of network interface name and IP, separated by half-width commas, such as: `--bind-ip pppoe??,192.168.?.*:7777`, then the client accesses the port `7777`, The outgoing IP is the machine's network interface name matching `pppoe??` It is a randomly selected one among all IPs of the machine that matches `192.168.?.*`. - The wildcard character `*` represents 0 to any number of characters, and `?` represents 1 character. @@ -1646,7 +1646,7 @@ In addition, the `IP` part of the `--bind-ip` parameter supports specifying the - Specify the network interface name, such as: `--bind-ip eth0:7777`, then the client accesses the `7777` port, and the egress IP is the IP of the eth0 network interface. - The network interface name supports wildcards, for example: `--bind-ip eth0.*:7777`, then the client accesses the `7777` port, and the egress IP is a randomly selected one of the network interface IPs starting with `eth0.`. -- IP supports wildcards, such as: `--bind-ip 192.168.?.*:7777`, then the client accesses the `7777` port, and the exit IP is all the IPs of the machine, matching the IP of `192.168.?.*` A randomly selected one. +- IP supports wildcards, such as: `--bind-ip 192.168.?.*:7777`, then the client accesses the `7777` port, and the outgoing IP is all the IPs of the machine, matching the IP of `192.168.?.*` A randomly selected one. - It can also be multiple combinations of network interface name and IP, separated by half-width commas, such as: `--bind-ip pppoe??,192.168.?.*:7777`, then the client accesses the port `7777`, The outgoing IP is the machine's network interface name matching `pppoe??` It is a randomly selected one among all IPs of the machine that matches `192.168.?.*`. - The wildcard character `*` represents 0 to any number of characters, and `?` represents 1 character. @@ -1949,6 +1949,7 @@ if($ok){ header("userTotalRate:1024000"); //header("ipTotalRate:10240"); //header("portTotalRate:10240"); + //header("RotationTime:60"); header("HTTP/1.1 204 No Content"); } ``` @@ -1961,10 +1962,28 @@ if($ok){ `userqps`: The maximum number of connections per second (QPS) for the user, not limited to 0 or not set this header. `ipqps`: The maximum number of connections per second (QPS) for the client IP, not limited to 0 or not set this header. `upstream`: The upstream used, not empty, or not set this header. -`outgoing`: The outgoing ip，this option only working which upstream is empty. And the IP must belong to the machine running proxy。 +`outgoing`: The outgoing IP used. This setting is only effective when the upstream is empty. + The IP set here must be owned by the machine where the proxy is located, otherwise, the proxy will not function properly. + Starting from version `v13.2`, `outgoing` supports multiple subnet formats separated by commas. The proxy will randomly + select an IP from the subnet as the outgoing IP. This randomness will also be maintained when authentication cache is enabled. + The following formats are supported for subnets: + 1. Format: `192.168.1.1`, Description: Single IP, IPv4 + 1. Format: `3001:cb2::`, Description: Single IP, IPv6 + 1. Format: `192.168.1.1/24`, Description: CIDR format subnet, IPv4 + 1. Format: `3001:cb2::/126`, Description: CIDR format subnet, IPv6 + 1. Format: `192.168.1.1-192.168.1.200`, Description: IP range, IPv4 + 1. Format: `3001:cb2::/126`, Description: IP range, IPv6 + + Example: `192.16.1.1,192.161.1.2,192.168.1.2-192.168.1.255` + `userTotalRate`： Limit the `user` total bandwidth speed (bytes per second), unit is byte, not limited to 0 or not set this header. `ipTotalRate`：Limit the `client ip` total bandwidth speed (bytes per second), unit is byte, not limited to 0 or not set this header. -`portTotalRate`：Limit the `server port` total bandwidth speed (bytes per second), unit is byte, not limited to 0 or not set this header. +`portTotalRate`：Limit the `server port` total bandwidth speed (bytes per second), unit is byte, not limited to 0 or not set this header. +`RotationTime`: `(requires version >= v13.2)` Controls the time interval, in seconds, for randomly selecting the outgoing IP. + Leave it blank or unset this header if not needed.When the outgoing returned by the API is a subnet, and if you don't want the proxy + to randomly select a new IP for each client connection, you can use this parameter to control the time interval for random IP selection. + If within the interval period, the previously selected IP will be used. If the API does not return the `RotationTime` header + or if `RotationTime` is set to 0, the proxy will randomly select an IP from the outgoing subnet as the outgoing IP for each client connection. #### Details of total bandwidth speed limitation 1. `userrate`、`iprate` and `userTotalRate`、`ipTotalRate`、`portTotalRate` can be set at same time, diff --git a/README_ZH.md b/README_ZH.md index 6e2cd1c..a25e0d1 100644 --- a/README_ZH.md +++ b/README_ZH.md @@ -2129,6 +2129,7 @@ if($ok){ header("userTotalRate:1024000"); //header("ipTotalRate:10240"); //header("portTotalRate:10240"); + //header("RotationTime:60"); header("HTTP/1.1 204 No Content"); } ``` @@ -2142,10 +2143,25 @@ if($ok){ - `userqps`：用户每秒可以建立的最大连接数，不限制为0或者不设置这个头部。 - `ipqps`：IP每秒可以建立的最大连接数，不限制为0或者不设置这个头部。 - `upstream`：使用的上级，没有为空，或者不设置这个头部。 -- `outgoing`: 使用的出口IP，这个设置，只有在upstream为空的的时候才有效，这里设置的IP必须是proxy所在机器具有的IP。 +- `outgoing`: 使用的出口IP，这个设置，只有在upstream为空的的时候才有效，这里设置的IP必须是proxy所在机器具拥有的IP，否则代理将不能正常工作。 + `v13.2`版本起，`outgoing` 支持多`网段`写法，逗号分割的多个`网段`，proxy会随机选择`网段`里面的一个IP作为出口。认证缓存开启后也会保持这个随机性。 + `网段`支持下面几种写法： + 1. 格式：`192.168.1.1`，说明：单个IP, IPv4 + 1. 格式：`3001:cb2::`，说明：单个IP, IPv6 + 1. 格式：`192.168.1.1/24`，说明：CIDR格式网段，IPv4 + 1. 格式：`3001:cb2::/126`，说明：CIDR格式网段，IPv6 + 1. 格式：`192.168.1.1-192.168.1.200`，说明：IP范围，IPv4 + 1. 格式：`3001:cb2::/126`，说明：IP范围，IPv6 + + 示例: `192.16.1.1,192.161.1.2,192.168.1.2-192.168.1.255` - `userTotalRate`：用户维度，限制用户的总带宽速度（byte/s），单位是字节byte，没有留空，或者不设置这个头部。 - `ipTotalRate`：客户端IP维度，限制客户端IP的总带宽速度（byte/s），单位是字节byte，没有留空，或者不设置这个头部。 - `portTotalRate`：带宽维度，限制一个带宽总带宽速度（byte/s），单位是字节byte，没有留空，或者不设置这个头部。 +- `RotationTime`：`（要求版本>=v13.2）`，控制随机选择outgoing出口IP的时间间隔，单位是秒，没有留空，或者不设置这个头部。 + 当API返回的outgoing是网段的时候，每次客户端连接，如果不想让proxy每次都随机选择一个IP，可以使用这个参数控制随机选择IP的时间间隔。 + 如果在间隔周期内，则使用上一次随机选择的IP。 如果API没有返回头部参数 RotationTime，或者RotationTime是0， + 那么每次客户端连接，proxy都随机选择一个outgoing网段里面的一个IP作为出口。 + #### 限速详细说明 1. 单个tcp限速（`userrate`、`iprate`）和总带宽速度（`userTotalRate`、`ipTotalRate`、`portTotalRate`）可以同时设置， diff --git a/docs/manual/manual.md b/docs/manual/manual.md index fe69b49..aa1e8aa 100644 --- a/docs/manual/manual.md +++ b/docs/manual/manual.md @@ -626,7 +626,7 @@ Host: the IP or domain name of the proxy Port: the port of the proxy ### 2.7 Specify Outgoing IP -When the TCP proxy is a superior type (parameter: -T) is tcp, it supports the specified exit IP. Using the `--bind-listen` parameter, you can open the client to connect with the portal IP, and use the portal IP as the outgoing IP to access the target website. If an incorrect IP is bound, the proxy will not work, the proxy will try to bind the target without binding the IP, and the log will prompt. +When the TCP proxy is a superior type (parameter: -T) is tcp, it supports the specified outgoing IP. Using the `--bind-listen` parameter, you can open the client to connect with the portal IP, and use the portal IP as the outgoing IP to access the target website. If an incorrect IP is bound, the proxy will not work, the proxy will try to bind the target without binding the IP, and the log will prompt. `proxy tcp -p ":33080" -T tcp -P" 192.168.22.33:22" -B` @@ -645,7 +645,7 @@ In addition, the `IP` part of the `--bind-ip` parameter supports specifying the - Specify the network interface name, such as: `--bind-ip eth0:7777`, then the client accesses the `7777` port, and the egress IP is the IP of the eth0 network interface. - The network interface name supports wildcards, for example: `--bind-ip eth0.*:7777`, then the client accesses the `7777` port, and the egress IP is a randomly selected one of the network interface IPs starting with `eth0.`. -- IP supports wildcards, such as: `--bind-ip 192.168.?.*:7777`, then the client accesses the `7777` port, and the exit IP is all the IPs of the machine, matching the IP of `192.168.?.*` A randomly selected one. +- IP supports wildcards, such as: `--bind-ip 192.168.?.*:7777`, then the client accesses the `7777` port, and the outgoing IP is all the IPs of the machine, matching the IP of `192.168.?.*` A randomly selected one. - It can also be multiple combinations of network interface name and IP, separated by half-width commas, such as: `--bind-ip pppoe??,192.168.?.*:7777`, then the client accesses the port `7777`, The outgoing IP is the machine's network interface name matching `pppoe??` It is a randomly selected one among all IPs of the machine that matches `192.168.?.*`. - The wildcard character `*` represents 0 to any number of characters, and `?` represents 1 character. @@ -1174,7 +1174,7 @@ In addition, the `IP` part of the `--bind-ip` parameter supports specifying the - Specify the network interface name, such as: `--bind-ip eth0:7777`, then the client accesses the `7777` port, and the egress IP is the IP of the eth0 network interface. - The network interface name supports wildcards, for example: `--bind-ip eth0.*:7777`, then the client accesses the `7777` port, and the egress IP is a randomly selected one of the network interface IPs starting with `eth0.`. -- IP supports wildcards, such as: `--bind-ip 192.168.?.*:7777`, then the client accesses the `7777` port, and the exit IP is all the IPs of the machine, matching the IP of `192.168.?.*` A randomly selected one. +- IP supports wildcards, such as: `--bind-ip 192.168.?.*:7777`, then the client accesses the `7777` port, and the outgoing IP is all the IPs of the machine, matching the IP of `192.168.?.*` A randomly selected one. - It can also be multiple combinations of network interface name and IP, separated by half-width commas, such as: `--bind-ip pppoe??,192.168.?.*:7777`, then the client accesses the port `7777`, The outgoing IP is the machine's network interface name matching `pppoe??` It is a randomly selected one among all IPs of the machine that matches `192.168.?.*`. - The wildcard character `*` represents 0 to any number of characters, and `?` represents 1 character. @@ -1455,7 +1455,7 @@ In addition, the `IP` part of the `--bind-ip` parameter supports specifying the - Specify the network interface name, such as: `--bind-ip eth0:7777`, then the client accesses the `7777` port, and the egress IP is the IP of the eth0 network interface. - The network interface name supports wildcards, for example: `--bind-ip eth0.*:7777`, then the client accesses the `7777` port, and the egress IP is a randomly selected one of the network interface IPs starting with `eth0.`. -- IP supports wildcards, such as: `--bind-ip 192.168.?.*:7777`, then the client accesses the `7777` port, and the exit IP is all the IPs of the machine, matching the IP of `192.168.?.*` A randomly selected one. +- IP supports wildcards, such as: `--bind-ip 192.168.?.*:7777`, then the client accesses the `7777` port, and the outgoing IP is all the IPs of the machine, matching the IP of `192.168.?.*` A randomly selected one. - It can also be multiple combinations of network interface name and IP, separated by half-width commas, such as: `--bind-ip pppoe??,192.168.?.*:7777`, then the client accesses the port `7777`, The outgoing IP is the machine's network interface name matching `pppoe??` It is a randomly selected one among all IPs of the machine that matches `192.168.?.*`. - The wildcard character `*` represents 0 to any number of characters, and `?` represents 1 character. @@ -1758,6 +1758,7 @@ if($ok){ header("userTotalRate:1024000"); //header("ipTotalRate:10240"); //header("portTotalRate:10240"); + //header("RotationTime:60"); header("HTTP/1.1 204 No Content"); } ``` @@ -1770,10 +1771,28 @@ if($ok){ `userqps`: The maximum number of connections per second (QPS) for the user, not limited to 0 or not set this header. `ipqps`: The maximum number of connections per second (QPS) for the client IP, not limited to 0 or not set this header. `upstream`: The upstream used, not empty, or not set this header. -`outgoing`: The outgoing ip，this option only working which upstream is empty. And the IP must belong to the machine running proxy。 +`outgoing`: The outgoing IP used. This setting is only effective when the upstream is empty. + The IP set here must be owned by the machine where the proxy is located, otherwise, the proxy will not function properly. + Starting from version `v13.2`, `outgoing` supports multiple subnet formats separated by commas. The proxy will randomly + select an IP from the subnet as the outgoing IP. This randomness will also be maintained when authentication cache is enabled. + The following formats are supported for subnets: + 1. Format: `192.168.1.1`, Description: Single IP, IPv4 + 1. Format: `3001:cb2::`, Description: Single IP, IPv6 + 1. Format: `192.168.1.1/24`, Description: CIDR format subnet, IPv4 + 1. Format: `3001:cb2::/126`, Description: CIDR format subnet, IPv6 + 1. Format: `192.168.1.1-192.168.1.200`, Description: IP range, IPv4 + 1. Format: `3001:cb2::/126`, Description: IP range, IPv6 + + Example: `192.16.1.1,192.161.1.2,192.168.1.2-192.168.1.255` + `userTotalRate`： Limit the `user` total bandwidth speed (bytes per second), unit is byte, not limited to 0 or not set this header. `ipTotalRate`：Limit the `client ip` total bandwidth speed (bytes per second), unit is byte, not limited to 0 or not set this header. -`portTotalRate`：Limit the `server port` total bandwidth speed (bytes per second), unit is byte, not limited to 0 or not set this header. +`portTotalRate`：Limit the `server port` total bandwidth speed (bytes per second), unit is byte, not limited to 0 or not set this header. +`RotationTime`: `(requires version >= v13.2)` Controls the time interval, in seconds, for randomly selecting the outgoing IP. + Leave it blank or unset this header if not needed.When the outgoing returned by the API is a subnet, and if you don't want the proxy + to randomly select a new IP for each client connection, you can use this parameter to control the time interval for random IP selection. + If within the interval period, the previously selected IP will be used. If the API does not return the `RotationTime` header + or if `RotationTime` is set to 0, the proxy will randomly select an IP from the outgoing subnet as the outgoing IP for each client connection. #### Details of total bandwidth speed limitation 1. `userrate`、`iprate` and `userTotalRate`、`ipTotalRate`、`portTotalRate` can be set at same time, diff --git a/docs/manual/zh/manual.md b/docs/manual/zh/manual.md index 20dc037..68c6874 100644 --- a/docs/manual/zh/manual.md +++ b/docs/manual/zh/manual.md @@ -1908,6 +1908,7 @@ if($ok){ header("userTotalRate:1024000"); //header("ipTotalRate:10240"); //header("portTotalRate:10240"); + //header("RotationTime:60"); header("HTTP/1.1 204 No Content"); } ``` @@ -1921,10 +1922,25 @@ if($ok){ - `userqps`：用户每秒可以建立的最大连接数，不限制为0或者不设置这个头部。 - `ipqps`：IP每秒可以建立的最大连接数，不限制为0或者不设置这个头部。 - `upstream`：使用的上级，没有为空，或者不设置这个头部。 -- `outgoing`: 使用的出口IP，这个设置，只有在upstream为空的的时候才有效，这里设置的IP必须是proxy所在机器具有的IP。 +- `outgoing`: 使用的出口IP，这个设置，只有在upstream为空的的时候才有效，这里设置的IP必须是proxy所在机器具拥有的IP，否则代理将不能正常工作。 + `v13.2`版本起，`outgoing` 支持多`网段`写法，逗号分割的多个`网段`，proxy会随机选择`网段`里面的一个IP作为出口。认证缓存开启后也会保持这个随机性。 + `网段`支持下面几种写法： + 1. 格式：`192.168.1.1`，说明：单个IP, IPv4 + 1. 格式：`3001:cb2::`，说明：单个IP, IPv6 + 1. 格式：`192.168.1.1/24`，说明：CIDR格式网段，IPv4 + 1. 格式：`3001:cb2::/126`，说明：CIDR格式网段，IPv6 + 1. 格式：`192.168.1.1-192.168.1.200`，说明：IP范围，IPv4 + 1. 格式：`3001:cb2::/126`，说明：IP范围，IPv6 + + 示例: `192.16.1.1,192.161.1.2,192.168.1.2-192.168.1.255` - `userTotalRate`：用户维度，限制用户的总带宽速度（byte/s），单位是字节byte，没有留空，或者不设置这个头部。 - `ipTotalRate`：客户端IP维度，限制客户端IP的总带宽速度（byte/s），单位是字节byte，没有留空，或者不设置这个头部。 - `portTotalRate`：带宽维度，限制一个带宽总带宽速度（byte/s），单位是字节byte，没有留空，或者不设置这个头部。 +- `RotationTime`：`（要求版本>=v13.2）`，控制随机选择outgoing出口IP的时间间隔，单位是秒，没有留空，或者不设置这个头部。 + 当API返回的outgoing是网段的时候，每次客户端连接，如果不想让proxy每次都随机选择一个IP，可以使用这个参数控制随机选择IP的时间间隔。 + 如果在间隔周期内，则使用上一次随机选择的IP。 如果API没有返回头部参数 RotationTime，或者RotationTime是0， + 那么每次客户端连接，proxy都随机选择一个outgoing网段里面的一个IP作为出口。 + #### 限速详细说明 1. 单个tcp限速（`userrate`、`iprate`）和总带宽速度（`userTotalRate`、`ipTotalRate`、`portTotalRate`）可以同时设置，