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
|
apiVersion: apiextensions.k8s.io/v1beta1
kind: CustomResourceDefinition
metadata:
name: oauths.config.openshift.io
spec:
group: config.openshift.io
names:
kind: OAuth
listKind: OAuthList
plural: oauths
singular: oauth
scope: Cluster
preserveUnknownFields: false
subresources:
status: {}
versions:
- name: v1
served: true
storage: true
"validation":
"openAPIV3Schema":
description: OAuth holds cluster-wide information about OAuth. The canonical
name is `cluster`. It is used to configure the integrated OAuth server. This
configuration is only honored when the top level Authentication config has
type set to IntegratedOAuth.
type: object
required:
- spec
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: OAuthSpec contains desired cluster auth configuration
type: object
properties:
identityProviders:
description: identityProviders is an ordered list of ways for a user
to identify themselves. When this list is empty, no identities are
provisioned for users.
type: array
items:
description: IdentityProvider provides identities for users authenticating
using credentials
type: object
properties:
basicAuth:
description: basicAuth contains configuration options for the
BasicAuth IdP
type: object
properties:
ca:
description: ca is an optional reference to a config map by
name containing the PEM-encoded CA bundle. It is used as
a trust anchor to validate the TLS certificate presented
by the remote server. The key "ca.crt" is used to locate
the data. If specified and the config map or expected key
is not found, the identity provider is not honored. If the
specified ca data is not valid, the identity provider is
not honored. If empty, the default system roots are used.
The namespace for this config map is openshift-config.
type: object
required:
- name
properties:
name:
description: name is the metadata.name of the referenced
config map
type: string
tlsClientCert:
description: tlsClientCert is an optional reference to a secret
by name that contains the PEM-encoded TLS client certificate
to present when connecting to the server. The key "tls.crt"
is used to locate the data. If specified and the secret
or expected key is not found, the identity provider is not
honored. If the specified certificate data is not valid,
the identity provider is not honored. The namespace for
this secret is openshift-config.
type: object
required:
- name
properties:
name:
description: name is the metadata.name of the referenced
secret
type: string
tlsClientKey:
description: tlsClientKey is an optional reference to a secret
by name that contains the PEM-encoded TLS private key for
the client certificate referenced in tlsClientCert. The
key "tls.key" is used to locate the data. If specified and
the secret or expected key is not found, the identity provider
is not honored. If the specified certificate data is not
valid, the identity provider is not honored. The namespace
for this secret is openshift-config.
type: object
required:
- name
properties:
name:
description: name is the metadata.name of the referenced
secret
type: string
url:
description: url is the remote URL to connect to
type: string
github:
description: github enables user authentication using GitHub credentials
type: object
properties:
ca:
description: ca is an optional reference to a config map by
name containing the PEM-encoded CA bundle. It is used as
a trust anchor to validate the TLS certificate presented
by the remote server. The key "ca.crt" is used to locate
the data. If specified and the config map or expected key
is not found, the identity provider is not honored. If the
specified ca data is not valid, the identity provider is
not honored. If empty, the default system roots are used.
This can only be configured when hostname is set to a non-empty
value. The namespace for this config map is openshift-config.
type: object
required:
- name
properties:
name:
description: name is the metadata.name of the referenced
config map
type: string
clientID:
description: clientID is the oauth client ID
type: string
clientSecret:
description: clientSecret is a required reference to the secret
by name containing the oauth client secret. The key "clientSecret"
is used to locate the data. If the secret or expected key
is not found, the identity provider is not honored. The
namespace for this secret is openshift-config.
type: object
required:
- name
properties:
name:
description: name is the metadata.name of the referenced
secret
type: string
hostname:
description: hostname is the optional domain (e.g. "mycompany.com")
for use with a hosted instance of GitHub Enterprise. It
must match the GitHub Enterprise settings value configured
at /setup/settings#hostname.
type: string
organizations:
description: organizations optionally restricts which organizations
are allowed to log in
type: array
items:
type: string
teams:
description: teams optionally restricts which teams are allowed
to log in. Format is <org>/<team>.
type: array
items:
type: string
gitlab:
description: gitlab enables user authentication using GitLab credentials
type: object
properties:
ca:
description: ca is an optional reference to a config map by
name containing the PEM-encoded CA bundle. It is used as
a trust anchor to validate the TLS certificate presented
by the remote server. The key "ca.crt" is used to locate
the data. If specified and the config map or expected key
is not found, the identity provider is not honored. If the
specified ca data is not valid, the identity provider is
not honored. If empty, the default system roots are used.
The namespace for this config map is openshift-config.
type: object
required:
- name
properties:
name:
description: name is the metadata.name of the referenced
config map
type: string
clientID:
description: clientID is the oauth client ID
type: string
clientSecret:
description: clientSecret is a required reference to the secret
by name containing the oauth client secret. The key "clientSecret"
is used to locate the data. If the secret or expected key
is not found, the identity provider is not honored. The
namespace for this secret is openshift-config.
type: object
required:
- name
properties:
name:
description: name is the metadata.name of the referenced
secret
type: string
url:
description: url is the oauth server base URL
type: string
google:
description: google enables user authentication using Google credentials
type: object
properties:
clientID:
description: clientID is the oauth client ID
type: string
clientSecret:
description: clientSecret is a required reference to the secret
by name containing the oauth client secret. The key "clientSecret"
is used to locate the data. If the secret or expected key
is not found, the identity provider is not honored. The
namespace for this secret is openshift-config.
type: object
required:
- name
properties:
name:
description: name is the metadata.name of the referenced
secret
type: string
hostedDomain:
description: hostedDomain is the optional Google App domain
(e.g. "mycompany.com") to restrict logins to
type: string
htpasswd:
description: htpasswd enables user authentication using an HTPasswd
file to validate credentials
type: object
properties:
fileData:
description: fileData is a required reference to a secret
by name containing the data to use as the htpasswd file.
The key "htpasswd" is used to locate the data. If the secret
or expected key is not found, the identity provider is not
honored. If the specified htpasswd data is not valid, the
identity provider is not honored. The namespace for this
secret is openshift-config.
type: object
required:
- name
properties:
name:
description: name is the metadata.name of the referenced
secret
type: string
keystone:
description: keystone enables user authentication using keystone
password credentials
type: object
properties:
ca:
description: ca is an optional reference to a config map by
name containing the PEM-encoded CA bundle. It is used as
a trust anchor to validate the TLS certificate presented
by the remote server. The key "ca.crt" is used to locate
the data. If specified and the config map or expected key
is not found, the identity provider is not honored. If the
specified ca data is not valid, the identity provider is
not honored. If empty, the default system roots are used.
The namespace for this config map is openshift-config.
type: object
required:
- name
properties:
name:
description: name is the metadata.name of the referenced
config map
type: string
domainName:
description: domainName is required for keystone v3
type: string
tlsClientCert:
description: tlsClientCert is an optional reference to a secret
by name that contains the PEM-encoded TLS client certificate
to present when connecting to the server. The key "tls.crt"
is used to locate the data. If specified and the secret
or expected key is not found, the identity provider is not
honored. If the specified certificate data is not valid,
the identity provider is not honored. The namespace for
this secret is openshift-config.
type: object
required:
- name
properties:
name:
description: name is the metadata.name of the referenced
secret
type: string
tlsClientKey:
description: tlsClientKey is an optional reference to a secret
by name that contains the PEM-encoded TLS private key for
the client certificate referenced in tlsClientCert. The
key "tls.key" is used to locate the data. If specified and
the secret or expected key is not found, the identity provider
is not honored. If the specified certificate data is not
valid, the identity provider is not honored. The namespace
for this secret is openshift-config.
type: object
required:
- name
properties:
name:
description: name is the metadata.name of the referenced
secret
type: string
url:
description: url is the remote URL to connect to
type: string
ldap:
description: ldap enables user authentication using LDAP credentials
type: object
properties:
attributes:
description: attributes maps LDAP attributes to identities
type: object
properties:
email:
description: email is the list of attributes whose values
should be used as the email address. Optional. If unspecified,
no email is set for the identity
type: array
items:
type: string
id:
description: id is the list of attributes whose values
should be used as the user ID. Required. First non-empty
attribute is used. At least one attribute is required.
If none of the listed attribute have a value, authentication
fails. LDAP standard identity attribute is "dn"
type: array
items:
type: string
name:
description: name is the list of attributes whose values
should be used as the display name. Optional. If unspecified,
no display name is set for the identity LDAP standard
display name attribute is "cn"
type: array
items:
type: string
preferredUsername:
description: preferredUsername is the list of attributes
whose values should be used as the preferred username.
LDAP standard login attribute is "uid"
type: array
items:
type: string
bindDN:
description: bindDN is an optional DN to bind with during
the search phase.
type: string
bindPassword:
description: bindPassword is an optional reference to a secret
by name containing a password to bind with during the search
phase. The key "bindPassword" is used to locate the data.
If specified and the secret or expected key is not found,
the identity provider is not honored. The namespace for
this secret is openshift-config.
type: object
required:
- name
properties:
name:
description: name is the metadata.name of the referenced
secret
type: string
ca:
description: ca is an optional reference to a config map by
name containing the PEM-encoded CA bundle. It is used as
a trust anchor to validate the TLS certificate presented
by the remote server. The key "ca.crt" is used to locate
the data. If specified and the config map or expected key
is not found, the identity provider is not honored. If the
specified ca data is not valid, the identity provider is
not honored. If empty, the default system roots are used.
The namespace for this config map is openshift-config.
type: object
required:
- name
properties:
name:
description: name is the metadata.name of the referenced
config map
type: string
insecure:
description: 'insecure, if true, indicates the connection
should not use TLS WARNING: Should not be set to `true`
with the URL scheme "ldaps://" as "ldaps://" URLs always attempt
to connect using TLS, even when `insecure` is set to `true`
When `true`, "ldap://" URLS connect insecurely. When `false`,
"ldap://" URLs are upgraded to a TLS connection using StartTLS
as specified in https://tools.ietf.org/html/rfc2830.'
type: boolean
url:
description: 'url is an RFC 2255 URL which specifies the LDAP
search parameters to use. The syntax of the URL is: ldap://host:port/basedn?attribute?scope?filter'
type: string
mappingMethod:
description: mappingMethod determines how identities from this
provider are mapped to users Defaults to "claim"
type: string
name:
description: 'name is used to qualify the identities returned
by this provider. - It MUST be unique and not shared by any
other identity provider used - It MUST be a valid path segment:
name cannot equal "." or ".." or contain "/" or "%" or ":" Ref:
https://godoc.org/github.com/openshift/origin/pkg/user/apis/user/validation#ValidateIdentityProviderName'
type: string
openID:
description: openID enables user authentication using OpenID credentials
type: object
properties:
ca:
description: ca is an optional reference to a config map by
name containing the PEM-encoded CA bundle. It is used as
a trust anchor to validate the TLS certificate presented
by the remote server. The key "ca.crt" is used to locate
the data. If specified and the config map or expected key
is not found, the identity provider is not honored. If the
specified ca data is not valid, the identity provider is
not honored. If empty, the default system roots are used.
The namespace for this config map is openshift-config.
type: object
required:
- name
properties:
name:
description: name is the metadata.name of the referenced
config map
type: string
claims:
description: claims mappings
type: object
properties:
email:
description: email is the list of claims whose values
should be used as the email address. Optional. If unspecified,
no email is set for the identity
type: array
items:
type: string
name:
description: name is the list of claims whose values should
be used as the display name. Optional. If unspecified,
no display name is set for the identity
type: array
items:
type: string
preferredUsername:
description: preferredUsername is the list of claims whose
values should be used as the preferred username. If
unspecified, the preferred username is determined from
the value of the sub claim
type: array
items:
type: string
clientID:
description: clientID is the oauth client ID
type: string
clientSecret:
description: clientSecret is a required reference to the secret
by name containing the oauth client secret. The key "clientSecret"
is used to locate the data. If the secret or expected key
is not found, the identity provider is not honored. The
namespace for this secret is openshift-config.
type: object
required:
- name
properties:
name:
description: name is the metadata.name of the referenced
secret
type: string
extraAuthorizeParameters:
description: extraAuthorizeParameters are any custom parameters
to add to the authorize request.
type: object
additionalProperties:
type: string
extraScopes:
description: extraScopes are any scopes to request in addition
to the standard "openid" scope.
type: array
items:
type: string
issuer:
description: issuer is the URL that the OpenID Provider asserts
as its Issuer Identifier. It must use the https scheme with
no query or fragment component.
type: string
requestHeader:
description: requestHeader enables user authentication using request
header credentials
type: object
properties:
ca:
description: ca is a required reference to a config map by
name containing the PEM-encoded CA bundle. It is used as
a trust anchor to validate the TLS certificate presented
by the remote server. Specifically, it allows verification
of incoming requests to prevent header spoofing. The key
"ca.crt" is used to locate the data. If the config map or
expected key is not found, the identity provider is not
honored. If the specified ca data is not valid, the identity
provider is not honored. The namespace for this config map
is openshift-config.
type: object
required:
- name
properties:
name:
description: name is the metadata.name of the referenced
config map
type: string
challengeURL:
description: challengeURL is a URL to redirect unauthenticated
/authorize requests to Unauthenticated requests from OAuth
clients which expect WWW-Authenticate challenges will be
redirected here. ${url} is replaced with the current URL,
escaped to be safe in a query parameter https://www.example.com/sso-login?then=${url}
${query} is replaced with the current query string https://www.example.com/auth-proxy/oauth/authorize?${query}
Required when challenge is set to true.
type: string
clientCommonNames:
description: clientCommonNames is an optional list of common
names to require a match from. If empty, any client certificate
validated against the clientCA bundle is considered authoritative.
type: array
items:
type: string
emailHeaders:
description: emailHeaders is the set of headers to check for
the email address
type: array
items:
type: string
headers:
description: headers is the set of headers to check for identity
information
type: array
items:
type: string
loginURL:
description: loginURL is a URL to redirect unauthenticated
/authorize requests to Unauthenticated requests from OAuth
clients which expect interactive logins will be redirected
here ${url} is replaced with the current URL, escaped to
be safe in a query parameter https://www.example.com/sso-login?then=${url}
${query} is replaced with the current query string https://www.example.com/auth-proxy/oauth/authorize?${query}
Required when login is set to true.
type: string
nameHeaders:
description: nameHeaders is the set of headers to check for
the display name
type: array
items:
type: string
preferredUsernameHeaders:
description: preferredUsernameHeaders is the set of headers
to check for the preferred username
type: array
items:
type: string
type:
description: type identifies the identity provider type for this
entry.
type: string
templates:
description: templates allow you to customize pages like the login page.
type: object
properties:
error:
description: error is the name of a secret that specifies a go template
to use to render error pages during the authentication or grant
flow. The key "errors.html" is used to locate the template data.
If specified and the secret or expected key is not found, the
default error page is used. If the specified template is not valid,
the default error page is used. If unspecified, the default error
page is used. The namespace for this secret is openshift-config.
type: object
required:
- name
properties:
name:
description: name is the metadata.name of the referenced secret
type: string
login:
description: login is the name of a secret that specifies a go template
to use to render the login page. The key "login.html" is used
to locate the template data. If specified and the secret or expected
key is not found, the default login page is used. If the specified
template is not valid, the default login page is used. If unspecified,
the default login page is used. The namespace for this secret
is openshift-config.
type: object
required:
- name
properties:
name:
description: name is the metadata.name of the referenced secret
type: string
providerSelection:
description: providerSelection is the name of a secret that specifies
a go template to use to render the provider selection page. The
key "providers.html" is used to locate the template data. If specified
and the secret or expected key is not found, the default provider
selection page is used. If the specified template is not valid,
the default provider selection page is used. If unspecified, the
default provider selection page is used. The namespace for this
secret is openshift-config.
type: object
required:
- name
properties:
name:
description: name is the metadata.name of the referenced secret
type: string
tokenConfig:
description: tokenConfig contains options for authorization and access
tokens
type: object
properties:
accessTokenInactivityTimeoutSeconds:
description: 'accessTokenInactivityTimeoutSeconds defines the default
token inactivity timeout for tokens granted by any client. The
value represents the maximum amount of time that can occur between
consecutive uses of the token. Tokens become invalid if they are
not used within this temporal window. The user will need to acquire
a new token to regain access once a token times out. Valid values
are integer values: x < 0 Tokens time out is enabled but tokens
never timeout unless configured per client (e.g. `-1`) x = 0 Tokens
time out is disabled (default) x > 0 Tokens time out if there
is no activity for x seconds The current minimum allowed value
for X is 300 (5 minutes)'
type: integer
format: int32
accessTokenMaxAgeSeconds:
description: accessTokenMaxAgeSeconds defines the maximum age of
access tokens
type: integer
format: int32
status:
description: OAuthStatus shows current known state of OAuth server in the
cluster
type: object
|