-
Notifications
You must be signed in to change notification settings - Fork 683
/
config.pb.go
2277 lines (2089 loc) · 97.2 KB
/
config.pb.go
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
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Code generated by protoc-gen-go. DO NOT EDIT.
// versions:
// protoc-gen-go v1.30.0
// protoc v4.23.1
// source: envoy/extensions/filters/http/jwt_authn/v3/config.proto
package jwt_authnv3
import (
_ "github.com/cncf/xds/go/udpa/annotations"
v3 "github.com/emissary-ingress/emissary/v3/pkg/api/envoy/config/core/v3"
v31 "github.com/emissary-ingress/emissary/v3/pkg/api/envoy/config/route/v3"
_ "github.com/envoyproxy/protoc-gen-validate/validate"
duration "github.com/golang/protobuf/ptypes/duration"
protoreflect "google.golang.org/protobuf/reflect/protoreflect"
protoimpl "google.golang.org/protobuf/runtime/protoimpl"
emptypb "google.golang.org/protobuf/types/known/emptypb"
reflect "reflect"
sync "sync"
)
const (
// Verify that this generated code is sufficiently up-to-date.
_ = protoimpl.EnforceVersion(20 - protoimpl.MinVersion)
// Verify that runtime/protoimpl is sufficiently up-to-date.
_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20)
)
// 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: 17]
type JwtProvider struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// 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,
// 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
//
Issuer string `protobuf:"bytes,1,opt,name=issuer,proto3" json:"issuer,omitempty"`
// 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
//
Audiences []string `protobuf:"bytes,2,rep,name=audiences,proto3" json:"audiences,omitempty"`
// `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.
//
// Types that are assignable to JwksSourceSpecifier:
// *JwtProvider_RemoteJwks
// *JwtProvider_LocalJwks
JwksSourceSpecifier isJwtProvider_JwksSourceSpecifier `protobuf_oneof:"jwks_source_specifier"`
// 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.
// caveat: only works for from_header & has no effect for JWTs extracted through from_params & from_cookies.
Forward bool `protobuf:"varint,5,opt,name=forward,proto3" json:"forward,omitempty"`
// 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>``.
//
FromHeaders []*JwtHeader `protobuf:"bytes,6,rep,name=from_headers,json=fromHeaders,proto3" json:"from_headers,omitempty"`
// 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>
//
FromParams []string `protobuf:"bytes,7,rep,name=from_params,json=fromParams,proto3" json:"from_params,omitempty"`
// JWT is sent in a cookie. ``from_cookies`` represents the cookie names to extract from.
//
// For example, if config is:
//
// .. code-block:: yaml
//
// from_cookies:
// - auth-token
//
// Then JWT will be extracted from ``auth-token`` cookie in the request.
//
FromCookies []string `protobuf:"bytes,13,rep,name=from_cookies,json=fromCookies,proto3" json:"from_cookies,omitempty"`
// 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.
ForwardPayloadHeader string `protobuf:"bytes,8,opt,name=forward_payload_header,json=forwardPayloadHeader,proto3" json:"forward_payload_header,omitempty"`
// When :ref:`forward_payload_header <envoy_v3_api_field_extensions.filters.http.jwt_authn.v3.JwtProvider.forward_payload_header>`
// is specified, the base64 encoded payload will be added to the headers.
// Normally JWT based64 encode doesn't add padding. If this field is true,
// the header will be padded.
//
// This field is only relevant if :ref:`forward_payload_header <envoy_v3_api_field_extensions.filters.http.jwt_authn.v3.JwtProvider.forward_payload_header>`
// is specified.
PadForwardPayloadHeader bool `protobuf:"varint,11,opt,name=pad_forward_payload_header,json=padForwardPayloadHeader,proto3" json:"pad_forward_payload_header,omitempty"`
// 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
//
PayloadInMetadata string `protobuf:"bytes,9,opt,name=payload_in_metadata,json=payloadInMetadata,proto3" json:"payload_in_metadata,omitempty"`
// If not empty, similar to :ref:`payload_in_metadata <envoy_v3_api_field_extensions.filters.http.jwt_authn.v3.JwtProvider.payload_in_metadata>`,
// a successfully verified JWT header will be written to :ref:`Dynamic State <arch_overview_data_sharing_between_filters>`
// as an entry (``protobuf::Struct``) in ``envoy.filters.http.jwt_authn`` ``namespace`` with the
// value of this field as the key.
//
// For example, if ``header_in_metadata`` is ``my_header``:
//
// .. code-block:: yaml
//
// envoy.filters.http.jwt_authn:
// my_header:
// alg: JWT
// kid: EF71iSaosbC5C4tC6Syq1Gm647M
// alg: PS256
//
// When the metadata has ``envoy.filters.http.jwt_authn`` entry already (for example if
// :ref:`payload_in_metadata <envoy_v3_api_field_extensions.filters.http.jwt_authn.v3.JwtProvider.payload_in_metadata>`
// is not empty), it will be inserted as a new entry in the same ``namespace`` as shown below:
//
// .. code-block:: yaml
//
// envoy.filters.http.jwt_authn:
// my_payload:
// iss: https://example.com
// sub: test@example.com
// aud: https://example.com
// exp: 1501281058
// my_header:
// alg: JWT
// kid: EF71iSaosbC5C4tC6Syq1Gm647M
// alg: PS256
//
// .. warning::
// Using the same key name for :ref:`header_in_metadata <envoy_v3_api_field_extensions.filters.http.jwt_authn.v3.JwtProvider.payload_in_metadata>`
// and :ref:`payload_in_metadata <envoy_v3_api_field_extensions.filters.http.jwt_authn.v3.JwtProvider.payload_in_metadata>`
// is not suggested due to potential override of existing entry, while it is not enforced during
// config validation.
//
HeaderInMetadata string `protobuf:"bytes,14,opt,name=header_in_metadata,json=headerInMetadata,proto3" json:"header_in_metadata,omitempty"`
// If non empty, the failure status `::google::jwt_verify::Status` for a non verified JWT 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 values of this field will be ``code`` and ``message``
// and they will contain the JWT authentication failure status code and a message describing the failure.
//
// For example, if failed_status_in_metadata is ``my_auth_failure_status``:
//
// .. code-block:: yaml
//
// envoy.filters.http.jwt_authn:
// my_auth_failure_status:
// code: 3
// message: Jwt expired
FailedStatusInMetadata string `protobuf:"bytes,16,opt,name=failed_status_in_metadata,json=failedStatusInMetadata,proto3" json:"failed_status_in_metadata,omitempty"`
// Specify the clock skew in seconds when verifying JWT time constraint,
// such as ``exp``, and ``nbf``. If not specified, default is 60 seconds.
ClockSkewSeconds uint32 `protobuf:"varint,10,opt,name=clock_skew_seconds,json=clockSkewSeconds,proto3" json:"clock_skew_seconds,omitempty"`
// Enables JWT cache, its size is specified by ``jwt_cache_size``.
// Only valid JWT tokens are cached.
JwtCacheConfig *JwtCacheConfig `protobuf:"bytes,12,opt,name=jwt_cache_config,json=jwtCacheConfig,proto3" json:"jwt_cache_config,omitempty"`
// Add JWT claim to HTTP Header
// Specify the claim name you want to copy in which HTTP header. For examples, following config:
// The claim must be of type; string, int, double, bool. Array type claims are not supported
// .. code-block:: yaml
//
// claim_to_headers:
// - name: x-jwt-claim-nested-claim
// claim: claim.nested.key
//
// This header is only reserved for jwt claim; any other value will be overwrite.
ClaimToHeaders []*JwtClaimToHeader `protobuf:"bytes,15,rep,name=claim_to_headers,json=claimToHeaders,proto3" json:"claim_to_headers,omitempty"`
}
func (x *JwtProvider) Reset() {
*x = JwtProvider{}
if protoimpl.UnsafeEnabled {
mi := &file_envoy_extensions_filters_http_jwt_authn_v3_config_proto_msgTypes[0]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
}
func (x *JwtProvider) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*JwtProvider) ProtoMessage() {}
func (x *JwtProvider) ProtoReflect() protoreflect.Message {
mi := &file_envoy_extensions_filters_http_jwt_authn_v3_config_proto_msgTypes[0]
if protoimpl.UnsafeEnabled && x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use JwtProvider.ProtoReflect.Descriptor instead.
func (*JwtProvider) Descriptor() ([]byte, []int) {
return file_envoy_extensions_filters_http_jwt_authn_v3_config_proto_rawDescGZIP(), []int{0}
}
func (x *JwtProvider) GetIssuer() string {
if x != nil {
return x.Issuer
}
return ""
}
func (x *JwtProvider) GetAudiences() []string {
if x != nil {
return x.Audiences
}
return nil
}
func (m *JwtProvider) GetJwksSourceSpecifier() isJwtProvider_JwksSourceSpecifier {
if m != nil {
return m.JwksSourceSpecifier
}
return nil
}
func (x *JwtProvider) GetRemoteJwks() *RemoteJwks {
if x, ok := x.GetJwksSourceSpecifier().(*JwtProvider_RemoteJwks); ok {
return x.RemoteJwks
}
return nil
}
func (x *JwtProvider) GetLocalJwks() *v3.DataSource {
if x, ok := x.GetJwksSourceSpecifier().(*JwtProvider_LocalJwks); ok {
return x.LocalJwks
}
return nil
}
func (x *JwtProvider) GetForward() bool {
if x != nil {
return x.Forward
}
return false
}
func (x *JwtProvider) GetFromHeaders() []*JwtHeader {
if x != nil {
return x.FromHeaders
}
return nil
}
func (x *JwtProvider) GetFromParams() []string {
if x != nil {
return x.FromParams
}
return nil
}
func (x *JwtProvider) GetFromCookies() []string {
if x != nil {
return x.FromCookies
}
return nil
}
func (x *JwtProvider) GetForwardPayloadHeader() string {
if x != nil {
return x.ForwardPayloadHeader
}
return ""
}
func (x *JwtProvider) GetPadForwardPayloadHeader() bool {
if x != nil {
return x.PadForwardPayloadHeader
}
return false
}
func (x *JwtProvider) GetPayloadInMetadata() string {
if x != nil {
return x.PayloadInMetadata
}
return ""
}
func (x *JwtProvider) GetHeaderInMetadata() string {
if x != nil {
return x.HeaderInMetadata
}
return ""
}
func (x *JwtProvider) GetFailedStatusInMetadata() string {
if x != nil {
return x.FailedStatusInMetadata
}
return ""
}
func (x *JwtProvider) GetClockSkewSeconds() uint32 {
if x != nil {
return x.ClockSkewSeconds
}
return 0
}
func (x *JwtProvider) GetJwtCacheConfig() *JwtCacheConfig {
if x != nil {
return x.JwtCacheConfig
}
return nil
}
func (x *JwtProvider) GetClaimToHeaders() []*JwtClaimToHeader {
if x != nil {
return x.ClaimToHeaders
}
return nil
}
type isJwtProvider_JwksSourceSpecifier interface {
isJwtProvider_JwksSourceSpecifier()
}
type JwtProvider_RemoteJwks struct {
// 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 *RemoteJwks `protobuf:"bytes,3,opt,name=remote_jwks,json=remoteJwks,proto3,oneof"`
}
type JwtProvider_LocalJwks struct {
// 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
//
LocalJwks *v3.DataSource `protobuf:"bytes,4,opt,name=local_jwks,json=localJwks,proto3,oneof"`
}
func (*JwtProvider_RemoteJwks) isJwtProvider_JwksSourceSpecifier() {}
func (*JwtProvider_LocalJwks) isJwtProvider_JwksSourceSpecifier() {}
// This message specifies JWT Cache configuration.
type JwtCacheConfig struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// The unit is number of JWT tokens, default to 100.
JwtCacheSize uint32 `protobuf:"varint,1,opt,name=jwt_cache_size,json=jwtCacheSize,proto3" json:"jwt_cache_size,omitempty"`
}
func (x *JwtCacheConfig) Reset() {
*x = JwtCacheConfig{}
if protoimpl.UnsafeEnabled {
mi := &file_envoy_extensions_filters_http_jwt_authn_v3_config_proto_msgTypes[1]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
}
func (x *JwtCacheConfig) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*JwtCacheConfig) ProtoMessage() {}
func (x *JwtCacheConfig) ProtoReflect() protoreflect.Message {
mi := &file_envoy_extensions_filters_http_jwt_authn_v3_config_proto_msgTypes[1]
if protoimpl.UnsafeEnabled && x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use JwtCacheConfig.ProtoReflect.Descriptor instead.
func (*JwtCacheConfig) Descriptor() ([]byte, []int) {
return file_envoy_extensions_filters_http_jwt_authn_v3_config_proto_rawDescGZIP(), []int{1}
}
func (x *JwtCacheConfig) GetJwtCacheSize() uint32 {
if x != nil {
return x.JwtCacheSize
}
return 0
}
// This message specifies how to fetch JWKS from remote and how to cache it.
type RemoteJwks struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// 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
//
HttpUri *v3.HttpUri `protobuf:"bytes,1,opt,name=http_uri,json=httpUri,proto3" json:"http_uri,omitempty"`
// Duration after which the cached JWKS should be expired. If not specified, default cache
// duration is 10 minutes.
CacheDuration *duration.Duration `protobuf:"bytes,2,opt,name=cache_duration,json=cacheDuration,proto3" json:"cache_duration,omitempty"`
// Fetch Jwks asynchronously in the main thread before the listener is activated.
// Fetched Jwks can be used by all worker threads.
//
// If this feature is not enabled:
//
// * The Jwks is fetched on-demand when the requests come. During the fetching, first
// few requests are paused until the Jwks is fetched.
// * Each worker thread fetches its own Jwks since Jwks cache is per worker thread.
//
// If this feature is enabled:
//
// * Fetched Jwks is done in the main thread before the listener is activated. Its fetched
// Jwks can be used by all worker threads. Each worker thread doesn't need to fetch its own.
// * Jwks is ready when the requests come, not need to wait for the Jwks fetching.
//
AsyncFetch *JwksAsyncFetch `protobuf:"bytes,3,opt,name=async_fetch,json=asyncFetch,proto3" json:"async_fetch,omitempty"`
// Retry policy for fetching Jwks. optional. turned off by default.
//
// For example:
//
// .. code-block:: yaml
//
// retry_policy:
// retry_back_off:
// base_interval: 0.01s
// max_interval: 20s
// num_retries: 10
//
// will yield a randomized truncated exponential backoff policy with an initial delay of 10ms
// 10 maximum attempts spaced at most 20s seconds.
//
// .. code-block:: yaml
//
// retry_policy:
// num_retries:1
//
// uses the default :ref:`retry backoff strategy <envoy_v3_api_msg_config.core.v3.BackoffStrategy>`.
// with the default base interval is 1000 milliseconds. and the default maximum interval of 10 times the base interval.
//
// if num_retries is omitted, the default is to allow only one retry.
//
//
// If enabled, the retry policy will apply to all Jwks fetching approaches, e.g. on demand or asynchronously in background.
//
//
RetryPolicy *v3.RetryPolicy `protobuf:"bytes,4,opt,name=retry_policy,json=retryPolicy,proto3" json:"retry_policy,omitempty"`
}
func (x *RemoteJwks) Reset() {
*x = RemoteJwks{}
if protoimpl.UnsafeEnabled {
mi := &file_envoy_extensions_filters_http_jwt_authn_v3_config_proto_msgTypes[2]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
}
func (x *RemoteJwks) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*RemoteJwks) ProtoMessage() {}
func (x *RemoteJwks) ProtoReflect() protoreflect.Message {
mi := &file_envoy_extensions_filters_http_jwt_authn_v3_config_proto_msgTypes[2]
if protoimpl.UnsafeEnabled && x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use RemoteJwks.ProtoReflect.Descriptor instead.
func (*RemoteJwks) Descriptor() ([]byte, []int) {
return file_envoy_extensions_filters_http_jwt_authn_v3_config_proto_rawDescGZIP(), []int{2}
}
func (x *RemoteJwks) GetHttpUri() *v3.HttpUri {
if x != nil {
return x.HttpUri
}
return nil
}
func (x *RemoteJwks) GetCacheDuration() *duration.Duration {
if x != nil {
return x.CacheDuration
}
return nil
}
func (x *RemoteJwks) GetAsyncFetch() *JwksAsyncFetch {
if x != nil {
return x.AsyncFetch
}
return nil
}
func (x *RemoteJwks) GetRetryPolicy() *v3.RetryPolicy {
if x != nil {
return x.RetryPolicy
}
return nil
}
// Fetch Jwks asynchronously in the main thread when the filter config is parsed.
// The listener is activated only after the Jwks is fetched.
// When the Jwks is expired in the cache, it is fetched again in the main thread.
// The fetched Jwks from the main thread can be used by all worker threads.
type JwksAsyncFetch struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// If false, the listener is activated after the initial fetch is completed.
// The initial fetch result can be either successful or failed.
// If true, it is activated without waiting for the initial fetch to complete.
// Default is false.
FastListener bool `protobuf:"varint,1,opt,name=fast_listener,json=fastListener,proto3" json:"fast_listener,omitempty"`
// The duration to refetch after a failed fetch. If not specified, default is 1 second.
FailedRefetchDuration *duration.Duration `protobuf:"bytes,2,opt,name=failed_refetch_duration,json=failedRefetchDuration,proto3" json:"failed_refetch_duration,omitempty"`
}
func (x *JwksAsyncFetch) Reset() {
*x = JwksAsyncFetch{}
if protoimpl.UnsafeEnabled {
mi := &file_envoy_extensions_filters_http_jwt_authn_v3_config_proto_msgTypes[3]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
}
func (x *JwksAsyncFetch) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*JwksAsyncFetch) ProtoMessage() {}
func (x *JwksAsyncFetch) ProtoReflect() protoreflect.Message {
mi := &file_envoy_extensions_filters_http_jwt_authn_v3_config_proto_msgTypes[3]
if protoimpl.UnsafeEnabled && x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use JwksAsyncFetch.ProtoReflect.Descriptor instead.
func (*JwksAsyncFetch) Descriptor() ([]byte, []int) {
return file_envoy_extensions_filters_http_jwt_authn_v3_config_proto_rawDescGZIP(), []int{3}
}
func (x *JwksAsyncFetch) GetFastListener() bool {
if x != nil {
return x.FastListener
}
return false
}
func (x *JwksAsyncFetch) GetFailedRefetchDuration() *duration.Duration {
if x != nil {
return x.FailedRefetchDuration
}
return nil
}
// This message specifies a header location to extract JWT token.
type JwtHeader struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// The HTTP header name.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// 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.
ValuePrefix string `protobuf:"bytes,2,opt,name=value_prefix,json=valuePrefix,proto3" json:"value_prefix,omitempty"`
}
func (x *JwtHeader) Reset() {
*x = JwtHeader{}
if protoimpl.UnsafeEnabled {
mi := &file_envoy_extensions_filters_http_jwt_authn_v3_config_proto_msgTypes[4]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
}
func (x *JwtHeader) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*JwtHeader) ProtoMessage() {}
func (x *JwtHeader) ProtoReflect() protoreflect.Message {
mi := &file_envoy_extensions_filters_http_jwt_authn_v3_config_proto_msgTypes[4]
if protoimpl.UnsafeEnabled && x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use JwtHeader.ProtoReflect.Descriptor instead.
func (*JwtHeader) Descriptor() ([]byte, []int) {
return file_envoy_extensions_filters_http_jwt_authn_v3_config_proto_rawDescGZIP(), []int{4}
}
func (x *JwtHeader) GetName() string {
if x != nil {
return x.Name
}
return ""
}
func (x *JwtHeader) GetValuePrefix() string {
if x != nil {
return x.ValuePrefix
}
return ""
}
// Specify a required provider with audiences.
type ProviderWithAudiences struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// Specify a required provider name.
ProviderName string `protobuf:"bytes,1,opt,name=provider_name,json=providerName,proto3" json:"provider_name,omitempty"`
// This field overrides the one specified in the JwtProvider.
Audiences []string `protobuf:"bytes,2,rep,name=audiences,proto3" json:"audiences,omitempty"`
}
func (x *ProviderWithAudiences) Reset() {
*x = ProviderWithAudiences{}
if protoimpl.UnsafeEnabled {
mi := &file_envoy_extensions_filters_http_jwt_authn_v3_config_proto_msgTypes[5]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
}
func (x *ProviderWithAudiences) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*ProviderWithAudiences) ProtoMessage() {}
func (x *ProviderWithAudiences) ProtoReflect() protoreflect.Message {
mi := &file_envoy_extensions_filters_http_jwt_authn_v3_config_proto_msgTypes[5]
if protoimpl.UnsafeEnabled && x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use ProviderWithAudiences.ProtoReflect.Descriptor instead.
func (*ProviderWithAudiences) Descriptor() ([]byte, []int) {
return file_envoy_extensions_filters_http_jwt_authn_v3_config_proto_rawDescGZIP(), []int{5}
}
func (x *ProviderWithAudiences) GetProviderName() string {
if x != nil {
return x.ProviderName
}
return ""
}
func (x *ProviderWithAudiences) GetAudiences() []string {
if x != nil {
return x.Audiences
}
return nil
}
// 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]
type JwtRequirement struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// Types that are assignable to RequiresType:
// *JwtRequirement_ProviderName
// *JwtRequirement_ProviderAndAudiences
// *JwtRequirement_RequiresAny
// *JwtRequirement_RequiresAll
// *JwtRequirement_AllowMissingOrFailed
// *JwtRequirement_AllowMissing
RequiresType isJwtRequirement_RequiresType `protobuf_oneof:"requires_type"`
}
func (x *JwtRequirement) Reset() {
*x = JwtRequirement{}
if protoimpl.UnsafeEnabled {
mi := &file_envoy_extensions_filters_http_jwt_authn_v3_config_proto_msgTypes[6]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
}
func (x *JwtRequirement) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*JwtRequirement) ProtoMessage() {}
func (x *JwtRequirement) ProtoReflect() protoreflect.Message {
mi := &file_envoy_extensions_filters_http_jwt_authn_v3_config_proto_msgTypes[6]
if protoimpl.UnsafeEnabled && x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use JwtRequirement.ProtoReflect.Descriptor instead.
func (*JwtRequirement) Descriptor() ([]byte, []int) {
return file_envoy_extensions_filters_http_jwt_authn_v3_config_proto_rawDescGZIP(), []int{6}
}
func (m *JwtRequirement) GetRequiresType() isJwtRequirement_RequiresType {
if m != nil {
return m.RequiresType
}
return nil
}
func (x *JwtRequirement) GetProviderName() string {
if x, ok := x.GetRequiresType().(*JwtRequirement_ProviderName); ok {
return x.ProviderName
}
return ""
}
func (x *JwtRequirement) GetProviderAndAudiences() *ProviderWithAudiences {
if x, ok := x.GetRequiresType().(*JwtRequirement_ProviderAndAudiences); ok {
return x.ProviderAndAudiences
}
return nil
}
func (x *JwtRequirement) GetRequiresAny() *JwtRequirementOrList {
if x, ok := x.GetRequiresType().(*JwtRequirement_RequiresAny); ok {
return x.RequiresAny
}
return nil
}
func (x *JwtRequirement) GetRequiresAll() *JwtRequirementAndList {
if x, ok := x.GetRequiresType().(*JwtRequirement_RequiresAll); ok {
return x.RequiresAll
}
return nil
}
func (x *JwtRequirement) GetAllowMissingOrFailed() *emptypb.Empty {
if x, ok := x.GetRequiresType().(*JwtRequirement_AllowMissingOrFailed); ok {
return x.AllowMissingOrFailed
}
return nil
}
func (x *JwtRequirement) GetAllowMissing() *emptypb.Empty {
if x, ok := x.GetRequiresType().(*JwtRequirement_AllowMissing); ok {
return x.AllowMissing
}
return nil
}
type isJwtRequirement_RequiresType interface {
isJwtRequirement_RequiresType()
}
type JwtRequirement_ProviderName struct {
// Specify a required provider name.
ProviderName string `protobuf:"bytes,1,opt,name=provider_name,json=providerName,proto3,oneof"`
}
type JwtRequirement_ProviderAndAudiences struct {
// Specify a required provider with audiences.
ProviderAndAudiences *ProviderWithAudiences `protobuf:"bytes,2,opt,name=provider_and_audiences,json=providerAndAudiences,proto3,oneof"`
}
type JwtRequirement_RequiresAny struct {
// Specify list of JwtRequirement. Their results are OR-ed.
// If any one of them passes, the result is passed.
RequiresAny *JwtRequirementOrList `protobuf:"bytes,3,opt,name=requires_any,json=requiresAny,proto3,oneof"`
}
type JwtRequirement_RequiresAll struct {
// Specify list of JwtRequirement. Their results are AND-ed.
// All of them must pass, if one of them fails or missing, it fails.
RequiresAll *JwtRequirementAndList `protobuf:"bytes,4,opt,name=requires_all,json=requiresAll,proto3,oneof"`
}
type JwtRequirement_AllowMissingOrFailed struct {