-
Notifications
You must be signed in to change notification settings - Fork 0
/
aes-crds.yaml
8599 lines (8599 loc) · 379 KB
/
aes-crds.yaml
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
# GENERATED FILE: edits made by hand will not be preserved.
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
controller-gen.kubebuilder.io/version: v0.13.0
labels:
app.kubernetes.io/instance: emissary-apiext
app.kubernetes.io/managed-by: kubectl_apply_-f_aes-apiext.yaml
app.kubernetes.io/name: emissary-apiext
app.kubernetes.io/part-of: emissary-apiext
name: filterpolicies.gateway.getambassador.io
spec:
group: gateway.getambassador.io
names:
categories:
- ambassador-crds
kind: FilterPolicy
listKind: FilterPolicyList
plural: filterpolicies
shortNames:
- fp
singular: filterpolicy
preserveUnknownFields: false
scope: Namespaced
versions:
- additionalPrinterColumns:
- jsonPath: .status.conditions[?(@.type=="Ready")].reason
name: Status
type: string
- jsonPath: .metadata.creationTimestamp
name: Age
type: date
name: v1alpha1
schema:
openAPIV3Schema:
description: "FilterPolicy provides a way to apply Filters against incoming
request for use cases such as authentication (OAUTH2 & JWT), injecting
custom business logic or doing authorization. \n The FilterPolicy defines
a set of matching rules that determine which set of Filters to apply and
allow re-ordering filters on a per-route basis."
properties:
apiVersion:
description: 'APIVersion defines the versioned schema of this representation
of an object. Servers should convert recognized schemas to the latest
internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type: string
kind:
description: 'Kind is a string value representing the REST resource this
object represents. Servers may infer this from the endpoint the client
submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type: string
metadata:
type: object
spec:
description: Spec defines the desired user configuration for a FilterPolicy
that contains the set of rules.
properties:
ambassadorSelector:
default:
ambassadorIds:
- default
description: Optional field that can be used to limit which instances
of Edge Stack can make use of this resource
properties:
ambassadorIds:
default:
- default
description: limits this resource to be used only by instances
of Edge Stack that have an AMBASSADOR_ID matching one of the
ids in the list
items:
type: string
type: array
type: object
rules:
description: Rules are a set of matching rules that are checked against
incoming request to determine which set of Filter's to apply. If
no matches are found then the request is allowed through to the
upstream service without executing any Filters.
items:
description: FilterPolicyRule contains the users configuration rules
for apply filters to requests.
properties:
filterRefs:
description: "FilterRefs are a list of references to Filter's
that will be applied to the incoming request. Filters will
be applied to the request in the order they are listed. \n
If no filters are provided then the request will be allowed
through to the upstream service without any additional processing.
This allows for having one Rule that is overly permissive
and then using a single rule to opt-out on certain paths."
items:
description: FilterReference contains a reference to a Filter
along with specific configuration for the filter. Each Filter
will have its own subset of arguments that it can use.
properties:
arguments:
description: FilterArguments are strongly typed input
arguments that can be passed into a Filter on per FilterReference
level allowing for different behavior on different Rules.
properties:
apikey:
description: APIKeyArguments define the input arguments
that can be set for an APIKeyFilter on a per FilterPolicy
Rule level.
type: object
external:
description: ExternalArguments define the input arguments
that can be set for an ExternalFilter on a per FilterPolicy
Rule level.
type: object
jwt:
description: JWTArguments define the input arguments
that can be set for an JWTFilter on a per FilterPolicy
Rule level.
properties:
scope:
description: Scope is a set of scopes the JWT
will be validated against.
items:
type: string
type: array
type: object
oauth2:
description: OAuth2Arguments define the input arguments
that can be set for an OAuth2Filter on a per FilterPolicy
Rule level.
properties:
insteadOfRedirect:
description: InsteadOfRedirect allows customizing
the behavior of the OAuthRedirect and whether
it will redirect the browser or not.
properties:
filterRefs:
description: "FilterRefs are a list of references
to Filter's that will be applied when an
OAuth2 session has expired and the user
would like to try a secondary authentication
mechanism without redircting to the iDP.
\n Nesting an OAuth2Filter inside of an
OAuth2Filter is not supported."
x-kubernetes-preserve-unknown-fields: true
ifRequestHeader:
description: IfRequestHeader allows only applying
the InsteadOfRedirect logic when a the header
matches.
properties:
name:
description: "Name of the HTTP Header
to be matched. Name matching MUST be
case insensitive. (See https://tools.ietf.org/html/rfc7230#section-3.2).
\n Valid values include: \n * \"Authorization\"
* \"Set-Cookie\" * \":method\" \n Invalid
values include: \n - \"/invalid\" -
\"/\" is an invalid character"
type: string
negate:
description: "Allows the match criteria
to be negated or flipped. \n For example,
you can have a regex that checks for
any non-empty string which would indicate
would translate to if header exists
on request then match on it. With negate
turned on this would translate to match
on any request that doesn't have a header."
type: boolean
type:
default: Exact
description: "Specifies the semantics
of how HTTP header values should be
compared. Valid HeaderMatchType values
are: \n * \"Exact\" * \"RegularExpression\""
enum:
- Exact
- RegularExpression
type: string
value:
description: "Value of HTTP Header to
be matched. \n if type is RegularExpression
then this must be a valid regex with
length being at least 1"
maxLength: 4096
type: string
required:
- name
type: object
statusCode:
description: StatusCode is the HTTP status
code to be used in response. If filterRef
is not set then this will default to a 403
forbidden.
type: integer
type: object
sameSite:
default: lax
description: SameSite allows a server to define
a cookie attribute making it impossible for
the browser to send this cookie along with cross-site
requests. The main goal is to mitigate the risk
of cross-origin information leakage, and provide
some protection against cross-site request forgery
attacks.
enum:
- default
- none
- lax
- strict
type: string
scope:
description: Scope is a set of scopes the JWT
will be validated against.
items:
type: string
type: array
type: object
plugin:
description: PluginArguments define the input arguments
that can be set for an PluginFilter on a per FilterPolicy
Rule level.
type: object
type:
description: "Type identifies the expected type of
the arguments that will be passed to the FilterRef.
\n This must match the type of the FilterRef and
if it doesn't the FilterPolicy Rule will be considered
invalid and a status condition will be updated to
indicate the mismatch."
enum:
- oauth2
- jwt
- apikey
- external
- plugin
type: string
required:
- type
type: object
ifRequestHeader:
description: IfRequestHeader checks if exact or regular
expression matches a value in a request Header to determine
if an individual Filter is executed or not.
properties:
name:
description: "Name of the HTTP Header to be matched.
Name matching MUST be case insensitive. (See https://tools.ietf.org/html/rfc7230#section-3.2).
\n Valid values include: \n * \"Authorization\"
* \"Set-Cookie\" * \":method\" \n Invalid values
include: \n - \"/invalid\" - \"/\" is an invalid
character"
type: string
negate:
description: "Allows the match criteria to be negated
or flipped. \n For example, you can have a regex
that checks for any non-empty string which would
indicate would translate to if header exists on
request then match on it. With negate turned on
this would translate to match on any request that
doesn't have a header."
type: boolean
type:
default: Exact
description: "Specifies the semantics of how HTTP
header values should be compared. Valid HeaderMatchType
values are: \n * \"Exact\" * \"RegularExpression\""
enum:
- Exact
- RegularExpression
type: string
value:
description: "Value of HTTP Header to be matched.
\n if type is RegularExpression then this must be
a valid regex with length being at least 1"
maxLength: 4096
type: string
required:
- name
type: object
name:
description: Name that identifies the Filter.
minLength: 1
type: string
namespace:
description: "Namespace refers to a Kubernetes namespace
that the Filter resides. It must be a RFC 1123 label.
\n This validation is based off of the corresponding
Kubernetes validation: https://github.com/kubernetes/apimachinery/blob/02cfb53916346d085a6c6c7c66f882e3c6b0eca6/pkg/util/validation/validation.go#L187
\n This is used for Namespace name validation here:
https://github.com/kubernetes/apimachinery/blob/02cfb53916346d085a6c6c7c66f882e3c6b0eca6/pkg/api/validation/generic.go#L63
\n Valid values include: \n * \"example\" \n Invalid
values include: \n * \"example.com\" - \".\" is an invalid
character"
maxLength: 63
minLength: 1
pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$
type: string
onAllow:
default: continue
description: OnAllowAction identifies the FilterAction
that determines the behavior after a Filter allows the
request.
enum:
- break
- continue
type: string
onDeny:
default: break
description: OnDenyAction identifies the FilterAction
that determines the behavior when a Filter denies the
request.
enum:
- break
- continue
type: string
required:
- name
type: object
maxItems: 5
type: array
host:
default: '*'
description: Host is a "glob-string" that matches on the `:authority`
header of the incoming request. If not set it will match on
all incoming requests.
type: string
path:
default: '*'
description: Path is a "glob-string" that matches on the request
path. If not provided then it will match on all incoming requests.
type: string
precedence:
description: Precedence allows forcing a precedence ordering
on the rules. By default the rules are evaluated in the order
they are in the `FilterPolicy.spec.rules` field. However,
multiple FilterPolicy's can be applied to a cluster. To ensure
that a specific ordering is enforced then using a precedence
on rules ensures a specific ordering.
type: integer
type: object
minItems: 1
type: array
type: object
status:
description: Status defines the current state of FilterPolicy that provides
users feedback on whether it is configured correctly.
properties:
conditions:
description: Conditions describe the current conditions of the FilterPolicy.
items:
description: "Condition contains details for one aspect of the current
state of this API Resource. --- This struct is intended for direct
use as an array at the field path .status.conditions. For example,
\n type FooStatus struct{ // Represents the observations of a
foo's current state. // Known .status.conditions.type are: \"Available\",
\"Progressing\", and \"Degraded\" // +patchMergeKey=type // +patchStrategy=merge
// +listType=map // +listMapKey=type Conditions []metav1.Condition
`json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\"
protobuf:\"bytes,1,rep,name=conditions\"` \n // other fields }"
properties:
lastTransitionTime:
description: lastTransitionTime is the last time the condition
transitioned from one status to another. This should be when
the underlying condition changed. If that is not known, then
using the time when the API field changed is acceptable.
format: date-time
type: string
message:
description: message is a human readable message indicating
details about the transition. This may be an empty string.
maxLength: 32768
type: string
observedGeneration:
description: observedGeneration represents the .metadata.generation
that the condition was set based upon. For instance, if .metadata.generation
is currently 12, but the .status.conditions[x].observedGeneration
is 9, the condition is out of date with respect to the current
state of the instance.
format: int64
minimum: 0
type: integer
reason:
description: reason contains a programmatic identifier indicating
the reason for the condition's last transition. Producers
of specific condition types may define expected values and
meanings for this field, and whether the values are considered
a guaranteed API. The value should be a CamelCase string.
This field may not be empty.
maxLength: 1024
minLength: 1
pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$
type: string
status:
description: status of the condition, one of True, False, Unknown.
enum:
- "True"
- "False"
- Unknown
type: string
type:
description: type of condition in CamelCase or in foo.example.com/CamelCase.
--- Many .condition.type values are consistent across resources
like Available, but because arbitrary conditions can be useful
(see .node.status.conditions), the ability to deconflict is
important. The regex it matches is (dns1123SubdomainFmt/)?(qualifiedNameFmt)
maxLength: 316
pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$
type: string
required:
- lastTransitionTime
- message
- reason
- status
- type
type: object
maxItems: 8
type: array
x-kubernetes-list-map-keys:
- type
x-kubernetes-list-type: map
rules:
description: Rules provide status for each unique Rule defined in
the Spec.
items:
description: FilterPolicyRuleStatus is the status associated to
a Rule within a FilterPolicy.
properties:
conditions:
description: Conditions describe the current condition of this
Rule.
items:
description: "Condition contains details for one aspect of
the current state of this API Resource. --- This struct
is intended for direct use as an array at the field path
.status.conditions. For example, \n type FooStatus struct{
// Represents the observations of a foo's current state.
// Known .status.conditions.type are: \"Available\", \"Progressing\",
and \"Degraded\" // +patchMergeKey=type // +patchStrategy=merge
// +listType=map // +listMapKey=type Conditions []metav1.Condition
`json:\"conditions,omitempty\" patchStrategy:\"merge\" patchMergeKey:\"type\"
protobuf:\"bytes,1,rep,name=conditions\"` \n // other fields
}"
properties:
lastTransitionTime:
description: lastTransitionTime is the last time the condition
transitioned from one status to another. This should
be when the underlying condition changed. If that is
not known, then using the time when the API field changed
is acceptable.
format: date-time
type: string
message:
description: message is a human readable message indicating
details about the transition. This may be an empty string.
maxLength: 32768
type: string
observedGeneration:
description: observedGeneration represents the .metadata.generation
that the condition was set based upon. For instance,
if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration
is 9, the condition is out of date with respect to the
current state of the instance.
format: int64
minimum: 0
type: integer
reason:
description: reason contains a programmatic identifier
indicating the reason for the condition's last transition.
Producers of specific condition types may define expected
values and meanings for this field, and whether the
values are considered a guaranteed API. The value should
be a CamelCase string. This field may not be empty.
maxLength: 1024
minLength: 1
pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$
type: string
status:
description: status of the condition, one of True, False,
Unknown.
enum:
- "True"
- "False"
- Unknown
type: string
type:
description: type of condition in CamelCase or in foo.example.com/CamelCase.
--- Many .condition.type values are consistent across
resources like Available, but because arbitrary conditions
can be useful (see .node.status.conditions), the ability
to deconflict is important. The regex it matches is
(dns1123SubdomainFmt/)?(qualifiedNameFmt)
maxLength: 316
pattern: ^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$
type: string
required:
- lastTransitionTime
- message
- reason
- status
- type
type: object
maxItems: 8
type: array
x-kubernetes-list-map-keys:
- type
x-kubernetes-list-type: map
host:
description: Host to help identify the rule with the error.
type: string
index:
description: Index provides the zero-based index in the list
of Rules to help identify the rule with an error.
type: integer
path:
description: Path to help identify the rule with the error.
type: string
required:
- conditions
- host
- index
- path
type: object
maxItems: 64
type: array
x-kubernetes-list-map-keys:
- index
x-kubernetes-list-type: map
type: object
required:
- spec
type: object
served: true
storage: true
subresources:
status: {}
---
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
controller-gen.kubebuilder.io/version: v0.13.0
labels:
app.kubernetes.io/instance: emissary-apiext
app.kubernetes.io/managed-by: kubectl_apply_-f_aes-apiext.yaml
app.kubernetes.io/name: emissary-apiext
app.kubernetes.io/part-of: emissary-apiext
name: filters.gateway.getambassador.io
spec:
group: gateway.getambassador.io
names:
categories:
- ambassador-crds
kind: Filter
listKind: FilterList
plural: filters
shortNames:
- fil
singular: filter
preserveUnknownFields: false
scope: Namespaced
versions:
- additionalPrinterColumns:
- jsonPath: .status.conditions[?(@.type=="Ready")].reason
name: Status
type: string
- jsonPath: .metadata.creationTimestamp
name: Age
type: date
- jsonPath: .spec.type
name: Type
type: string
name: v1alpha1
schema:
openAPIV3Schema:
description: Filter provides the desired configuration for a specific type
of supported filters that can be referenced within FilterPolicies and applied
to incoming requests.
properties:
apiVersion:
description: 'APIVersion defines the versioned schema of this representation
of an object. Servers should convert recognized schemas to the latest
internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
type: string
kind:
description: 'Kind is a string value representing the REST resource this
object represents. Servers may infer this from the endpoint the client
submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
type: string
metadata:
type: object
spec:
description: Spec defines the desired user configuration for a Filter.
properties:
ambassadorSelector:
default:
ambassadorIds:
- default
description: Optional field that can be used to limit which instances
of Edge Stack can make use of this resource
properties:
ambassadorIds:
default:
- default
description: limits this resource to be used only by instances
of Edge Stack that have an AMBASSADOR_ID matching one of the
ids in the list
items:
type: string
type: array
type: object
apikey:
description: APIKeyFilter provides support for validation APIKeys
properties:
httpHeader:
default: X-API-KEY
description: HTTPHeader is the name of the http header where the
api-key will be found. By default it will be found in a case-insensitve
header as "x-api-key".
type: string
keys:
description: Keys are the set of APIKeys that are used to check
the whether the incoming request is valid. Currently it only
supports storing them in local Key
items:
description: APIKeyItem defines how to resolve the values of
the keys. Currently the only supported way to resolve a key
is via a local secret. APIKeys cannot use shared secrets accross
namespaces.
properties:
secretName:
description: Name of secret in within the same namespace
as the APIKeyFilter.
type: string
required:
- secretName
type: object
minItems: 1
type: array
required:
- keys
type: object
external:
description: "ExternalFilter allows users to provide their own Service
that implements the Envoy ext_authz CheckRequest interface. \n The
ExternalFilter acts as a proxy between the Envoy, the Edge Stack
Auth Service and the user provided Service. This has the benefit
of allowing users to re-order Filters on a per route level and to
mix it along with the other Filters."
properties:
authServiceURL:
type: string
failureModeAllow:
default: false
description: FailureModeAllow determines what happens when Edge
Stack cannot communicate with the External Service due to network
issues, or service not being available. By default, the ExternalFilter
will reject the request if it is unable to communicate. This
can be overriden by setting this setting to "true' so that it
fails open, allowing the request through to the upstream service.
type: boolean
grpcSettings:
description: GRPCSettings are the settings specific to the grpc
protocol. This can only be set when `protocol=grpc`.
properties:
protocolVersion:
default: v3
enum:
- v3
type: string
type: object
httpSettings:
description: HTTPSettings are the settings specific to the http
protocol. This can only be set when `protocol=http`.
properties:
addLinkerdHeaders:
description: AddLinkerdHeaders will inject the `l5d-dst-override`
header set to hostname and port of external service which
is used by LinkerD when proxying through the ServiceMesh.
type: boolean
allowedAuthorizationHeaders:
description: "AllowedAuthorizationHeaders are headers from
the External Service that will be added to the request of
the upstream service. \n By default, the following list
of headers are passed to the upstream service - \"location\",
- \"authorization\", - \"proxy-authenticate\", - \"set-cookie\",
- \"www-authenticate\", \n Any additional headers that are
needed should be added and are checked in a case-insenstive."
items:
type: string
type: array
allowedRequestHeaders:
description: "AllowedRequestHeaders are a list of headers
from the downstream request that will be passed along as
headers in the request to the external service. This includes
metadata sent from Envoy to the EdgeStack Auth Service.
\n By default, the following list of headers are passed
through: - \"authorization\" - \"cookie\" - \"from\" - \"proxy-authorization\"
- \"user-agent\" - \"x-forwarded-for\" - \"x-forwarded-host\"
- \"x-forwarded-proto\""
items:
type: string
type: array
pathPrefix:
type: string
type: object
include_body:
description: IncludeBody will pass along the request body to the
External Service. If not set then a blank body is sent over
to the External Service.
properties:
allowPartial:
default: true
description: AllowPartial indicates whether the included body
can be a partially buffered body or if the complete buffered
body is expected. If not partial then a 413 http error is
returned by Envoy.
type: boolean
maxBytes:
default: 4096
description: MaxBytes is the amount of bytes to buffer over
to the External Service.
type: integer
required:
- allowPartial
- maxBytes
type: object
protocol:
description: Protocol indicates what protocol to use when communicating
with the external service. It is recommended to use "grpc" over
"http" due to supporting additional capabilities.
enum:
- http
- grpc
type: string
statusOnError:
default: 403
description: "StatusCodeOnError allows overriding the default
status code returned when the External Service returns a non
OK response (non 200 response code for http or DeniedHttpResponse
for grpc) \n The default is to return a 403 Forbidden Status."
type: integer
timeout:
default: 5s
description: "Timeout is the amount of time Edge Stack will wait
before erring on a timeout. \n The default is 5 seconds and
this can be tweaked depending on your use case. Note: this value
cannot be larger than the overall Auth Service timeout that
is configured in Envoy or else it would effectively not have
any timeout."
type: string
tls:
description: Defines TLS configuration for communicating with
the external service.
properties:
caCertificate:
description: CACertificate provides the public certificate
used to verify the public cert sent by the server.
properties:
fromSecret:
description: FromSecret identifies the K8s secret that
contains a secret of type `kubernetes.io/tls`.
properties:
name:
description: name is unique within a namespace to
reference a secret resource.
type: string
namespace:
description: namespace defines the space within which
the secret name must be unique.
type: string
type: object
x-kubernetes-map-type: atomic
type:
default: Secret
description: SupportedProtocol is the type of protocol
to use when communicating with the External AuthService.
enum:
- Secret
type: string
required:
- type
type: object
certificate:
description: Certificate defines the client private key and
public certificate that will be used to to perform client
authentication with the server.
properties:
fromSecret:
description: FromSecret identifies the K8s secret that
contains a secret of type `kubernetes.io/tls`.
properties:
name:
description: name is unique within a namespace to
reference a secret resource.
type: string
namespace:
description: namespace defines the space within which
the secret name must be unique.
type: string
type: object
x-kubernetes-map-type: atomic
type:
default: Secret
description: SupportedProtocol is the type of protocol
to use when communicating with the External AuthService.
enum:
- Secret
type: string
required:
- type
type: object
type: object
required:
- authServiceURL
- protocol
type: object
jwt:
description: JWTFilter provides configuration for validating a JWT.
properties:
audience:
description: "Audience identifies the recipient that the JWT is
intended for and will be used to validate the provided token
is intended for the configured audience. \n If not provided
then `aud` claim on incoming token is not validated and will
be considered valid. If `aud` is unset on the token by default
it will be considered valid even if it doesn't match the audience
value. To enforce that a token has the aud claim, then set `requireAudience=true`."
type: string
errorResponse:
description: ErrorResponse allows setting a custom Response when
an invalid JWT is received.
properties:
bodyTemplate:
description: Golang `text/template` string that will be evaluated
and used to build the format returned.
type: string
headers:
description: Allows providing additional http response headers
for the error response. The current maximum is 16 headers,
which aligns with the Gateway-API and modified headers on
HTTPRoutes.
items:
description: Provides a way to define a header name and
value template for injecting dynamic header information
based on the request and the session token.
properties:
name:
description: The header name injected into the request
header.
type: string
value:
description: A Golang template that can dynamically
extract request information as the value of the injected
header.
type: string
required:
- name
- value
type: object
maxItems: 16
type: array
realm:
description: "Indicates the scope of protection or the application
that is checking the token. \n By default, this is set to
the fully qualified name of the JWTFilter as \"{name}.{namespace}\"
to identify which filter rejected the error. This can be
overriden to provide more relevant information to end-users."
type: string
type: object
httpClientSettings:
description: HTTPClientSettings used when communicating with the
IdentityProvider.
properties:
insecureTLS:
description: "InsecureTLS tells the OAuth2Client to skip verifying
the IdentityProvider server when communicating with the
various endpoints. \n This is typically needed when using
an IdentityProvider configured with self-signed certs."
type: boolean
maxStale:
description: MaxStale sets the duration that JWKs keys and
OIDC discovery responses will be cached
type: string
renegotiateTLS:
default: never
description: RenegotiateTLS sets whether the OAuth2Filter
will renegotiateTLS with the iDP server and if so what supported
method of renegotiation will be used.
enum:
- never
- onceAsClient
- freelyAsClient
type: string
type: object
injectRequestHeaders:
description: "InjectRequestHeaders is a list of headers that will
be injected into the upstream request if allowed through. The
headers can pull information from the Token and downstream request
headers as values. \n For example, attaching user email claim
to a header from the token."
items:
description: Provides a way to define a header name and value
template for injecting dynamic header information based on
the request and the session token.
properties:
name:
description: The header name injected into the request header.
type: string
value:
description: A Golang template that can dynamically extract
request information as the value of the injected header.
type: string
required:
- name
- value
type: object
type: array
issuer:
description: "Issuer identifies the expected AuthorizationServer
that isssued the token. \n If not provided then the issuer claim
will not be validated. If `issuer` is unset on the token by
default it will be considered valid even if it doesn't match
the expected issuer value. To enforce that a token has the issuer
claim, then set `requireIssuer=true`."
type: string
jwksURI:
description: "JSONWebKeySetURI is a uri that returns the JWK Set
per RFC 7517 \n This is required unless validAlgorithms=[\"none\"],
in that case verifying the signature of the token is disabled.
This is considered unsafe and is discouraged when receiving
tokens from untrusted sources."
type: string
leewayForExpiresAt:
description: LeewayForExpiresAt allows token expired by this much
to still be considered valid. It is recommend that this is small,
so that it only accounts for clock skew and network/application
latency.
type: string
leewayForIssuedAt:
description: LeewayForIssuedAt allows tokens issued by this much
into the future to be considered valid. It is recommend that
this is small, so that it only accounts for clock skew and network/application
latency.
type: string
leewayForNotBefore:
description: LeewayForNotBefore allows tokens that shouldn't be
used until this much in the future to be considered valid. It
is recommend that this is small, so that it only accounts for
clock skew and network/application latency.
type: string
requireAudience:
description: "RequireAudience modifies the validation behavior
for when the audience claim (aud) is unset on the incoming token.
\n false (default) => if aud claim is unset then claim is considered
valid true => if aud claim is unset then claim/token are invalid"
type: boolean
requireExpiresAt:
description: "RequireExpiresAt modifies the validation behavior
for when the expiresAt claim (exp) is unset on the incoming
token. \n false (default) => if exp claim is unset on incoming
token then claim is valid true => if exp claim is unset then
claim/token are invalid"
type: boolean
requireIssuedAt:
description: "RequireIssueedAt modifies the validation behavior
for when the issuedAt claim (iat) is unset on the incoming token.
\n false (default) => if `iat` claim is unset on incoming token
then claim is valid true => if `iat` claim is unset then claim/token
are invalid"
type: boolean
requireIssuer:
description: "RequireIssuer modifies the validation behavior for
when the issuer claim (iss) is unset on the incoming token.
\n false (default) => if aud claim is unset on incoming token
then claim is considered valid true => if exp claim is unset
then claim is invalid"
type: boolean
requireNotBefore:
description: "RequireNotBefore modifies the validation behavior
for when the not before time claim (nbf) is unset on the incoming
token. \n false (default) => if `nbf` claim is unset on incoming
token then claim is valid true => if `nbf` claim is unset then
claim/token are invalid"
type: boolean
validAlgorithms:
description: "ValidAlgorithms is the set of signing algorithms
that can be considered when verifying tokens attached to requests.
If the token is signed with an algorithm that is not in this
list then it will be rejected. If not provided then all supported
algorithms are allowed. \n The list should match the set configured
in the iDP, as well as the full set of possible valid tokens
maybe received. For example, if you may have previously supported
RS256 & RS512 but you have decided to only receive tokens signed
using RS512 now. This will cause existing tokens to be rejected."
items:
description: "JWTSigningMethod is the set of supported signing
algorithms that can be used for client authentication. \n
This list is based on the supported types that the current
jwt library see details here https://github.com/golang-jwt/jwt"
enum:
- none