Limiting¶
Dynamic configuration
Limiter supports dynamic configuration via Web API.
Limiter¶
Requests can be limited by setting Limiters on each service. The current Limiter supports the limit on the bandwidth, request rate and max connections.
Bandwidth Limiter¶
This type of limiter includes three levels: service, connection and IP, the three levels can be used in combination.
The service-level rate limit is set through limiter.in
and limiter.out
on the command line, and the connection-level is set through limiter.conn.in
and limiter.conn.out
level speed limit.
Use the limiter
parameter in the configuration file to use the specified limiter by referencing the limiter name (limiters.name
).
A list of configurations is specified via the limits
option, each configuration item consists of three parts separated by spaces:
-
Scope: Limit scope, IP address or CIDR, such as 192.168.1.1, 192.168.0.0/16. There are two special values:
$
for service level and$$
for connection level. -
Input: The rate at which the service receives data (per second). The supported units are: B, KB, MB, GB, TB, such as 128KB, 1MB, 10GB. Zero or negative value means unlimited.
-
Output: The rate at which the service sends data (per second), in the same unit as the input rate. The output rate is optional, zero, negative value or not set means unlimited.
limiter.refreshInterval
(duration, default=30s)- Limiter plugin synchronization configuration interval.
Request Rate Limiter¶
This type of limiter includes two levels: service and IP, the two levels can be used in combination.
The service-level request rate limit (requests per second) is set by rlimiter
on the command line.
Use the rlimiter
parameter in the configuration file to use the specified limiter by referencing the limiter name (rlimiters.name
).
A list of configurations is specified via the limits
option, each configuration item consists of three parts separated by spaces:
-
Scope: Limit scope, IP address or CIDR, such as 192.168.1.1, 192.168.0.0/16. There are two special values:
$
for service level and$$
for IP level. When a limit is set for a specific IP or CIDR,$$
is ignored. -
Limit: Request rate limit value (request per second).
Max Connections Limiter¶
This type of limiter includes two levels: service and IP, the two levels can be used in combination.
The service-level limit is set by climiter
on the command line.
Use the climiter
parameter in the configuration file to use the specified limiter by referencing the limiter name (climiters.name
).
A list of configurations is specified via the limits
option, each configuration item consists of three parts separated by spaces:
-
Scope: Limit scope, IP address or CIDR, such as 192.168.1.1, 192.168.0.0/16. There are two special values:
$
for service level and$$
for IP level. When a limit is set for a specific IP or CIDR,$$
is ignored. -
Limit: Max connections limit value.
Data Source¶
The limiter can configure multiple data sources, currently supported data sources are: inline, file, redis.
Inline¶
An inline data source means setting the data directly in the configuration file via the limits
option.
File¶
Specify an external file as the data source. Specify the file path via the file.path
option.
The file format is a list of speed limit configurations separated by lines. The part starting with #
is the comment information. The format of each line is the same as the inline configuration.
Redis¶
Specify the redis service as the data source, and the redis data type must be Set or List. The format of each item is the same as the inline configuration.
addr
(string, required)- redis server address.
db
(int, default=0)- database name.
username
(string)- username
password
(string)- password
key
(string, default=gost)- redis key
type
(string, default=set)- redis data type:
set
,list
Each item of data is in a similar format to the file data source:
Priority¶
When configuring multiple data sources at the same time, the priority from high to low is: redis, file, inline. If the same scop exists in different data sources, the data with higher priority will overwrite the data with lower priority.
Hot Reload¶
File and redis data sources support hot reloading. Enable hot loading by setting the reload
property, which specifies the period for synchronizing the data source data.
limiters:
- name: limiter-0
reload: 60s
file:
path: /path/to/file
redis:
addr: 127.0.0.1:6379
db: 1
password: 123456
key: gost:limiters:limiter-0
Plugin¶
Traffic limiter can be configured to use an external plugin service, and it will forward the request to the plugin server for processing. Other parameters are ignored when using plugin.
limiters:
- name: limiter-0
plugin:
type: grpc
addr: 127.0.0.1:8000
tls:
secure: false
serverName: example.com
type
(string, default=grpc)- plugin type:
grpc
,http
. addr
(string, required)- plugin server address.
tls
(object, default=null)- TLS encryption will be used for transmission, TLS encryption is not used by default.
HTTP Plugin¶
Example¶
curl -XPOST http://127.0.0.1:8000/limiter \
-d'{"scope":"client","service":"service-0","network":"tcp","addr":"example.com:443","client":"gost","src":"192.168.1.1:12345"}'
scope
(string)- limiter scope,
service
- service level,conn
- connection level,client
- user level. service
(string)- service name.
network
(string, default=ip4)- network types:
tcp
,udp
. addr
(string)- target request address.
client
(string)- client ID, generated by Authenticator.
src
(string)- client source address.
in
(int64)- input rate(bytes/s), zero or a negative value means unlimited.
out
(int64)- output rate(bytes/s), zero or a negative value means unlimited.
Limiter In Service Handler¶
For handlers that support authentication (HTTP, HTTP2, SOCKS4, SOCKS5, Relay, Tunnel), traffic limiter is also available to the Handler.
services:
- name: service-0
addr: ":8080"
handler:
type: http
limiter: limiter-0
listener:
type: tcp
limiters:
- name: limiter-0
plugin:
addr: 127.0.0.1:8000
Limiter Based On Client ID¶
The GOST internal Limiter does not handle the logic for specific clients. If you need to implement this function, you can use an Authenticator and a handler limiter plugin in combination.
The Authenticator returns the client ID after successful authentication. GOST will pass this client ID to the limiter plugin server again, and set the scope value to client
, the limiter plugin server can implement different strategies based on the client ID.
Tunnel Handler
For Tunnel handler, the limiter acts on a single Tunnel, the client value is the Tunnel ID.