-
Notifications
You must be signed in to change notification settings - Fork 31
/
authorino.kuadrant.io_authconfigs.yaml
4918 lines (4918 loc) · 279 KB
/
authorino.kuadrant.io_authconfigs.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
---
apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
annotations:
controller-gen.kubebuilder.io/version: v0.9.0
creationTimestamp: null
name: authconfigs.authorino.kuadrant.io
spec:
group: authorino.kuadrant.io
names:
kind: AuthConfig
listKind: AuthConfigList
plural: authconfigs
singular: authconfig
scope: Namespaced
versions:
- additionalPrinterColumns:
- description: Ready for all hosts
jsonPath: .status.summary.ready
name: Ready
type: string
- description: Number of hosts ready
jsonPath: .status.summary.numHostsReady
name: Hosts
type: string
- description: Number of trusted identity sources
jsonPath: .status.summary.numIdentitySources
name: Authentication
priority: 2
type: integer
- description: Number of external metadata sources
jsonPath: .status.summary.numMetadataSources
name: Metadata
priority: 2
type: integer
- description: Number of authorization policies
jsonPath: .status.summary.numAuthorizationPolicies
name: Authorization
priority: 2
type: integer
- description: Number of items added to the authorization response
jsonPath: .status.summary.numResponseItems
name: Response
priority: 2
type: integer
- description: Whether issuing Festival Wristbands
jsonPath: .status.summary.festivalWristbandEnabled
name: Wristband
priority: 2
type: boolean
name: v1beta1
schema:
openAPIV3Schema:
description: AuthConfig is the schema for Authorino's AuthConfig API
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: Specifies the desired state of the AuthConfig resource, i.e.
the authencation/authorization scheme to be applied to protect the matching
service hosts.
properties:
authorization:
description: Authorization is the list of authorization policies.
All policies in this list MUST evaluate to "true" for a request
be successful in the authorization phase.
items:
description: 'Authorization policy to be enforced. Apart from "name",
one of the following parameters is required and only one of the
following parameters is allowed: "opa", "json" or "kubernetes".'
properties:
authzed:
description: Authzed authorization
properties:
endpoint:
description: Endpoint of the Authzed service.
type: string
insecure:
description: Insecure HTTP connection (i.e. disables TLS
verification)
type: boolean
permission:
description: The name of the permission (or relation) on
which to execute the check.
properties:
value:
description: Static value
type: string
valueFrom:
description: Dynamic value
properties:
authJSON:
description: 'Selector to fetch a value from the
authorization JSON. It can be any path pattern
to fetch from the authorization JSON (e.g. ''context.request.http.host'')
or a string template with variable placeholders
that resolve to patterns (e.g. "Hello, {auth.identity.name}!").
Any patterns supported by https://pkg.go.dev/github.com/tidwall/gjson
can be used. The following string modifiers are
available: @extract:{sep:" ",pos:0}, @replace{old:"",new:""},
@case:upper|lower, @base64:encode|decode and @strip.'
type: string
type: object
type: object
resource:
description: The resource on which to check the permission
or relation.
properties:
kind:
description: StaticOrDynamicValue is either a constant
static string value or a config for fetching a value
from a dynamic source (e.g. a path pattern of authorization
JSON)
properties:
value:
description: Static value
type: string
valueFrom:
description: Dynamic value
properties:
authJSON:
description: 'Selector to fetch a value from
the authorization JSON. It can be any path
pattern to fetch from the authorization JSON
(e.g. ''context.request.http.host'') or a
string template with variable placeholders
that resolve to patterns (e.g. "Hello, {auth.identity.name}!").
Any patterns supported by https://pkg.go.dev/github.com/tidwall/gjson
can be used. The following string modifiers
are available: @extract:{sep:" ",pos:0}, @replace{old:"",new:""},
@case:upper|lower, @base64:encode|decode and
@strip.'
type: string
type: object
type: object
name:
description: StaticOrDynamicValue is either a constant
static string value or a config for fetching a value
from a dynamic source (e.g. a path pattern of authorization
JSON)
properties:
value:
description: Static value
type: string
valueFrom:
description: Dynamic value
properties:
authJSON:
description: 'Selector to fetch a value from
the authorization JSON. It can be any path
pattern to fetch from the authorization JSON
(e.g. ''context.request.http.host'') or a
string template with variable placeholders
that resolve to patterns (e.g. "Hello, {auth.identity.name}!").
Any patterns supported by https://pkg.go.dev/github.com/tidwall/gjson
can be used. The following string modifiers
are available: @extract:{sep:" ",pos:0}, @replace{old:"",new:""},
@case:upper|lower, @base64:encode|decode and
@strip.'
type: string
type: object
type: object
type: object
sharedSecretRef:
description: Reference to a Secret key whose value will
be used by Authorino to authenticate with the Authzed
service.
properties:
key:
description: The key of the secret to select from. Must
be a valid secret key.
type: string
name:
description: The name of the secret in the Authorino's
namespace to select from.
type: string
required:
- key
- name
type: object
subject:
description: The subject that will be checked for the permission
or relation.
properties:
kind:
description: StaticOrDynamicValue is either a constant
static string value or a config for fetching a value
from a dynamic source (e.g. a path pattern of authorization
JSON)
properties:
value:
description: Static value
type: string
valueFrom:
description: Dynamic value
properties:
authJSON:
description: 'Selector to fetch a value from
the authorization JSON. It can be any path
pattern to fetch from the authorization JSON
(e.g. ''context.request.http.host'') or a
string template with variable placeholders
that resolve to patterns (e.g. "Hello, {auth.identity.name}!").
Any patterns supported by https://pkg.go.dev/github.com/tidwall/gjson
can be used. The following string modifiers
are available: @extract:{sep:" ",pos:0}, @replace{old:"",new:""},
@case:upper|lower, @base64:encode|decode and
@strip.'
type: string
type: object
type: object
name:
description: StaticOrDynamicValue is either a constant
static string value or a config for fetching a value
from a dynamic source (e.g. a path pattern of authorization
JSON)
properties:
value:
description: Static value
type: string
valueFrom:
description: Dynamic value
properties:
authJSON:
description: 'Selector to fetch a value from
the authorization JSON. It can be any path
pattern to fetch from the authorization JSON
(e.g. ''context.request.http.host'') or a
string template with variable placeholders
that resolve to patterns (e.g. "Hello, {auth.identity.name}!").
Any patterns supported by https://pkg.go.dev/github.com/tidwall/gjson
can be used. The following string modifiers
are available: @extract:{sep:" ",pos:0}, @replace{old:"",new:""},
@case:upper|lower, @base64:encode|decode and
@strip.'
type: string
type: object
type: object
type: object
required:
- endpoint
type: object
cache:
description: Caching options for the policy evaluation results
when enforcing this config. Omit it to avoid caching policy
evaluation results for this config.
properties:
key:
description: Key used to store the entry in the cache. Cache
entries from different metadata configs are stored and
managed separately regardless of the key.
properties:
value:
description: Static value
type: string
valueFrom:
description: Dynamic value
properties:
authJSON:
description: 'Selector to fetch a value from the
authorization JSON. It can be any path pattern
to fetch from the authorization JSON (e.g. ''context.request.http.host'')
or a string template with variable placeholders
that resolve to patterns (e.g. "Hello, {auth.identity.name}!").
Any patterns supported by https://pkg.go.dev/github.com/tidwall/gjson
can be used. The following string modifiers are
available: @extract:{sep:" ",pos:0}, @replace{old:"",new:""},
@case:upper|lower, @base64:encode|decode and @strip.'
type: string
type: object
type: object
ttl:
default: 60
description: Duration (in seconds) of the external data
in the cache before pulled again from the source.
type: integer
required:
- key
type: object
json:
description: JSON pattern matching authorization policy.
properties:
rules:
description: The rules that must all evaluate to "true"
for the request to be authorized.
items:
properties:
all:
description: A list of pattern expressions to be evaluated
as a logical AND.
items:
type: object
x-kubernetes-preserve-unknown-fields: true
type: array
any:
description: A list of pattern expressions to be evaluated
as a logical OR.
items:
type: object
x-kubernetes-preserve-unknown-fields: true
type: array
operator:
description: 'The binary operator to be applied to
the content fetched from the authorization JSON,
for comparison with "value". Possible values are:
"eq" (equal to), "neq" (not equal to), "incl" (includes;
for arrays), "excl" (excludes; for arrays), "matches"
(regex)'
enum:
- eq
- neq
- incl
- excl
- matches
type: string
patternRef:
description: Name of a named pattern
type: string
selector:
description: Any pattern supported by https://pkg.go.dev/github.com/tidwall/gjson.
The value is used to fetch content from the input
authorization JSON built by Authorino along the
identity and metadata phases.
type: string
value:
description: The value of reference for the comparison
with the content fetched from the authorization
JSON. If used with the "matches" operator, the value
must compile to a valid Golang regex.
type: string
type: object
type: array
required:
- rules
type: object
kubernetes:
description: Kubernetes authorization policy based on `SubjectAccessReview`
Path and Verb are inferred from the request.
properties:
groups:
description: Groups to test for.
items:
type: string
type: array
resourceAttributes:
description: Use ResourceAttributes for checking permissions
on Kubernetes resources If omitted, it performs a non-resource
`SubjectAccessReview`, with verb and path inferred from
the request.
properties:
group:
description: StaticOrDynamicValue is either a constant
static string value or a config for fetching a value
from a dynamic source (e.g. a path pattern of authorization
JSON)
properties:
value:
description: Static value
type: string
valueFrom:
description: Dynamic value
properties:
authJSON:
description: 'Selector to fetch a value from
the authorization JSON. It can be any path
pattern to fetch from the authorization JSON
(e.g. ''context.request.http.host'') or a
string template with variable placeholders
that resolve to patterns (e.g. "Hello, {auth.identity.name}!").
Any patterns supported by https://pkg.go.dev/github.com/tidwall/gjson
can be used. The following string modifiers
are available: @extract:{sep:" ",pos:0}, @replace{old:"",new:""},
@case:upper|lower, @base64:encode|decode and
@strip.'
type: string
type: object
type: object
name:
description: StaticOrDynamicValue is either a constant
static string value or a config for fetching a value
from a dynamic source (e.g. a path pattern of authorization
JSON)
properties:
value:
description: Static value
type: string
valueFrom:
description: Dynamic value
properties:
authJSON:
description: 'Selector to fetch a value from
the authorization JSON. It can be any path
pattern to fetch from the authorization JSON
(e.g. ''context.request.http.host'') or a
string template with variable placeholders
that resolve to patterns (e.g. "Hello, {auth.identity.name}!").
Any patterns supported by https://pkg.go.dev/github.com/tidwall/gjson
can be used. The following string modifiers
are available: @extract:{sep:" ",pos:0}, @replace{old:"",new:""},
@case:upper|lower, @base64:encode|decode and
@strip.'
type: string
type: object
type: object
namespace:
description: StaticOrDynamicValue is either a constant
static string value or a config for fetching a value
from a dynamic source (e.g. a path pattern of authorization
JSON)
properties:
value:
description: Static value
type: string
valueFrom:
description: Dynamic value
properties:
authJSON:
description: 'Selector to fetch a value from
the authorization JSON. It can be any path
pattern to fetch from the authorization JSON
(e.g. ''context.request.http.host'') or a
string template with variable placeholders
that resolve to patterns (e.g. "Hello, {auth.identity.name}!").
Any patterns supported by https://pkg.go.dev/github.com/tidwall/gjson
can be used. The following string modifiers
are available: @extract:{sep:" ",pos:0}, @replace{old:"",new:""},
@case:upper|lower, @base64:encode|decode and
@strip.'
type: string
type: object
type: object
resource:
description: StaticOrDynamicValue is either a constant
static string value or a config for fetching a value
from a dynamic source (e.g. a path pattern of authorization
JSON)
properties:
value:
description: Static value
type: string
valueFrom:
description: Dynamic value
properties:
authJSON:
description: 'Selector to fetch a value from
the authorization JSON. It can be any path
pattern to fetch from the authorization JSON
(e.g. ''context.request.http.host'') or a
string template with variable placeholders
that resolve to patterns (e.g. "Hello, {auth.identity.name}!").
Any patterns supported by https://pkg.go.dev/github.com/tidwall/gjson
can be used. The following string modifiers
are available: @extract:{sep:" ",pos:0}, @replace{old:"",new:""},
@case:upper|lower, @base64:encode|decode and
@strip.'
type: string
type: object
type: object
subresource:
description: StaticOrDynamicValue is either a constant
static string value or a config for fetching a value
from a dynamic source (e.g. a path pattern of authorization
JSON)
properties:
value:
description: Static value
type: string
valueFrom:
description: Dynamic value
properties:
authJSON:
description: 'Selector to fetch a value from
the authorization JSON. It can be any path
pattern to fetch from the authorization JSON
(e.g. ''context.request.http.host'') or a
string template with variable placeholders
that resolve to patterns (e.g. "Hello, {auth.identity.name}!").
Any patterns supported by https://pkg.go.dev/github.com/tidwall/gjson
can be used. The following string modifiers
are available: @extract:{sep:" ",pos:0}, @replace{old:"",new:""},
@case:upper|lower, @base64:encode|decode and
@strip.'
type: string
type: object
type: object
verb:
description: StaticOrDynamicValue is either a constant
static string value or a config for fetching a value
from a dynamic source (e.g. a path pattern of authorization
JSON)
properties:
value:
description: Static value
type: string
valueFrom:
description: Dynamic value
properties:
authJSON:
description: 'Selector to fetch a value from
the authorization JSON. It can be any path
pattern to fetch from the authorization JSON
(e.g. ''context.request.http.host'') or a
string template with variable placeholders
that resolve to patterns (e.g. "Hello, {auth.identity.name}!").
Any patterns supported by https://pkg.go.dev/github.com/tidwall/gjson
can be used. The following string modifiers
are available: @extract:{sep:" ",pos:0}, @replace{old:"",new:""},
@case:upper|lower, @base64:encode|decode and
@strip.'
type: string
type: object
type: object
type: object
user:
description: User to test for. If without "Groups", then
is it interpreted as "What if User were not a member of
any groups"
properties:
value:
description: Static value
type: string
valueFrom:
description: Dynamic value
properties:
authJSON:
description: 'Selector to fetch a value from the
authorization JSON. It can be any path pattern
to fetch from the authorization JSON (e.g. ''context.request.http.host'')
or a string template with variable placeholders
that resolve to patterns (e.g. "Hello, {auth.identity.name}!").
Any patterns supported by https://pkg.go.dev/github.com/tidwall/gjson
can be used. The following string modifiers are
available: @extract:{sep:" ",pos:0}, @replace{old:"",new:""},
@case:upper|lower, @base64:encode|decode and @strip.'
type: string
type: object
type: object
required:
- user
type: object
metrics:
default: false
description: Whether this authorization config should generate
individual observability metrics
type: boolean
name:
description: Name of the authorization policy. It can be used
to refer to the resolved authorization object in other configs.
type: string
opa:
description: Open Policy Agent (OPA) authorization policy.
properties:
allValues:
default: false
description: Returns the value of all Rego rules in the
virtual document. Values can be read in subsequent evaluators/phases
of the Auth Pipeline. Otherwise, only the default `allow`
rule will be exposed. Returning all Rego rules can affect
performance of OPA policies during reconciliation (policy
precompile) and at runtime.
type: boolean
externalRegistry:
description: External registry of OPA policies.
properties:
credentials:
description: Defines where client credentials will be
passed in the request to the service. If omitted,
it defaults to client credentials passed in the HTTP
Authorization header and the "Bearer" prefix expected
prepended to the secret value.
properties:
in:
default: authorization_header
description: The location in the request where client
credentials shall be passed on requests authenticating
with this identity source/authentication mode.
enum:
- authorization_header
- custom_header
- query
- cookie
type: string
keySelector:
description: Used in conjunction with the `in` parameter.
When used with `authorization_header`, the value
is the prefix of the client credentials string,
separated by a white-space, in the HTTP Authorization
header (e.g. "Bearer", "Basic"). When used with
`custom_header`, `query` or `cookie`, the value
is the name of the HTTP header, query string parameter
or cookie key, respectively.
type: string
required:
- keySelector
type: object
endpoint:
description: Endpoint of the HTTP external registry.
The endpoint must respond with either plain/text or
application/json content-type. In the latter case,
the JSON returned in the body must include a path
`result.raw`, where the raw Rego policy will be extracted
from. This complies with the specification of the
OPA REST API (https://www.openpolicyagent.org/docs/latest/rest-api/#get-a-policy).
type: string
sharedSecretRef:
description: Reference to a Secret key whose value will
be passed by Authorino in the request. The HTTP service
can use the shared secret to authenticate the origin
of the request.
properties:
key:
description: The key of the secret to select from. Must
be a valid secret key.
type: string
name:
description: The name of the secret in the Authorino's
namespace to select from.
type: string
required:
- key
- name
type: object
ttl:
description: Duration (in seconds) of the external data
in the cache before pulled again from the source.
type: integer
type: object
inlineRego:
description: Authorization policy as a Rego language document.
The Rego document must include the "allow" condition,
set by Authorino to "false" by default (i.e. requests
are unauthorized unless changed). The Rego document must
NOT include the "package" declaration in line 1.
type: string
type: object
priority:
default: 0
description: Priority group of the config. All configs in the
same priority group are evaluated concurrently; consecutive
priority groups are evaluated sequentially.
type: integer
when:
description: Conditions for Authorino to enforce this authorization
policy. If omitted, the config will be enforced for all requests.
If present, all conditions must match for the config to be
enforced; otherwise, the config will be skipped.
items:
properties:
all:
description: A list of pattern expressions to be evaluated
as a logical AND.
items:
type: object
x-kubernetes-preserve-unknown-fields: true
type: array
any:
description: A list of pattern expressions to be evaluated
as a logical OR.
items:
type: object
x-kubernetes-preserve-unknown-fields: true
type: array
operator:
description: 'The binary operator to be applied to the
content fetched from the authorization JSON, for comparison
with "value". Possible values are: "eq" (equal to),
"neq" (not equal to), "incl" (includes; for arrays),
"excl" (excludes; for arrays), "matches" (regex)'
enum:
- eq
- neq
- incl
- excl
- matches
type: string
patternRef:
description: Name of a named pattern
type: string
selector:
description: Any pattern supported by https://pkg.go.dev/github.com/tidwall/gjson.
The value is used to fetch content from the input authorization
JSON built by Authorino along the identity and metadata
phases.
type: string
value:
description: The value of reference for the comparison
with the content fetched from the authorization JSON.
If used with the "matches" operator, the value must
compile to a valid Golang regex.
type: string
type: object
type: array
required:
- name
type: object
type: array
callbacks:
description: List of callback configs. Authorino sends callbacks to
specified endpoints at the end of the auth pipeline.
items:
description: Endpoints to callback at the end of each auth pipeline.
properties:
http:
description: Generic HTTP interface to obtain authorization
metadata from a HTTP service.
properties:
body:
description: Raw body of the HTTP request. Supersedes 'bodyParameters';
use either one or the other. Use it with method=POST;
for GET requests, set parameters as query string in the
'endpoint' (placeholders can be used).
properties:
value:
description: Static value
type: string
valueFrom:
description: Dynamic value
properties:
authJSON:
description: 'Selector to fetch a value from the
authorization JSON. It can be any path pattern
to fetch from the authorization JSON (e.g. ''context.request.http.host'')
or a string template with variable placeholders
that resolve to patterns (e.g. "Hello, {auth.identity.name}!").
Any patterns supported by https://pkg.go.dev/github.com/tidwall/gjson
can be used. The following string modifiers are
available: @extract:{sep:" ",pos:0}, @replace{old:"",new:""},
@case:upper|lower, @base64:encode|decode and @strip.'
type: string
type: object
type: object
bodyParameters:
description: Custom parameters to encode in the body of
the HTTP request. Superseded by 'body'; use either one
or the other. Use it with method=POST; for GET requests,
set parameters as query string in the 'endpoint' (placeholders
can be used).
items:
properties:
name:
description: The name of the JSON property
type: string
value:
description: Static value of the JSON property
x-kubernetes-preserve-unknown-fields: true
valueFrom:
description: Dynamic value of the JSON property
properties:
authJSON:
description: 'Selector to fetch a value from the
authorization JSON. It can be any path pattern
to fetch from the authorization JSON (e.g. ''context.request.http.host'')
or a string template with variable placeholders
that resolve to patterns (e.g. "Hello, {auth.identity.name}!").
Any patterns supported by https://pkg.go.dev/github.com/tidwall/gjson
can be used. The following string modifiers
are available: @extract:{sep:" ",pos:0}, @replace{old:"",new:""},
@case:upper|lower, @base64:encode|decode and
@strip.'
type: string
type: object
required:
- name
type: object
type: array
contentType:
default: application/x-www-form-urlencoded
description: Content-Type of the request body. Shapes how
'bodyParameters' are encoded. Use it with method=POST;
for GET requests, Content-Type is automatically set to
'text/plain'.
enum:
- application/x-www-form-urlencoded
- application/json
type: string
credentials:
description: Defines where client credentials will be passed
in the request to the service. If omitted, it defaults
to client credentials passed in the HTTP Authorization
header and the "Bearer" prefix expected prepended to the
secret value.
properties:
in:
default: authorization_header
description: The location in the request where client
credentials shall be passed on requests authenticating
with this identity source/authentication mode.
enum:
- authorization_header
- custom_header
- query
- cookie
type: string
keySelector:
description: Used in conjunction with the `in` parameter.
When used with `authorization_header`, the value is
the prefix of the client credentials string, separated
by a white-space, in the HTTP Authorization header
(e.g. "Bearer", "Basic"). When used with `custom_header`,
`query` or `cookie`, the value is the name of the
HTTP header, query string parameter or cookie key,
respectively.
type: string
required:
- keySelector
type: object
endpoint:
description: Endpoint of the HTTP service. The endpoint
accepts variable placeholders in the format "{selector}",
where "selector" is any pattern supported by https://pkg.go.dev/github.com/tidwall/gjson
and selects value from the authorization JSON. E.g. https://ext-auth-server.io/metadata?p={context.request.http.path}
type: string
headers:
description: Custom headers in the HTTP request.
items:
properties:
name:
description: The name of the JSON property
type: string
value:
description: Static value of the JSON property
x-kubernetes-preserve-unknown-fields: true
valueFrom:
description: Dynamic value of the JSON property
properties:
authJSON:
description: 'Selector to fetch a value from the
authorization JSON. It can be any path pattern
to fetch from the authorization JSON (e.g. ''context.request.http.host'')
or a string template with variable placeholders
that resolve to patterns (e.g. "Hello, {auth.identity.name}!").
Any patterns supported by https://pkg.go.dev/github.com/tidwall/gjson
can be used. The following string modifiers
are available: @extract:{sep:" ",pos:0}, @replace{old:"",new:""},
@case:upper|lower, @base64:encode|decode and
@strip.'
type: string
type: object
required:
- name
type: object
type: array
method:
default: GET
description: 'HTTP verb used in the request to the service.
Accepted values: GET (default), POST. When the request
method is POST, the authorization JSON is passed in the
body of the request.'
enum:
- GET
- POST
type: string
oauth2:
description: Authentication with the HTTP service by OAuth2
Client Credentials grant.
properties:
cache:
default: true
description: Caches and reuses the token until expired.
Set it to false to force fetch the token at every
authorization request regardless of expiration.
type: boolean
clientId:
description: OAuth2 Client ID.
type: string
clientSecretRef:
description: Reference to a Kubernetes Secret key that
stores that OAuth2 Client Secret.
properties:
key:
description: The key of the secret to select from. Must
be a valid secret key.
type: string
name:
description: The name of the secret in the Authorino's
namespace to select from.
type: string
required:
- key
- name
type: object
extraParams:
additionalProperties:
type: string
description: Optional extra parameters for the requests
to the token URL.
type: object
scopes:
description: Optional scopes for the client credentials
grant, if supported by he OAuth2 server.
items:
type: string
type: array
tokenUrl:
description: Token endpoint URL of the OAuth2 resource
server.
type: string
required:
- clientId
- clientSecretRef
- tokenUrl
type: object
sharedSecretRef:
description: Reference to a Secret key whose value will
be passed by Authorino in the request. The HTTP service
can use the shared secret to authenticate the origin of
the request. Ignored if used together with oauth2.
properties:
key:
description: The key of the secret to select from. Must
be a valid secret key.
type: string
name:
description: The name of the secret in the Authorino's
namespace to select from.
type: string
required:
- key
- name
type: object
required:
- endpoint
type: object
metrics:
default: false
description: Whether this callback config should generate individual
observability metrics
type: boolean
name:
description: Name of the callback. It can be used to refer to
the resolved callback response in other configs.
type: string
priority:
default: 0
description: Priority group of the config. All configs in the
same priority group are evaluated concurrently; consecutive
priority groups are evaluated sequentially.
type: integer
when:
description: Conditions for Authorino to perform this callback.
If omitted, the callback will be attempted for all requests.
If present, all conditions must match for the callback to
be attempted; otherwise, the callback will be skipped.
items:
properties:
all:
description: A list of pattern expressions to be evaluated
as a logical AND.
items:
type: object
x-kubernetes-preserve-unknown-fields: true
type: array
any:
description: A list of pattern expressions to be evaluated
as a logical OR.
items:
type: object
x-kubernetes-preserve-unknown-fields: true
type: array
operator:
description: 'The binary operator to be applied to the
content fetched from the authorization JSON, for comparison
with "value". Possible values are: "eq" (equal to),
"neq" (not equal to), "incl" (includes; for arrays),
"excl" (excludes; for arrays), "matches" (regex)'
enum:
- eq
- neq
- incl
- excl
- matches
type: string
patternRef:
description: Name of a named pattern
type: string
selector:
description: Any pattern supported by https://pkg.go.dev/github.com/tidwall/gjson.
The value is used to fetch content from the input authorization
JSON built by Authorino along the identity and metadata
phases.
type: string
value:
description: The value of reference for the comparison
with the content fetched from the authorization JSON.
If used with the "matches" operator, the value must
compile to a valid Golang regex.
type: string
type: object
type: array