1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
// This file is @generated by prost-build.
/// A RateLimitDescriptor is a list of hierarchical entries that are used by the service to
/// determine the final rate limit key and overall allowed limit. Here are some examples of how
/// they might be used for the domain "envoy".
///
/// .. code-block:: cpp
///
/// \["authenticated": "false"\], \["remote_address": "10.0.0.1"\]
///
/// What it does: Limits all unauthenticated traffic for the IP address 10.0.0.1. The
/// configuration supplies a default limit for the *remote_address* key. If there is a desire to
/// raise the limit for 10.0.0.1 or block it entirely it can be specified directly in the
/// configuration.
///
/// .. code-block:: cpp
///
/// \["authenticated": "false"\], \["path": "/foo/bar"\]
///
/// What it does: Limits all unauthenticated traffic globally for a specific path (or prefix if
/// configured that way in the service).
///
/// .. code-block:: cpp
///
/// \["authenticated": "false"\], \["path": "/foo/bar"\], \["remote_address": "10.0.0.1"\]
///
/// What it does: Limits unauthenticated traffic to a specific path for a specific IP address.
/// Like (1) we can raise/block specific IP addresses if we want with an override configuration.
///
/// .. code-block:: cpp
///
/// \["authenticated": "true"\], \["client_id": "foo"\]
///
/// What it does: Limits all traffic for an authenticated client "foo"
///
/// .. code-block:: cpp
///
/// \["authenticated": "true"\], \["client_id": "foo"\], \["path": "/foo/bar"\]
///
/// What it does: Limits traffic to a specific path for an authenticated client "foo"
///
/// The idea behind the API is that (1)/(2)/(3) and (4)/(5) can be sent in 1 request if desired.
/// This enables building complex application scenarios with a generic backend.
///
/// Optionally the descriptor can contain a limit override under a "limit" key, that specifies
/// the number of requests per unit to use instead of the number configured in the
/// rate limiting service.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RateLimitDescriptor {
/// Descriptor entries.
#[prost(message, repeated, tag = "1")]
pub entries: ::prost::alloc::vec::Vec<rate_limit_descriptor::Entry>,
/// Optional rate limit override to supply to the ratelimit service.
#[prost(message, optional, tag = "2")]
pub limit: ::core::option::Option<rate_limit_descriptor::RateLimitOverride>,
/// Optional hits_addend for the rate limit descriptor. If set the value will override the
/// request level hits_addend.
#[prost(message, optional, tag = "3")]
pub hits_addend: ::core::option::Option<
super::super::super::super::super::google::protobuf::UInt64Value,
>,
}
/// Nested message and enum types in `RateLimitDescriptor`.
pub mod rate_limit_descriptor {
#[derive(Clone, PartialEq, Eq, Hash, ::prost::Message)]
pub struct Entry {
/// Descriptor key.
#[prost(string, tag = "1")]
pub key: ::prost::alloc::string::String,
/// Descriptor value. Blank value is treated as wildcard to create dynamic token buckets for each unique value.
/// Blank Values as wild card is currently supported only with envoy server instance level HTTP local rate limiting
/// and will not work if HTTP local rate limiting is enabled per connection level.
#[prost(string, tag = "2")]
pub value: ::prost::alloc::string::String,
}
impl ::prost::Name for Entry {
const NAME: &'static str = "Entry";
const PACKAGE: &'static str = "envoy.extensions.common.ratelimit.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.extensions.common.ratelimit.v3.RateLimitDescriptor.Entry".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.extensions.common.ratelimit.v3.RateLimitDescriptor.Entry"
.into()
}
}
/// Override rate limit to apply to this descriptor instead of the limit
/// configured in the rate limit service. See :ref:`rate limit override <config_http_filters_rate_limit_rate_limit_override>` for more information.
#[derive(Clone, Copy, PartialEq, Eq, Hash, ::prost::Message)]
pub struct RateLimitOverride {
/// The number of requests per unit of time.
#[prost(uint32, tag = "1")]
pub requests_per_unit: u32,
/// The unit of time.
#[prost(
enumeration = "super::super::super::super::super::r#type::v3::RateLimitUnit",
tag = "2"
)]
pub unit: i32,
}
impl ::prost::Name for RateLimitOverride {
const NAME: &'static str = "RateLimitOverride";
const PACKAGE: &'static str = "envoy.extensions.common.ratelimit.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.extensions.common.ratelimit.v3.RateLimitDescriptor.RateLimitOverride"
.into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.extensions.common.ratelimit.v3.RateLimitDescriptor.RateLimitOverride"
.into()
}
}
}
impl ::prost::Name for RateLimitDescriptor {
const NAME: &'static str = "RateLimitDescriptor";
const PACKAGE: &'static str = "envoy.extensions.common.ratelimit.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.extensions.common.ratelimit.v3.RateLimitDescriptor".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.extensions.common.ratelimit.v3.RateLimitDescriptor"
.into()
}
}
/// Configuration used to enable local rate limiting.
///
/// .. note::
/// The `LocalRateLimitDescriptor` is used to configure a local rate limit rule with a token
/// bucket algorithm. The `RateLimitDescriptor` is used to represent a list of symbols that
/// are used to match against the rate limit rule.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct LocalRateLimitDescriptor {
/// Descriptor entries.
#[prost(message, repeated, tag = "1")]
pub entries: ::prost::alloc::vec::Vec<rate_limit_descriptor::Entry>,
/// Token Bucket algorithm for local ratelimiting.
#[prost(message, optional, tag = "2")]
pub token_bucket: ::core::option::Option<
super::super::super::super::r#type::v3::TokenBucket,
>,
/// Mark the descriptor as shadow. When the values is true, envoy allow requests to the backend.
#[prost(bool, tag = "3")]
pub shadow_mode: bool,
}
impl ::prost::Name for LocalRateLimitDescriptor {
const NAME: &'static str = "LocalRateLimitDescriptor";
const PACKAGE: &'static str = "envoy.extensions.common.ratelimit.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.extensions.common.ratelimit.v3.LocalRateLimitDescriptor".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.extensions.common.ratelimit.v3.LocalRateLimitDescriptor"
.into()
}
}
/// Configuration used to enable local cluster level rate limiting where the token buckets
/// will be shared across all the Envoy instances in the local cluster.
/// A share will be calculated based on the membership of the local cluster dynamically
/// and the configuration. When the limiter refilling the token bucket, the share will be
/// applied. By default, the token bucket will be shared evenly.
///
/// See :ref:`local cluster name <envoy_v3_api_field_config.bootstrap.v3.ClusterManager.local_cluster_name>` for more context
/// about local cluster.
#[derive(Clone, Copy, PartialEq, Eq, Hash, ::prost::Message)]
pub struct LocalClusterRateLimit {}
impl ::prost::Name for LocalClusterRateLimit {
const NAME: &'static str = "LocalClusterRateLimit";
const PACKAGE: &'static str = "envoy.extensions.common.ratelimit.v3";
fn full_name() -> ::prost::alloc::string::String {
"envoy.extensions.common.ratelimit.v3.LocalClusterRateLimit".into()
}
fn type_url() -> ::prost::alloc::string::String {
"type.googleapis.com/envoy.extensions.common.ratelimit.v3.LocalClusterRateLimit"
.into()
}
}
/// Defines the version of the standard to use for X-RateLimit headers.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum XRateLimitHeadersRfcVersion {
/// X-RateLimit headers disabled.
Off = 0,
/// Use `draft RFC Version 03 <<https://tools.ietf.org/id/draft-polli-ratelimit-headers-03.html>`\_> where 3 headers will be added:
///
/// * `X-RateLimit-Limit` - indicates the request-quota associated to the
/// client in the current time-window followed by the description of the
/// quota policy. The value is returned by the maximum tokens of the token bucket.
/// * `X-RateLimit-Remaining` - indicates the remaining requests in the
/// current time-window. The value is returned by the remaining tokens in the token bucket.
/// * `X-RateLimit-Reset` - indicates the number of seconds until reset of
/// the current time-window. The value is returned by the remaining fill interval of the token bucket.
DraftVersion03 = 1,
}
impl XRateLimitHeadersRfcVersion {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
Self::Off => "OFF",
Self::DraftVersion03 => "DRAFT_VERSION_03",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"OFF" => Some(Self::Off),
"DRAFT_VERSION_03" => Some(Self::DraftVersion03),
_ => None,
}
}
}
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum VhRateLimitsOptions {
/// Use the virtual host rate limits unless the route has a rate limit policy.
Override = 0,
/// Use the virtual host rate limits even if the route has a rate limit policy.
Include = 1,
/// Ignore the virtual host rate limits even if the route does not have a rate limit policy.
Ignore = 2,
}
impl VhRateLimitsOptions {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
Self::Override => "OVERRIDE",
Self::Include => "INCLUDE",
Self::Ignore => "IGNORE",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"OVERRIDE" => Some(Self::Override),
"INCLUDE" => Some(Self::Include),
"IGNORE" => Some(Self::Ignore),
_ => None,
}
}
}