-
Notifications
You must be signed in to change notification settings - Fork 4.8k
/
config.proto
586 lines (532 loc) · 19.7 KB
/
config.proto
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
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
syntax = "proto3";
package envoy.extensions.filters.http.jwt_authn.v3;
import "envoy/config/core/v3/base.proto";
import "envoy/config/core/v3/http_uri.proto";
import "envoy/config/route/v3/route_components.proto";
import "google/protobuf/duration.proto";
import "google/protobuf/empty.proto";
import "udpa/annotations/status.proto";
import "udpa/annotations/versioning.proto";
import "validate/validate.proto";
option java_package = "io.envoyproxy.envoy.extensions.filters.http.jwt_authn.v3";
option java_outer_classname = "ConfigProto";
option java_multiple_files = true;
option (udpa.annotations.file_status).package_version_status = ACTIVE;
// [#protodoc-title: JWT Authentication]
// JWT Authentication :ref:`configuration overview <config_http_filters_jwt_authn>`.
// [#extension: envoy.filters.http.jwt_authn]
// Please see following for JWT authentication flow:
//
// * `JSON Web Token (JWT) <https://tools.ietf.org/html/rfc7519>`_
// * `The OAuth 2.0 Authorization Framework <https://tools.ietf.org/html/rfc6749>`_
// * `OpenID Connect <http://openid.net/connect>`_
//
// A JwtProvider message specifies how a JSON Web Token (JWT) can be verified. It specifies:
//
// * issuer: the principal that issues the JWT. If specified, it has to match the *iss* field in JWT.
// * allowed audiences: the ones in the token have to be listed here.
// * how to fetch public key JWKS to verify the token signature.
// * how to extract JWT token in the request.
// * how to pass successfully verified token payload.
//
// Example:
//
// .. code-block:: yaml
//
// issuer: https://example.com
// audiences:
// - bookstore_android.apps.googleusercontent.com
// - bookstore_web.apps.googleusercontent.com
// remote_jwks:
// http_uri:
// uri: https://example.com/.well-known/jwks.json
// cluster: example_jwks_cluster
// timeout: 1s
// cache_duration:
// seconds: 300
//
// [#next-free-field: 11]
message JwtProvider {
option (udpa.annotations.versioning).previous_message_type =
"envoy.config.filter.http.jwt_authn.v2alpha.JwtProvider";
// Specify the `principal <https://tools.ietf.org/html/rfc7519#section-4.1.1>`_ that issued
// the JWT, usually a URL or an email address.
//
// It is optional. If specified, it has to match the *iss* field in JWT.
//
// If a JWT has *iss* field and this field is specified, they have to match, otherwise the
// JWT *iss* field is not checked.
//
// Note: *JwtRequirement* :ref:`allow_missing <envoy_v3_api_field_extensions.filters.http.jwt_authn.v3.JwtRequirement.allow_missing>`
// and :ref:`allow_missing_or_failed <envoy_v3_api_field_extensions.filters.http.jwt_authn.v3.JwtRequirement.allow_missing_or_failed>`
// are implemented differently than other *JwtRequirements*. Hence the usage of this field
// is different as follows if *allow_missing* or *allow_missing_or_failed* is used:
//
// * If a JWT has *iss* field, it needs to be specified by this field in one of *JwtProviders*.
// * If a JWT doesn't have *iss* field, one of *JwtProviders* should fill this field empty.
// * Multiple *JwtProviders* should not have same value in this field.
//
// Example: https://securetoken.google.com
// Example: 1234567-compute@developer.gserviceaccount.com
//
string issuer = 1;
// The list of JWT `audiences <https://tools.ietf.org/html/rfc7519#section-4.1.3>`_ are
// allowed to access. A JWT containing any of these audiences will be accepted. If not specified,
// will not check audiences in the token.
//
// Example:
//
// .. code-block:: yaml
//
// audiences:
// - bookstore_android.apps.googleusercontent.com
// - bookstore_web.apps.googleusercontent.com
//
repeated string audiences = 2;
// `JSON Web Key Set (JWKS) <https://tools.ietf.org/html/rfc7517#appendix-A>`_ is needed to
// validate signature of a JWT. This field specifies where to fetch JWKS.
oneof jwks_source_specifier {
option (validate.required) = true;
// JWKS can be fetched from remote server via HTTP/HTTPS. This field specifies the remote HTTP
// URI and how the fetched JWKS should be cached.
//
// Example:
//
// .. code-block:: yaml
//
// remote_jwks:
// http_uri:
// uri: https://www.googleapis.com/oauth2/v1/certs
// cluster: jwt.www.googleapis.com|443
// timeout: 1s
// cache_duration:
// seconds: 300
//
RemoteJwks remote_jwks = 3;
// JWKS is in local data source. It could be either in a local file or embedded in the
// inline_string.
//
// Example: local file
//
// .. code-block:: yaml
//
// local_jwks:
// filename: /etc/envoy/jwks/jwks1.txt
//
// Example: inline_string
//
// .. code-block:: yaml
//
// local_jwks:
// inline_string: ACADADADADA
//
config.core.v3.DataSource local_jwks = 4;
}
// If false, the JWT is removed in the request after a success verification. If true, the JWT is
// not removed in the request. Default value is false.
bool forward = 5;
// Two fields below define where to extract the JWT from an HTTP request.
//
// If no explicit location is specified, the following default locations are tried in order:
//
// 1. The Authorization header using the `Bearer schema
// <https://tools.ietf.org/html/rfc6750#section-2.1>`_. Example::
//
// Authorization: Bearer <token>.
//
// 2. `access_token <https://tools.ietf.org/html/rfc6750#section-2.3>`_ query parameter.
//
// Multiple JWTs can be verified for a request. Each JWT has to be extracted from the locations
// its provider specified or from the default locations.
//
// Specify the HTTP headers to extract JWT token. For examples, following config:
//
// .. code-block:: yaml
//
// from_headers:
// - name: x-goog-iap-jwt-assertion
//
// can be used to extract token from header::
//
// ``x-goog-iap-jwt-assertion: <JWT>``.
//
repeated JwtHeader from_headers = 6;
// JWT is sent in a query parameter. `jwt_params` represents the query parameter names.
//
// For example, if config is:
//
// .. code-block:: yaml
//
// from_params:
// - jwt_token
//
// The JWT format in query parameter is::
//
// /path?jwt_token=<JWT>
//
repeated string from_params = 7;
// This field specifies the header name to forward a successfully verified JWT payload to the
// backend. The forwarded data is::
//
// base64url_encoded(jwt_payload_in_JSON)
//
// If it is not specified, the payload will not be forwarded.
string forward_payload_header = 8
[(validate.rules).string = {well_known_regex: HTTP_HEADER_NAME strict: false}];
// If non empty, successfully verified JWT payloads will be written to StreamInfo DynamicMetadata
// in the format as: *namespace* is the jwt_authn filter name as **envoy.filters.http.jwt_authn**
// The value is the *protobuf::Struct*. The value of this field will be the key for its *fields*
// and the value is the *protobuf::Struct* converted from JWT JSON payload.
//
// For example, if payload_in_metadata is *my_payload*:
//
// .. code-block:: yaml
//
// envoy.filters.http.jwt_authn:
// my_payload:
// iss: https://example.com
// sub: test@example.com
// aud: https://example.com
// exp: 1501281058
//
string payload_in_metadata = 9;
// Specify the clock skew in seconds when verifying JWT time constraint,
// such as `exp`, and `nbf`. If not specified, default is 60 seconds.
uint32 clock_skew_seconds = 10;
}
// This message specifies how to fetch JWKS from remote and how to cache it.
message RemoteJwks {
option (udpa.annotations.versioning).previous_message_type =
"envoy.config.filter.http.jwt_authn.v2alpha.RemoteJwks";
// The HTTP URI to fetch the JWKS. For example:
//
// .. code-block:: yaml
//
// http_uri:
// uri: https://www.googleapis.com/oauth2/v1/certs
// cluster: jwt.www.googleapis.com|443
// timeout: 1s
//
config.core.v3.HttpUri http_uri = 1;
// Duration after which the cached JWKS should be expired. If not specified, default cache
// duration is 5 minutes.
google.protobuf.Duration cache_duration = 2;
}
// This message specifies a header location to extract JWT token.
message JwtHeader {
option (udpa.annotations.versioning).previous_message_type =
"envoy.config.filter.http.jwt_authn.v2alpha.JwtHeader";
// The HTTP header name.
string name = 1
[(validate.rules).string = {min_len: 1 well_known_regex: HTTP_HEADER_NAME strict: false}];
// The value prefix. The value format is "value_prefix<token>"
// For example, for "Authorization: Bearer <token>", value_prefix="Bearer " with a space at the
// end.
string value_prefix = 2
[(validate.rules).string = {well_known_regex: HTTP_HEADER_VALUE strict: false}];
}
// Specify a required provider with audiences.
message ProviderWithAudiences {
option (udpa.annotations.versioning).previous_message_type =
"envoy.config.filter.http.jwt_authn.v2alpha.ProviderWithAudiences";
// Specify a required provider name.
string provider_name = 1;
// This field overrides the one specified in the JwtProvider.
repeated string audiences = 2;
}
// This message specifies a Jwt requirement. An empty message means JWT verification is not
// required. Here are some config examples:
//
// .. code-block:: yaml
//
// # Example 1: not required with an empty message
//
// # Example 2: require A
// provider_name: provider-A
//
// # Example 3: require A or B
// requires_any:
// requirements:
// - provider_name: provider-A
// - provider_name: provider-B
//
// # Example 4: require A and B
// requires_all:
// requirements:
// - provider_name: provider-A
// - provider_name: provider-B
//
// # Example 5: require A and (B or C)
// requires_all:
// requirements:
// - provider_name: provider-A
// - requires_any:
// requirements:
// - provider_name: provider-B
// - provider_name: provider-C
//
// # Example 6: require A or (B and C)
// requires_any:
// requirements:
// - provider_name: provider-A
// - requires_all:
// requirements:
// - provider_name: provider-B
// - provider_name: provider-C
//
// # Example 7: A is optional (if token from A is provided, it must be valid, but also allows
// missing token.)
// requires_any:
// requirements:
// - provider_name: provider-A
// - allow_missing: {}
//
// # Example 8: A is optional and B is required.
// requires_all:
// requirements:
// - requires_any:
// requirements:
// - provider_name: provider-A
// - allow_missing: {}
// - provider_name: provider-B
//
// [#next-free-field: 7]
message JwtRequirement {
option (udpa.annotations.versioning).previous_message_type =
"envoy.config.filter.http.jwt_authn.v2alpha.JwtRequirement";
oneof requires_type {
// Specify a required provider name.
string provider_name = 1;
// Specify a required provider with audiences.
ProviderWithAudiences provider_and_audiences = 2;
// Specify list of JwtRequirement. Their results are OR-ed.
// If any one of them passes, the result is passed.
JwtRequirementOrList requires_any = 3;
// Specify list of JwtRequirement. Their results are AND-ed.
// All of them must pass, if one of them fails or missing, it fails.
JwtRequirementAndList requires_all = 4;
// The requirement is always satisfied even if JWT is missing or the JWT
// verification fails. A typical usage is: this filter is used to only verify
// JWTs and pass the verified JWT payloads to another filter, the other filter
// will make decision. In this mode, all JWT tokens will be verified.
google.protobuf.Empty allow_missing_or_failed = 5;
// The requirement is satisfied if JWT is missing, but failed if JWT is
// presented but invalid. Similar to allow_missing_or_failed, this is used
// to only verify JWTs and pass the verified payload to another filter. The
// different is this mode will reject requests with invalid tokens.
google.protobuf.Empty allow_missing = 6;
}
}
// This message specifies a list of RequiredProvider.
// Their results are OR-ed; if any one of them passes, the result is passed
message JwtRequirementOrList {
option (udpa.annotations.versioning).previous_message_type =
"envoy.config.filter.http.jwt_authn.v2alpha.JwtRequirementOrList";
// Specify a list of JwtRequirement.
repeated JwtRequirement requirements = 1 [(validate.rules).repeated = {min_items: 2}];
}
// This message specifies a list of RequiredProvider.
// Their results are AND-ed; all of them must pass, if one of them fails or missing, it fails.
message JwtRequirementAndList {
option (udpa.annotations.versioning).previous_message_type =
"envoy.config.filter.http.jwt_authn.v2alpha.JwtRequirementAndList";
// Specify a list of JwtRequirement.
repeated JwtRequirement requirements = 1 [(validate.rules).repeated = {min_items: 2}];
}
// This message specifies a Jwt requirement for a specific Route condition.
// Example 1:
//
// .. code-block:: yaml
//
// - match:
// prefix: /healthz
//
// In above example, "requires" field is empty for /healthz prefix match,
// it means that requests matching the path prefix don't require JWT authentication.
//
// Example 2:
//
// .. code-block:: yaml
//
// - match:
// prefix: /
// requires: { provider_name: provider-A }
//
// In above example, all requests matched the path prefix require jwt authentication
// from "provider-A".
message RequirementRule {
option (udpa.annotations.versioning).previous_message_type =
"envoy.config.filter.http.jwt_authn.v2alpha.RequirementRule";
// The route matching parameter. Only when the match is satisfied, the "requires" field will
// apply.
//
// For example: following match will match all requests.
//
// .. code-block:: yaml
//
// match:
// prefix: /
//
config.route.v3.RouteMatch match = 1 [(validate.rules).message = {required: true}];
// Specify a Jwt requirement.
// If not specified, Jwt verification is disabled.
oneof requirement_type {
// Specify a Jwt requirement. Please see detail comment in message JwtRequirement.
JwtRequirement requires = 2;
// Use requirement_name to specify a Jwt requirement.
// This requirement_name MUST be specified at the
// :ref:`requirement_map <envoy_v3_api_field_extensions.filters.http.jwt_authn.v3.JwtAuthentication.requirement_map>`
// in `JwtAuthentication`.
string requirement_name = 3 [(validate.rules).string = {min_len: 1}];
}
}
// This message specifies Jwt requirements based on stream_info.filterState.
// This FilterState should use `Router::StringAccessor` object to set a string value.
// Other HTTP filters can use it to specify Jwt requirements dynamically.
//
// Example:
//
// .. code-block:: yaml
//
// name: jwt_selector
// requires:
// issuer_1:
// provider_name: issuer1
// issuer_2:
// provider_name: issuer2
//
// If a filter set "jwt_selector" with "issuer_1" to FilterState for a request,
// jwt_authn filter will use JwtRequirement{"provider_name": "issuer1"} to verify.
message FilterStateRule {
option (udpa.annotations.versioning).previous_message_type =
"envoy.config.filter.http.jwt_authn.v2alpha.FilterStateRule";
// The filter state name to retrieve the `Router::StringAccessor` object.
string name = 1 [(validate.rules).string = {min_len: 1}];
// A map of string keys to requirements. The string key is the string value
// in the FilterState with the name specified in the *name* field above.
map<string, JwtRequirement> requires = 3;
}
// This is the Envoy HTTP filter config for JWT authentication.
//
// For example:
//
// .. code-block:: yaml
//
// providers:
// provider1:
// issuer: issuer1
// audiences:
// - audience1
// - audience2
// remote_jwks:
// http_uri:
// uri: https://example.com/.well-known/jwks.json
// cluster: example_jwks_cluster
// timeout: 1s
// provider2:
// issuer: issuer2
// local_jwks:
// inline_string: jwks_string
//
// rules:
// # Not jwt verification is required for /health path
// - match:
// prefix: /health
//
// # Jwt verification for provider1 is required for path prefixed with "prefix"
// - match:
// prefix: /prefix
// requires:
// provider_name: provider1
//
// # Jwt verification for either provider1 or provider2 is required for all other requests.
// - match:
// prefix: /
// requires:
// requires_any:
// requirements:
// - provider_name: provider1
// - provider_name: provider2
//
// [#next-free-field: 6]
message JwtAuthentication {
option (udpa.annotations.versioning).previous_message_type =
"envoy.config.filter.http.jwt_authn.v2alpha.JwtAuthentication";
// Map of provider names to JwtProviders.
//
// .. code-block:: yaml
//
// providers:
// provider1:
// issuer: issuer1
// audiences:
// - audience1
// - audience2
// remote_jwks:
// http_uri:
// uri: https://example.com/.well-known/jwks.json
// cluster: example_jwks_cluster
// timeout: 1s
// provider2:
// issuer: provider2
// local_jwks:
// inline_string: jwks_string
//
map<string, JwtProvider> providers = 1;
// Specifies requirements based on the route matches. The first matched requirement will be
// applied. If there are overlapped match conditions, please put the most specific match first.
//
// Examples
//
// .. code-block:: yaml
//
// rules:
// - match:
// prefix: /healthz
// - match:
// prefix: /baz
// requires:
// provider_name: provider1
// - match:
// prefix: /foo
// requires:
// requires_any:
// requirements:
// - provider_name: provider1
// - provider_name: provider2
// - match:
// prefix: /bar
// requires:
// requires_all:
// requirements:
// - provider_name: provider1
// - provider_name: provider2
//
repeated RequirementRule rules = 2;
// This message specifies Jwt requirements based on stream_info.filterState.
// Other HTTP filters can use it to specify Jwt requirements dynamically.
// The *rules* field above is checked first, if it could not find any matches,
// check this one.
FilterStateRule filter_state_rules = 3;
// When set to true, bypass the `CORS preflight request
// <http://www.w3.org/TR/cors/#cross-origin-request-with-preflight>`_ regardless of JWT
// requirements specified in the rules.
bool bypass_cors_preflight = 4;
// A map of unique requirement_names to JwtRequirements.
// :ref:`requirement_name <envoy_v3_api_field_extensions.filters.http.jwt_authn.v3.PerRouteConfig.requirement_name>`
// in `PerRouteConfig` uses this map to specify a JwtRequirement.
map<string, JwtRequirement> requirement_map = 5;
}
// Specify per-route config.
message PerRouteConfig {
oneof requirement_specifier {
option (validate.required) = true;
// Disable Jwt Authentication for this route.
bool disabled = 1 [(validate.rules).bool = {const: true}];
// Use requirement_name to specify a JwtRequirement.
// This requirement_name MUST be specified at the
// :ref:`requirement_map <envoy_v3_api_field_extensions.filters.http.jwt_authn.v3.JwtAuthentication.requirement_map>`
// in `JwtAuthentication`. If no, the requests using this route will be rejected with 403.
string requirement_name = 2 [(validate.rules).string = {min_len: 1}];
}
}