-
Notifications
You must be signed in to change notification settings - Fork 328
/
types.go
1066 lines (858 loc) · 42.3 KB
/
types.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Tencent is pleased to support the open source community by making TKEStack
* available.
*
* Copyright (C) 2012-2019 Tencent. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use
* this file except in compliance with the License. You may obtain a copy of the
* License at
*
* https://opensource.org/licenses/Apache-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OF ANY KIND, either express or implied. See the License for the
* specific language governing permissions and limitations under the License.
*/
package v1
import (
"fmt"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)
// +genclient
// +genclient:nonNamespaced
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// LocalIdentity is an object that contains the metadata about identify used to
// login to TKE.
type LocalIdentity struct {
metav1.TypeMeta `json:",inline"`
// +optional
metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// Spec defines the desired identities of identity in this set.
// +optional
Spec LocalIdentitySpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"`
// +optional
Status LocalIdentityStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"`
}
// +genclient:nonNamespaced
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// LocalIdentityList is the whole list of all identities.
type LocalIdentityList struct {
metav1.TypeMeta `json:",inline"`
// +optional
metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// List of identities.
Items []LocalIdentity `json:"items" protobuf:"bytes,2,rep,name=items"`
}
type FinalizerName string
const (
// LocalIdentityFinalize is an internal finalizer values to LocalIdentity.
LocalIdentityFinalize FinalizerName = "localidentity"
// PolicyFinalize is an internal finalizer values to Policy.
PolicyFinalize FinalizerName = "policy"
// ProjectPolicyFinalize is an internal finalizer values to ProjectPolicyBinding.
ProjectPolicyFinalize FinalizerName = "projectpolicybinding"
// GroupFinalize is an internal finalizer values to Group.
GroupFinalize FinalizerName = "localgroup"
// RoleFinalize is an internal finalizer values to Role.
RoleFinalize FinalizerName = "role"
// CustomPolicyBindingFinalize is an internal finalizer values to CustomPolicyBinding.
CustomPolicyBindingFinalize FinalizerName = "custompolicybinding"
)
// LocalIdentitySpec is a description of an identity.
type LocalIdentitySpec struct {
Finalizers []FinalizerName `json:"finalizers,omitempty" protobuf:"bytes,11,rep,name=finalizers,casttype=FinalizerName"`
Username string `json:"username" protobuf:"bytes,7,opt,name=name"`
DisplayName string `json:"displayName" protobuf:"bytes,8,opt,name=displayName"`
Email string `json:"email" protobuf:"bytes,9,opt,name=email"`
PhoneNumber string `json:"phoneNumber" protobuf:"bytes,10,opt,name=phone"`
HashedPassword string `json:"hashedPassword,omitempty" protobuf:"bytes,4,opt,name=hashedPassword"`
// +optional
TenantID string `json:"tenantID,omitempty" protobuf:"bytes,2,opt,name=tenantID"`
Groups []string `json:"groups,omitempty" protobuf:"bytes,6,rep,name=groups"`
// +optional
Extra map[string]string `json:"extra,omitempty" protobuf:"bytes,3,rep,name=extra"`
}
// LocalIdentityPhase defines the phase of LocalIdentity construct.
type LocalIdentityPhase string
const (
// LocalIdentityDeleting means the local identity is undergoing graceful termination.
LocalIdentityDeleting LocalIdentityPhase = "Deleting"
)
// LocalIdentityStatus is a description of an identity status.
type LocalIdentityStatus struct {
Phase LocalIdentityPhase `json:"phase,omitempty" protobuf:"bytes,3,opt,name=phase,casttype=LocalIdentityPhase"`
// +optional
Locked bool `json:"locked,omitempty" protobuf:"varint,1,opt,name=locked"`
// The last time the local identity was updated.
// +optional
LastUpdateTime metav1.Time `json:"lastUpdateTime" protobuf:"bytes,2,opt,name=lastUpdateTime"`
}
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// PasswordReq contains info to update password for a localIdentity
type PasswordReq struct {
metav1.TypeMeta `json:",inline"`
HashedPassword string `json:"hashedPassword,omitempty" protobuf:"bytes,1,opt,name=hashedPassword"`
OriginalPassword string `json:"originalPassword,omitempty" protobuf:"bytes,2,opt,name=originalPassword"`
}
// +genclient
// +genclient:nonNamespaced
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// LocalGroup represents a group of users.
type LocalGroup struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// Spec defines the desired identities of group document in this set.
Spec LocalGroupSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"`
// +optional
Status LocalGroupStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"`
}
// +genclient:nonNamespaced
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// LocalGroupList is the whole list of all groups.
type LocalGroupList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// List of LocalGroup.
Items []LocalGroup `json:"items" protobuf:"bytes,2,rep,name=items"`
}
// GroupPhase defines the phase of group constructor.
type GroupPhase string
const (
GroupActive GroupPhase = "Active"
// GroupTerminating means the group is undergoing graceful termination.
GroupTerminating GroupPhase = "Terminating"
)
// LocalGroupSpec is a description of group.
type LocalGroupSpec struct {
Finalizers []FinalizerName `json:"finalizers,omitempty" protobuf:"bytes,1,rep,name=finalizers,casttype=FinalizerName"`
DisplayName string `json:"displayName" protobuf:"bytes,2,opt,name=displayName"`
TenantID string `json:"tenantID" protobuf:"bytes,3,opt,name=tenantID"`
Username string `json:"username" protobuf:"bytes,4,opt,name=username"`
Description string `json:"description" protobuf:"bytes,5,opt,name=description"`
Extra map[string]string `json:"extra" protobuf:"bytes,6,rep,name=extra"`
}
// LocalGroupStatus represents information about the status of a group.
type LocalGroupStatus struct {
// +optional
Phase GroupPhase `json:"phase,omitempty" protobuf:"bytes,1,opt,name=phase,casttype=GroupPhase"`
// Users represents the members of the group.
Users []Subject `json:"users" protobuf:"bytes,2,rep,name=users"`
}
// +genclient
// +genclient:nonNamespaced
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// User is an object that contains the metadata about identify about tke local idp or third-party idp.
type User struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// Spec defines the desired identities of identity in this set.
Spec UserSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"`
}
// UserSpec is a description of an user.
type UserSpec struct {
ID string `json:"id" protobuf:"bytes,1,opt,name=id"`
// Name must be unique in the same tenant.
Name string `json:"name" protobuf:"bytes,2,opt,name=name"`
DisplayName string `json:"displayName,omitempty" protobuf:"bytes,3,opt,name=displayName"`
Email string `json:"email,omitempty" protobuf:"bytes,4,opt,name=email"`
PhoneNumber string `json:"phoneNumber,omitempty" protobuf:"bytes,5,opt,name=phoneNumber"`
TenantID string `json:"tenantID,omitempty" protobuf:"bytes,6,opt,name=tenantID"`
Extra map[string]string `json:"extra,omitempty" protobuf:"bytes,7,rep,name=extra"`
}
// +genclient:nonNamespaced
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// UserList is the whole list of all users.
type UserList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// List of User.
Items []User `json:"items" protobuf:"bytes,2,rep,name=items"`
}
// +genclient
// +genclient:nonNamespaced
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// Group is an object that contains the metadata about identify about tke local idp or third-party idp.
type Group struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// Spec defines the desired identities of group in this set.
Spec GroupSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"`
Status GroupStatus `json:"status" protobuf:"bytes,3,opt,name=status"`
}
// GroupSpec is a description of a Group.
type GroupSpec struct {
ID string `json:"id" protobuf:"bytes,1,opt,name=id"`
DisplayName string `json:"displayName" protobuf:"bytes,2,opt,name=displayName"`
TenantID string `json:"tenantID" protobuf:"bytes,3,opt,name=tenantID"`
Description string `json:"description" protobuf:"bytes,4,opt,name=description"`
Extra map[string]string `json:"extra" protobuf:"bytes,5,rep,name=extra"`
}
// GroupStatus represents information about the status of a group.
type GroupStatus struct {
// Users represents the members of the group.
Users []Subject `json:"users" protobuf:"bytes,2,rep,name=users"`
}
// +genclient:nonNamespaced
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// GroupList is the whole list of all groups.
type GroupList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// List of Group.
Items []Group `json:"items" protobuf:"bytes,2,rep,name=items"`
}
// +genclient
// +genclient:nonNamespaced
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// APIKey contains expiration time used to apply the api key.
type APIKey struct {
metav1.TypeMeta `json:",inline"`
// +optional
metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=objectMeta"`
// Spec defines the desired identities of APIkey in this set.
Spec APIKeySpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"`
Status APIKeyStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"`
}
// +genclient:nonNamespaced
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// APIKeyList is the whole list of all identities.
type APIKeyList struct {
metav1.TypeMeta `json:",inline"`
// +optional
metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=listMeta"`
// List of api keys.
Items []APIKey `json:"items" protobuf:"bytes,2,rep,name=items"`
}
// APIKeySpec is a description of an apiKey.
type APIKeySpec struct {
// APIkey is the jwt token used to authenticate user, and contains user info and sign.
APIkey string `json:"apiKey,omitempty" protobuf:"bytes,1,opt,name=apiKey"`
TenantID string `json:"tenantID,omitempty" protobuf:"bytes,5,opt,name=tenantID"`
// Username is creator
// +optional
Username string `json:"username,omitempty" protobuf:"bytes,6,opt,name=username"`
// Description describes api keys usage.
// +optional
Description string `json:"description" protobuf:"bytes,2,opt,name=description"`
// IssueAt is the created time for api key
IssueAt metav1.Time `json:"issue_at,omitempty" protobuf:"bytes,3,opt,name=issue_at,json=issueAt"`
// ExpireAt is the expire time for api key
ExpireAt metav1.Time `json:"expire_at,omitempty" protobuf:"bytes,4,opt,name=expire_at,json=expireAt"`
}
// APIKeyStatus is a description of an api key status.
type APIKeyStatus struct {
// Disabled represents whether the apikey has been disabled.
// +optional
Disabled bool `json:"disabled" protobuf:"varint,1,opt,name=disabled"`
// Expired represents whether the apikey has been expired.
Expired bool `json:"expired" protobuf:"varint,2,opt,name=expired"`
}
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// APIKeyReq contains expiration time used to apply the api key.
type APIKeyReq struct {
metav1.TypeMeta `json:",inline"`
// Expire is required, holds the duration of the api key become invalid. By default, 168h(= seven days)
// +optional
Expire metav1.Duration `json:"expire,omitempty" protobuf:"bytes,2,opt,name=expire"`
// Description describes api keys usage.
Description string `json:"description" protobuf:"bytes,3,opt,name=description"`
}
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// APIKeyReqPassword contains userinfo and expiration time used to apply the api key.
type APIKeyReqPassword struct {
metav1.TypeMeta `json:",inline"`
// TenantID for user
TenantID string `json:"tenantID,omitempty" protobuf:"bytes,2,opt,name=tenantID"`
// Username
Username string `json:"username,omitempty" protobuf:"bytes,3,opt,name=username"`
// Password (encoded by base64)
Password string `json:"password,omitempty" protobuf:"bytes,4,opt,name=password"`
// Description describes api keys usage.
// +optional
Description string `json:"description" protobuf:"bytes,5,opt,name=description"`
// Expire holds the duration of the api key become invalid. By default, 168h(= seven days)
// +optional
Expire metav1.Duration `json:"expire,omitempty" protobuf:"bytes,6,opt,name=expire"`
}
// +genclient
// +genclient:nonNamespaced
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// APISigningKey hold encryption and signing key.
type APISigningKey struct {
metav1.TypeMeta `json:",inline"`
// +optional
metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// +optional
SigningKey []byte `json:"signingKey,omitempty" protobuf:"bytes,2,opt,name=signingKey"`
// +optional
SigningKeyPub []byte `json:"signingKeyPub,omitempty" protobuf:"bytes,3,opt,name=signingKeyPub"`
}
// +genclient:nonNamespaced
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// APISigningKeyList is the whole list of all signing key.
type APISigningKeyList struct {
metav1.TypeMeta `json:",inline"`
// +optional
metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// List of keys.
Items []APISigningKey `json:"items" protobuf:"bytes,2,rep,name=items"`
}
// +genclient
// +genclient:nonNamespaced
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// Category defines a category of actions for policy.
type Category struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
Spec CategorySpec `protobuf:"bytes,2,opt,name=spec"`
}
// CategorySpec is a description of category.
type CategorySpec struct {
// DisplayName used to display category name
DisplayName string `json:"displayName" protobuf:"bytes,2,opt,name=displayName"`
// +optional
Description string `json:"description" protobuf:"bytes,3,opt,name=description"`
// Actions represents a series of actions work on the policy category
Actions []Action `json:"actions" protobuf:"bytes,4,rep,name=actions"`
}
// Action defines a action verb for authorization.
type Action struct {
// Name represents user access review request verb.
Name string `json:"name" protobuf:"bytes,1,opt,name=name"`
// Description describes the action.
Description string `json:"description" protobuf:"bytes,2,opt,name=description"`
}
// +genclient:nonNamespaced
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// CategoryList is the whole list of policy Category.
type CategoryList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// List of category.
Items []Category `json:"items" protobuf:"bytes,2,rep,name=items"`
}
// PolicyPhase defines the phase of policy constructor.
type PolicyPhase string
const (
// PolicyActive indicates the policy is active.
PolicyActive PolicyPhase = "Active"
// PolicyTerminating means the policy is undergoing graceful termination.
PolicyTerminating PolicyPhase = "Terminating"
)
// +genclient
// +genclient:nonNamespaced
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// Policy represents a policy document for access control.
type Policy struct {
metav1.TypeMeta `json:",inline"`
// +optional
metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// Spec defines the desired identities of policy document in this set.
// +optional
Spec PolicySpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"`
// +optional
Status PolicyStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"`
}
// +genclient:nonNamespaced
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// PolicyList is the whole list of all policies.
type PolicyList struct {
metav1.TypeMeta `json:",inline"`
// +optional
metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// List of policies.
Items []Policy `json:"items" protobuf:"bytes,2,rep,name=items"`
}
// Effect defines the policy effect.
type Effect string
const (
// Allow is the allow type.
Allow Effect = "allow"
// Deny is the deny type.
Deny Effect = "deny"
)
// PolicyType defines the policy is default or created by user.
type PolicyType string
const (
PolicyCustom PolicyType = "custom"
PolicyDefault PolicyType = "default"
)
// PolicyScope defines the policy is belong to platform or project.
type PolicyScope string
const (
PolicyPlatform PolicyScope = "platform"
PolicyProject PolicyScope = "project"
)
// PolicySpec is a description of a policy.
type PolicySpec struct {
Finalizers []FinalizerName `json:"finalizers,omitempty" protobuf:"bytes,8,rep,name=finalizers,casttype=FinalizerName"`
DisplayName string `json:"displayName" protobuf:"bytes,7,opt,name=displayName"`
TenantID string `json:"tenantID" protobuf:"bytes,1,opt,name=tenantID"`
Category string `json:"category" protobuf:"bytes,9,opt,name=category"`
Type PolicyType `json:"type" protobuf:"varint,10,opt,name=type,casttype=PolicyType"`
Scope PolicyScope `json:"scope" protobuf:"bytes,11,opt,name=scope,casttype=PolicyScope"`
Username string `json:"username" protobuf:"bytes,2,opt,name=username"`
// +optional
Description string `json:"description" protobuf:"bytes,3,opt,name=description"`
Statement Statement `json:"statement" protobuf:"bytes,5,rep,name=statement"`
// +optional
Conditions []byte `json:"conditions,omitempty" protobuf:"bytes,6,rep,name=conditions"`
}
// Statement defines a series of action on resource can be done or not.
type Statement struct {
Actions []string `json:"actions" protobuf:"bytes,1,rep,name=actions"`
Resources []string `json:"resources" protobuf:"bytes,2,rep,name=resources"`
// Effect indicates action on the resource is allowed or not, can be "allow" or "deny"
Effect Effect `json:"effect" protobuf:"bytes,3,opt,name=effect,casttype=Effect"`
}
// PolicyStatus represents information about the status of a policy.
type PolicyStatus struct {
// +optional
Phase PolicyPhase `json:"phase" protobuf:"bytes,1,opt,name=phase,casttype=PolicyPhase"`
// +optional
// Users represents the users the policy applies to.
Users []Subject `json:"users" protobuf:"bytes,2,rep,name=users"`
// +optional
// Groups represents the groups the policy applies to.
Groups []Subject `json:"groups" protobuf:"bytes,3,rep,name=groups"`
}
// +genclient
// +genclient:nonNamespaced
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// ProjectPolicyBinding is a collection of subjects bond to policies in a project scope.
type ProjectPolicyBinding struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
Spec ProjectPolicyBindingSpec `json:"spec" protobuf:"bytes,2,opt,name=spec"`
Status ProjectPolicyBindingStatus `protobuf:"bytes,3,opt,name=status"`
}
// ProjectPolicyBindingSpec defines the desired identities of ProjectPolicyBindingSpec document in this set.
type ProjectPolicyBindingSpec struct {
// Spec defines the desired identities of role document in this set.
Finalizers []FinalizerName `json:"finalizers,omitempty" protobuf:"bytes,1,rep,name=finalizers,casttype=FinalizerName"`
TenantID string `json:"tenantID" protobuf:"bytes,2,opt,name=tenantID"`
ProjectID string `json:"projectID" protobuf:"bytes,3,opt,name=projectID"`
PolicyID string `json:"policyID" protobuf:"bytes,4,opt,name=policyID"`
Users []Subject `json:"users" protobuf:"bytes,5,rep,name=users"`
Groups []Subject `json:"groups" protobuf:"bytes,6,rep,name=groups"`
}
// BindingPhase defines the phase of ProjectPolicyBinding constructor.
type BindingPhase string
const (
BindingActive BindingPhase = "Active"
// RoleTerminating means the role is undergoing graceful termination.
BindingTerminating BindingPhase = "Terminating"
)
// ProjectPolicyBindingStatus represents information about the status of a ProjectPolicyBinding.
type ProjectPolicyBindingStatus struct {
Phase BindingPhase `json:"phase" protobuf:"bytes,1,opt,name=phase,casttype=BindingPhase"`
}
// +genclient:nonNamespaced
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// ProjectPolicyBindingList is the whole list of all ProjectPolicyBindings.
type ProjectPolicyBindingList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// List of policies.
Items []ProjectPolicyBinding `json:"items" protobuf:"bytes,2,rep,name=items"`
}
// +genclient
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// CustomPolicyBinding is a collection of subjects bond to policies in a custom scope.
type CustomPolicyBinding struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
Spec CustomPolicyBindingSpec `json:"spec" protobuf:"bytes,2,opt,name=spec"`
Status CustomPolicyBindingStatus `protobuf:"bytes,3,opt,name=status"`
}
// CustomPolicyBindingSpec defines the desired identities of CustomPolicyBindingSpec document in this set.
type CustomPolicyBindingSpec struct {
Finalizers []FinalizerName `json:"finalizers,omitempty" protobuf:"bytes,1,rep,name=finalizers,casttype=FinalizerName"`
TenantID string `json:"tenantID" protobuf:"bytes,2,opt,name=tenantID"`
Domain string `json:"domain" protobuf:"bytes,3,opt,name=domain"`
LastDomain string `json:"lastDomain" protobuf:"bytes,4,opt,name=lastDomain"`
PolicyID string `json:"policyID" protobuf:"bytes,5,opt,name=policyID"`
Resources []string `json:"resources" protobuf:"bytes,6,opt,name=resources"`
RulePrefix string `json:"rulePrefix" protobuf:"bytes,7,opt,name=rulePrefix"`
Users []Subject `json:"users" protobuf:"bytes,8,rep,name=users"`
Groups []Subject `json:"groups" protobuf:"bytes,9,rep,name=groups"`
}
// CustomPolicyBindingStatus represents information about the status of a CustomPolicyBinding.
type CustomPolicyBindingStatus struct {
Phase BindingPhase `json:"phase" protobuf:"bytes,1,opt,name=phase,casttype=BindingPhase"`
}
// +genclient:nonNamespaced
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// CustomPolicyBindingList is the whole list of all CustomPolicyBindings.
type CustomPolicyBindingList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// List of CustomPolicyBinding.
Items []CustomPolicyBinding `json:"items" protobuf:"bytes,2,rep,name=items"`
}
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// ProjectPolicyBindingRequest references the request to bind or unbind policies to the role.
type ProjectPolicyBindingRequest struct {
metav1.TypeMeta `json:",inline"`
TenantID string `json:"tenantID,omitempty" protobuf:"bytes,1,rep,name=tenantID"`
// Policies holds the policies will bind to the subjects.
// +optional
Policies []string `json:"policies,omitempty" protobuf:"bytes,2,rep,name=policies"`
Users []Subject `json:"users" protobuf:"bytes,3,rep,name=users"`
Groups []Subject `json:"groups" protobuf:"bytes,4,rep,name=groups"`
}
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// ProjectBelongs contains projects of user belongs.
type ProjectBelongs struct {
metav1.TypeMeta `json:",inline"`
TenantID string `json:"tenantID" protobuf:"bytes,1,opt,name=tenantID"`
ManagedProjects map[string]ExtraValue `json:"managedProjects" protobuf:"bytes,2,rep,name=managedProjects"`
MemberdProjects map[string]ExtraValue `json:"memberdProjects" protobuf:"bytes,3,rep,name=memberdProjects"`
}
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// Project contains members of projects.
type Project struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,4,opt,name=metadata"`
TenantID string `json:"tenantID" protobuf:"bytes,1,opt,name=tenantID"`
Users map[string]string `json:"members" protobuf:"bytes,2,rep,name=members"`
Groups map[string]string `json:"groups" protobuf:"bytes,3,rep,name=groups"`
}
// +genclient:nonNamespaced
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// ProjectList is the whole list of all projects.
type ProjectList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// List of projects.
Items []Project `json:"items" protobuf:"bytes,2,rep,name=items"`
}
// +genclient
// +genclient:nonNamespaced
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// Rule represents a rule document for access control.
type Rule struct {
metav1.TypeMeta `json:",inline"`
// +optional
metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// Spec defines the desired identities of policy document in this set.
Spec RuleSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"`
}
// +genclient:nonNamespaced
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// RuleList is the whole list of all rules.
type RuleList struct {
metav1.TypeMeta `json:",inline"`
// +optional
metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// List of rules.
Items []Rule `json:"items" protobuf:"bytes,2,rep,name=items"`
}
// RuleSpec is a description of a rule.
type RuleSpec struct {
PType string `json:"ptype" protobuf:"bytes,1,opt,name=ptype"`
V0 string `json:"v0" protobuf:"bytes,2,opt,name=v0"`
V1 string `json:"v1" protobuf:"bytes,3,opt,name=v1"`
V2 string `json:"v2" protobuf:"bytes,4,opt,name=v2"`
V3 string `json:"v3" protobuf:"bytes,5,opt,name=v3"`
V4 string `json:"v4" protobuf:"bytes,6,opt,name=v4"`
V5 string `json:"v5" protobuf:"bytes,7,opt,name=v5"`
V6 string `json:"v6" protobuf:"bytes,8,opt,name=v6"`
}
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// Binding is used to bind or unbind the subjects to or from the policy,role or group.
type Binding struct {
metav1.TypeMeta `json:",inline"`
// Users holds references to the objects the policy applies to.
// +optional
Users []Subject `json:"users, omitempty" protobuf:"bytes,1,rep,name=users"`
// Groups holds references to the groups the policy applies to.
// +optional
Groups []Subject `json:"groups,omitempty" protobuf:"bytes,2,rep,name=groups"`
}
// Subject references a user can specify by id or name.
type Subject struct {
ID string `json:"id" protobuf:"bytes,1,opt,name=id"`
Name string `json:"name" protobuf:"bytes,2,opt,name=name"`
}
// +genclient
// +genclient:nonNamespaced
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// Role is a collection with multiple policies.
type Role struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// Spec defines the desired identities of role document in this set.
Spec RoleSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"`
// +optional
Status RoleStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"`
}
// +genclient:nonNamespaced
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// RoleList is the whole list of policy.
type RoleList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// List of rules.
Items []Role `json:"items" protobuf:"bytes,2,rep,name=items"`
}
// RolePhase defines the phase of role constructor.
type RolePhase string
const (
RoleActive RolePhase = "Active"
// RoleTerminating means the role is undergoing graceful termination.
RoleTerminating RolePhase = "Terminating"
)
// RoleSpec is a description of role.
type RoleSpec struct {
Finalizers []FinalizerName `json:"finalizers,omitempty" protobuf:"bytes,1,rep,name=finalizers,casttype=FinalizerName"`
DisplayName string `json:"displayName" protobuf:"bytes,2,opt,name=displayName"`
TenantID string `json:"tenantID" protobuf:"bytes,3,opt,name=tenantID"`
ProjectID string `json:"projectID" protobuf:"bytes,7,opt,name=projectID"`
// Username is Creator
Username string `json:"username" protobuf:"bytes,4,opt,name=username"`
Description string `json:"description" protobuf:"bytes,5,opt,name=description"`
Policies []string `json:"policies" protobuf:"bytes,6,rep,name=policies"`
}
// RoleStatus represents information about the status of a role.
type RoleStatus struct {
// +optional
Phase RolePhase `json:"phase" protobuf:"bytes,1,opt,name=phase,casttype=RolePhase"`
// +optional
// Users represents the users the role applies to.
Users []Subject `json:"users" protobuf:"bytes,2,rep,name=users"`
// +optional
// Groups represents the groups the role applies to.
Groups []Subject `json:"groups" protobuf:"bytes,3,rep,name=groups"`
}
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// PolicyBinding references the request to bind or unbind policies to the role.
type PolicyBinding struct {
metav1.TypeMeta `json:",inline"`
// Policies holds the policies will bind or unbind to the role.
// +optional
Policies []string `json:"policies" protobuf:"bytes,1,rep,name=policies"`
}
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// SubjectAccessReview checks whether or not a user or group can perform an action. Not filling in a
// spec.namespace means "in all namespaces".
type SubjectAccessReview struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// Spec holds information about the request being evaluated
Spec SubjectAccessReviewSpec `json:"spec" protobuf:"bytes,2,opt,name=spec"`
// Status is filled in by the server and indicates whether the request is allowed or not
Status SubjectAccessReviewStatus `json:"status,omitempty" protobuf:"bytes,3,opt,name=status"`
}
// SubjectAccessReviewSpec is a description of the access request. Exactly one of ResourceAttributes
// and NonResourceAttributes must be set
type SubjectAccessReviewSpec struct {
// ResourceAttributes describes information for a resource access request
ResourceAttributes *ResourceAttributes `json:"resourceAttributes,omitempty" protobuf:"bytes,7,opt,name=resourceAttributes"`
// ResourceAttributesList describes information for multi resource access request.
ResourceAttributesList []*ResourceAttributes `json:"resourceAttributesList,omitempty" protobuf:"bytes,8,rep,name=resourceAttributesList"`
// NonResourceAttributes describes information for a non-resource access request
NonResourceAttributes *NonResourceAttributes `json:"nonResourceAttributes,omitempty" protobuf:"bytes,9,opt,name=nonResourceAttributes"`
// User is the user you're testing for.
// If you specify "User" but not "Groups", then is it interpreted as "What if User were not a member of any groups
// +optional
User string `json:"user,omitempty" protobuf:"bytes,3,opt,name=user"`
// Groups is the groups you're testing for.
// +optional
Groups []string `json:"group,omitempty" protobuf:"bytes,4,rep,name=group"`
// Extra corresponds to the user.Info.GetExtra() method from the authenticator. Since that is input to the authorizer
// it needs a reflection here.
// +optional
Extra map[string]ExtraValue `json:"extra,omitempty" protobuf:"bytes,5,rep,name=extra"`
// UID information about the requesting user.
// +optional
UID string `json:"uid,omitempty" protobuf:"bytes,6,opt,name=uid"`
}
// ExtraValue masks the value so protobuf can generate
// +protobuf.nullable=true
// +protobuf.options.(gogoproto.goproto_stringer)=false
type ExtraValue []string
func (t ExtraValue) String() string {
return fmt.Sprintf("%v", []string(t))
}
// ResourceAttributes includes the authorization attributes available for resource requests to the Authorizer interface
type ResourceAttributes struct {
// Namespace is the namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces
// "" (empty) is defaulted for LocalSubjectAccessReviews
// "" (empty) is empty for cluster-scoped resources
// "" (empty) means "all" for namespace scoped resources from a SubjectAccessReview or SelfSubjectAccessReview
// +optional
Namespace string `json:"namespace,omitempty" protobuf:"bytes,1,opt,name=namespace"`
// Verb is a kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. "*" means all.
// +optional
Verb string `json:"verb,omitempty" protobuf:"bytes,2,opt,name=verb"`
// Group is the API Group of the Resource. "*" means all.
// +optional
Group string `json:"group,omitempty" protobuf:"bytes,3,opt,name=group"`
// Version is the API Version of the Resource. "*" means all.
// +optional
Version string `json:"version,omitempty" protobuf:"bytes,4,opt,name=version"`
// Resource is one of the existing resource types. "*" means all.
// +optional
Resource string `json:"resource,omitempty" protobuf:"bytes,5,opt,name=resource"`
// Subresource is one of the existing resource types. "" means none.
// +optional
Subresource string `json:"subresource,omitempty" protobuf:"bytes,6,opt,name=subresource"`
// Name is the name of the resource being requested for a "get" or deleted for a "delete". "" (empty) means all.
// +optional
Name string `json:"name,omitempty" protobuf:"bytes,7,opt,name=name"`
}
// NonResourceAttributes includes the authorization attributes available for non-resource requests to the Authorizer interface
type NonResourceAttributes struct {
// Path is the URL path of the request
// +optional
Path string `json:"path,omitempty" protobuf:"bytes,1,opt,name=path"`
// Verb is the standard HTTP verb
// +optional
Verb string `json:"verb,omitempty" protobuf:"bytes,2,opt,name=verb"`
}
// SubjectAccessReviewStatus represents the current state of a SubjectAccessReview.
type SubjectAccessReviewStatus struct {
// Allowed is required. True if the action would be allowed, false otherwise.
Allowed bool `json:"allowed" protobuf:"varint,1,opt,name=allowed"`
// Denied is optional. True if the action would be denied, otherwise
// false. If both allowed is false and denied is false, then the
// authorizer has no opinion on whether to authorize the action. Denied
// may not be true if Allowed is true.
// +optional
Denied bool `json:"denied,omitempty" protobuf:"varint,4,opt,name=denied"`
// Reason is optional. It indicates why a request was allowed or denied.
// +optional
Reason string `json:"reason,omitempty" protobuf:"bytes,2,opt,name=reason"`
// EvaluationError is an indication that some error occurred during the authorization check.
// It is entirely possible to get an error and be able to continue determine authorization status in spite of it.
// For instance, RBAC can be missing a role, but enough roles are still present and bound to reason about the request.
// +optional
EvaluationError string `json:"evaluationError,omitempty" protobuf:"bytes,3,opt,name=evaluationError"`
// AllowedList is the allowed response for batch authorization request.
AllowedList []*AllowedStatus `json:"allowedList,omitempty" protobuf:"bytes,5,rep,name=allowedList"`
}
// AllowedStatus includes the resource access request and response.
// +k8s:openapi-gen=true
type AllowedStatus struct {
// Resource is the resource of request
Resource string `json:"resource" protobuf:"bytes,1,opt,name=resource"`
// Verb is the verb of request
Verb string `json:"web" protobuf:"bytes,2,opt,name=web"`
// Allowed is required. True if the action would be allowed, false otherwise.
Allowed bool `json:"allowed" protobuf:"varint,3,opt,name=allowed"`
// Denied is optional. True if the action would be denied, otherwise
// false. If both allowed is false and denied is false, then the
// authorizer has no opinion on whether to authorize the action. Denied
// may not be true if Allowed is true.
Denied bool `json:"denied,omitempty" protobuf:"varint,4,opt,name=denied"`
// Reason is optional. It indicates why a request was allowed or denied.
Reason string `json:"reason,omitempty" protobuf:"bytes,5,opt,name=reason"`
// EvaluationError is an indication that some error occurred during the authorization check.
// It is entirely possible to get an error and be able to continue determine authorization status in spite of it.
// For instance, RBAC can be missing a role, but enough roles are still present and bound to reason about the request.
EvaluationError string `json:"evaluationError,omitempty" protobuf:"bytes,6,opt,name=evaluationError"`
}
// +genclient
// +genclient:nonNamespaced
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// IdentityProvider is an object that contains the metadata about identify
// provider used to login to TKE.
type IdentityProvider struct {
metav1.TypeMeta `json:",inline"`
// +optional
metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// Spec defines the desired identities of identity provider in this set.
Spec IdentityProviderSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"`
}
// +genclient:nonNamespaced
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// IdentityProviderList is the whole list of all identity providers.
type IdentityProviderList struct {
metav1.TypeMeta `json:",inline"`
// +optional
metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// List of identity providers.
Items []IdentityProvider `json:"items" protobuf:"bytes,2,rep,name=items"`
}
// IdentityProviderSpec is a description of an identity provider.
type IdentityProviderSpec struct {
// The Name of the connector that is used when displaying it to the end user.
Name string `json:"name" protobuf:"bytes,1,opt,name=name"`
// The type of the connector. E.g. 'oidc' or 'ldap'
Type string `json:"type" protobuf:"bytes,2,opt,name=type"`
// The administrators means the users is super admin for the idp.
Administrators []string `json:"administrators" protobuf:"bytes,3,opt,name=administrators"`
// Config holds all the configuration information specific to the connector type. Since there
// no generic struct we can use for this purpose, it is stored as a json string.
Config string `json:"config" protobuf:"bytes,4,opt,name=config"`
}
// +genclient
// +genclient:nonNamespaced
// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// Client represents an OAuth2 client.
type Client struct {
metav1.TypeMeta `json:",inline"`
// +optional
metav1.ObjectMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`
// Spec defines the desired identities of identity provider in this set.
Spec ClientSpec `json:"spec,omitempty" protobuf:"bytes,2,opt,name=spec"`
}