/
service.go
2928 lines (2569 loc) · 96.5 KB
/
service.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
package gaia
import (
"fmt"
"time"
"github.com/mitchellh/copystructure"
"go.aporeto.io/elemental"
)
// ServiceTLSTypeValue represents the possible values for attribute "TLSType".
type ServiceTLSTypeValue string
const (
// ServiceTLSTypeAporeto represents the value Aporeto.
ServiceTLSTypeAporeto ServiceTLSTypeValue = "Aporeto"
// ServiceTLSTypeExternal represents the value External.
ServiceTLSTypeExternal ServiceTLSTypeValue = "External"
// ServiceTLSTypeLetsEncrypt represents the value LetsEncrypt.
ServiceTLSTypeLetsEncrypt ServiceTLSTypeValue = "LetsEncrypt"
// ServiceTLSTypeNone represents the value None.
ServiceTLSTypeNone ServiceTLSTypeValue = "None"
)
// ServiceAuthorizationTypeValue represents the possible values for attribute "authorizationType".
type ServiceAuthorizationTypeValue string
const (
// ServiceAuthorizationTypeJWT represents the value JWT.
ServiceAuthorizationTypeJWT ServiceAuthorizationTypeValue = "JWT"
// ServiceAuthorizationTypeMTLS represents the value MTLS.
ServiceAuthorizationTypeMTLS ServiceAuthorizationTypeValue = "MTLS"
// ServiceAuthorizationTypeNone represents the value None.
ServiceAuthorizationTypeNone ServiceAuthorizationTypeValue = "None"
// ServiceAuthorizationTypeOIDC represents the value OIDC.
ServiceAuthorizationTypeOIDC ServiceAuthorizationTypeValue = "OIDC"
)
// ServiceTypeValue represents the possible values for attribute "type".
type ServiceTypeValue string
const (
// ServiceTypeHTTP represents the value HTTP.
ServiceTypeHTTP ServiceTypeValue = "HTTP"
// ServiceTypeKubernetesSecrets represents the value KubernetesSecrets.
ServiceTypeKubernetesSecrets ServiceTypeValue = "KubernetesSecrets"
// ServiceTypeTCP represents the value TCP.
ServiceTypeTCP ServiceTypeValue = "TCP"
// ServiceTypeVaultSecrets represents the value VaultSecrets.
ServiceTypeVaultSecrets ServiceTypeValue = "VaultSecrets"
)
// ServiceIdentity represents the Identity of the object.
var ServiceIdentity = elemental.Identity{
Name: "service",
Category: "services",
Package: "squall",
Private: false,
}
// ServicesList represents a list of Services
type ServicesList []*Service
// Identity returns the identity of the objects in the list.
func (o ServicesList) Identity() elemental.Identity {
return ServiceIdentity
}
// Copy returns a pointer to a copy the ServicesList.
func (o ServicesList) Copy() elemental.Identifiables {
copy := append(ServicesList{}, o...)
return ©
}
// Append appends the objects to the a new copy of the ServicesList.
func (o ServicesList) Append(objects ...elemental.Identifiable) elemental.Identifiables {
out := append(ServicesList{}, o...)
for _, obj := range objects {
out = append(out, obj.(*Service))
}
return out
}
// List converts the object to an elemental.IdentifiablesList.
func (o ServicesList) List() elemental.IdentifiablesList {
out := make(elemental.IdentifiablesList, len(o))
for i := 0; i < len(o); i++ {
out[i] = o[i]
}
return out
}
// DefaultOrder returns the default ordering fields of the content.
func (o ServicesList) DefaultOrder() []string {
return []string{
"namespace",
"name",
}
}
// ToSparse returns the ServicesList converted to SparseServicesList.
// Objects in the list will only contain the given fields. No field means entire field set.
func (o ServicesList) ToSparse(fields ...string) elemental.Identifiables {
out := make(SparseServicesList, len(o))
for i := 0; i < len(o); i++ {
out[i] = o[i].ToSparse(fields...).(*SparseService)
}
return out
}
// Version returns the version of the content.
func (o ServicesList) Version() int {
return 1
}
// Service represents the model of a service
type Service struct {
// Identifier of the object.
ID string `json:"ID" msgpack:"ID" bson:"_id" mapstructure:"ID,omitempty"`
// The list of IP addresses where the service can be accessed. This is an optional
// attribute and
// is only required if no host names are provided. The system will automatically
// resolve IP
// addresses from host names otherwise.
IPs []string `json:"IPs" msgpack:"IPs" bson:"ips" mapstructure:"IPs,omitempty"`
// PEM-encoded certificate that will be used to validate the user's JSON web token
// (JWT)
// in HTTP requests. This is an optional field, needed only if the
// `authorizationType`
// is set to `JWT`.
JWTSigningCertificate string `json:"JWTSigningCertificate" msgpack:"JWTSigningCertificate" bson:"jwtsigningcertificate" mapstructure:"JWTSigningCertificate,omitempty"`
// PEM-encoded certificate authority to use to verify client certificates. This
// only applies
// if `authorizationType` is set to `MTLS`. If it is not set, Aporeto's public
// signing
// certificate authority will be used.
MTLSCertificateAuthority string `json:"MTLSCertificateAuthority" msgpack:"MTLSCertificateAuthority" bson:"mtlscertificateauthority" mapstructure:"MTLSCertificateAuthority,omitempty"`
// This is an advanced setting. Optional OIDC callback URL. If you don't set it,
// Aporeto will autodiscover it. It will be
// `https://<hosts[0]|IPs[0]>/.aporeto/oidc/callback`.
OIDCCallbackURL string `json:"OIDCCallbackURL" msgpack:"OIDCCallbackURL" bson:"oidccallbackurl" mapstructure:"OIDCCallbackURL,omitempty"`
// OIDC Client ID. Only has effect if the `authorizationType` is set to `OIDC`.
OIDCClientID string `json:"OIDCClientID" msgpack:"OIDCClientID" bson:"oidcclientid" mapstructure:"OIDCClientID,omitempty"`
// OIDC Client Secret. Only has effect if the `authorizationType` is set to `OIDC`.
OIDCClientSecret string `json:"OIDCClientSecret" msgpack:"OIDCClientSecret" bson:"oidcclientsecret" mapstructure:"OIDCClientSecret,omitempty"`
// OIDC discovery endpoint. Only has effect if the `authorizationType`
// is set to `OIDC`.
OIDCProviderURL string `json:"OIDCProviderURL" msgpack:"OIDCProviderURL" bson:"oidcproviderurl" mapstructure:"OIDCProviderURL,omitempty"`
// Configures the scopes you want to request from the OIDC provider. Only has
// effect
// if `authorizationType` is set to `OIDC`.
OIDCScopes []string `json:"OIDCScopes" msgpack:"OIDCScopes" bson:"oidcscopes" mapstructure:"OIDCScopes,omitempty"`
// PEM-encoded certificate to expose to the clients for TLS. Only has effect and
// required if `TLSType` is set to `External`.
TLSCertificate string `json:"TLSCertificate" msgpack:"TLSCertificate" bson:"tlscertificate" mapstructure:"TLSCertificate,omitempty"`
// PEM-encoded certificate key associated with `TLSCertificate`. Only has effect
// and
// required if `TLSType` is set to `External`.
TLSCertificateKey string `json:"TLSCertificateKey" msgpack:"TLSCertificateKey" bson:"tlscertificatekey" mapstructure:"TLSCertificateKey,omitempty"`
// Set how to provide a server certificate to the service.
//
// - `Aporeto`: Generate a certificate issued from Aporeto public CA.
// - `LetsEncrypt`: Issue a certificate from Let's Encrypt.
// - `External`: : Let you define your own certificate and key to use.
// - `None`: : TLS is disabled (not recommended).
TLSType ServiceTLSTypeValue `json:"TLSType" msgpack:"TLSType" bson:"tlstype" mapstructure:"TLSType,omitempty"`
// This is a set of all API tags for matching in the DB.
AllAPITags []string `json:"-" msgpack:"-" bson:"allapitags" mapstructure:"-,omitempty"`
// This is a set of all selector tags for matching in the DB.
AllServiceTags []string `json:"-" msgpack:"-" bson:"allservicetags" mapstructure:"-,omitempty"`
// Stores additional information about an entity.
Annotations map[string][]string `json:"annotations" msgpack:"annotations" bson:"annotations" mapstructure:"annotations,omitempty"`
// Defines if the object is archived.
Archived bool `json:"-" msgpack:"-" bson:"archived" mapstructure:"-,omitempty"`
// List of tags attached to an entity.
AssociatedTags []string `json:"associatedTags" msgpack:"associatedTags" bson:"associatedtags" mapstructure:"associatedTags,omitempty"`
// Defines the user authorization type that should be used.
//
// - `None` (default): No authorization.
// - `JWT`: Configures a simple JWT verification from the HTTP `Authorization` header.
// - `OIDC`: Configures OIDC authorization. You must then set `OIDCClientID`,`OIDCClientSecret`, `OIDCProviderURL`.
// - `MTLS`: Configures client certificate authorization. Then you can optionally use `MTLSCertificateAuthority`, otherwise Aporeto's public signing certificate will be used.
AuthorizationType ServiceAuthorizationTypeValue `json:"authorizationType" msgpack:"authorizationType" bson:"authorizationtype" mapstructure:"authorizationType,omitempty"`
// Defines a list of mappings between claims and HTTP headers. When these mappings
// are defined,
// the enforcer will copy the values of the claims to the corresponding HTTP
// headers.
ClaimsToHTTPHeaderMappings []*ClaimMapping `json:"claimsToHTTPHeaderMappings" msgpack:"claimsToHTTPHeaderMappings" bson:"claimstohttpheadermappings" mapstructure:"claimsToHTTPHeaderMappings,omitempty"`
// internal idempotency key for a create operation.
CreateIdempotencyKey string `json:"-" msgpack:"-" bson:"createidempotencykey" mapstructure:"-,omitempty"`
// Creation date of the object.
CreateTime time.Time `json:"createTime" msgpack:"createTime" bson:"createtime" mapstructure:"createTime,omitempty"`
// Description of the object.
Description string `json:"description" msgpack:"description" bson:"description" mapstructure:"description,omitempty"`
// Defines if the property is disabled.
Disabled bool `json:"disabled" msgpack:"disabled" bson:"disabled" mapstructure:"disabled,omitempty"`
// Resolves the API endpoints that the service is exposing. Only valid during
// policy rendering.
Endpoints []*Endpoint `json:"endpoints" msgpack:"endpoints" bson:"-" mapstructure:"endpoints,omitempty"`
// Contains a tag expression that will determine which APIs a service is exposing.
// The APIs can be defined as the `RESTAPISpec` or similar specifications for other
// layer 7 protocols.
ExposedAPIs [][]string `json:"exposedAPIs" msgpack:"exposedAPIs" bson:"exposedapis" mapstructure:"exposedAPIs,omitempty"`
// The port that the service can be accessed on. Note that this is different from
// the
// `port` attribute that describes the port that the service is actually listening
// on.
// For example if a load balancer is used, the `exposedPort` is the port that the
// load
// balancer is listening for the service, whereas the port that the implementation
// is
// listening can be different.
ExposedPort int `json:"exposedPort" msgpack:"exposedPort" bson:"exposedport" mapstructure:"exposedPort,omitempty"`
// Indicates that the exposed service is TLS. This means that the enforcer has to
// initiate a
// TLS session in order to forward traffic to the service.
ExposedServiceIsTLS bool `json:"exposedServiceIsTLS" msgpack:"exposedServiceIsTLS" bson:"exposedserviceistls" mapstructure:"exposedServiceIsTLS,omitempty"`
// Indicates if this is an external service.
External bool `json:"external" msgpack:"external" bson:"external" mapstructure:"external,omitempty"`
// The host names that the service can be accessed on.
Hosts []string `json:"hosts" msgpack:"hosts" bson:"hosts" mapstructure:"hosts,omitempty"`
// Contains tags that can only be set during creation, must all start
// with the '@' prefix, and should only be used by external systems.
Metadata []string `json:"metadata" msgpack:"metadata" bson:"metadata" mapstructure:"metadata,omitempty"`
// Name of the entity.
Name string `json:"name" msgpack:"name" bson:"name" mapstructure:"name,omitempty"`
// Namespace tag attached to an entity.
Namespace string `json:"namespace" msgpack:"namespace" bson:"namespace" mapstructure:"namespace,omitempty"`
// Contains the list of normalized tags of the entities.
NormalizedTags []string `json:"normalizedTags" msgpack:"normalizedTags" bson:"normalizedtags" mapstructure:"normalizedTags,omitempty"`
// The port that the implementation of the service is listening to. It can be
// different than
// `exposedPort`. This is needed for port mapping use cases where there are private
// and
// public ports.
Port int `json:"port" msgpack:"port" bson:"port" mapstructure:"port,omitempty"`
// Defines if the object is protected.
Protected bool `json:"protected" msgpack:"protected" bson:"protected" mapstructure:"protected,omitempty"`
// A new virtual port that the service can be accessed on, using HTTPS. Since the
// enforcer
// transparently inserts TLS in the application path, you might want to declare a
// new port
// where the enforcer listens for TLS. However, the application does not need to be
// modified
// and the enforcer will map the traffic to the correct application port. This
// useful when
// an application is being accessed from a public network.
PublicApplicationPort int `json:"publicApplicationPort" msgpack:"publicApplicationPort" bson:"publicapplicationport" mapstructure:"publicApplicationPort,omitempty"`
// If this is set, the user will be redirected to that URL in case of any
// authorization
// failure, allowing you to provide a nice message to the user. The query parameter
// `?failure_message=<message>` will be added to that URL explaining the possible
// reasons
// of the failure.
RedirectURLOnAuthorizationFailure string `json:"redirectURLOnAuthorizationFailure" msgpack:"redirectURLOnAuthorizationFailure" bson:"redirecturlonauthorizationfailure" mapstructure:"redirectURLOnAuthorizationFailure,omitempty"`
// A tag or tag expression that identifies the processing unit that implements this
// particular service.
Selectors [][]string `json:"selectors" msgpack:"selectors" bson:"selectors" mapstructure:"selectors,omitempty"`
// PEM-encoded certificate authorities to trust when additional hops are needed. It
// must be
// set if the service must reach a service marked as `external` or must go through
// an
// additional TLS termination point like a layer 7 load balancer.
TrustedCertificateAuthorities string `json:"trustedCertificateAuthorities" msgpack:"trustedCertificateAuthorities" bson:"trustedcertificateauthorities" mapstructure:"trustedCertificateAuthorities,omitempty"`
// Type of service.
Type ServiceTypeValue `json:"type" msgpack:"type" bson:"type" mapstructure:"type,omitempty"`
// internal idempotency key for a update operation.
UpdateIdempotencyKey string `json:"-" msgpack:"-" bson:"updateidempotencykey" mapstructure:"-,omitempty"`
// Last update date of the object.
UpdateTime time.Time `json:"updateTime" msgpack:"updateTime" bson:"updatetime" mapstructure:"updateTime,omitempty"`
// geographical hash of the data. This is used for sharding and
// georedundancy.
ZHash int `json:"-" msgpack:"-" bson:"zhash" mapstructure:"-,omitempty"`
// Geographical zone. Used for sharding and georedundancy.
Zone int `json:"zone" msgpack:"zone" bson:"zone" mapstructure:"zone,omitempty"`
ModelVersion int `json:"-" msgpack:"-" bson:"_modelversion"`
}
// NewService returns a new *Service
func NewService() *Service {
return &Service{
ModelVersion: 1,
AllAPITags: []string{},
Annotations: map[string][]string{},
AllServiceTags: []string{},
AuthorizationType: ServiceAuthorizationTypeNone,
ExposedAPIs: [][]string{},
ExposedServiceIsTLS: false,
External: false,
Hosts: []string{},
Endpoints: []*Endpoint{},
ClaimsToHTTPHeaderMappings: []*ClaimMapping{},
AssociatedTags: []string{},
TLSType: ServiceTLSTypeAporeto,
NormalizedTags: []string{},
Selectors: [][]string{},
Type: ServiceTypeHTTP,
IPs: []string{},
OIDCScopes: []string{},
Metadata: []string{},
}
}
// Identity returns the Identity of the object.
func (o *Service) Identity() elemental.Identity {
return ServiceIdentity
}
// Identifier returns the value of the object's unique identifier.
func (o *Service) Identifier() string {
return o.ID
}
// SetIdentifier sets the value of the object's unique identifier.
func (o *Service) SetIdentifier(id string) {
o.ID = id
}
// Version returns the hardcoded version of the model.
func (o *Service) Version() int {
return 1
}
// BleveType implements the bleve.Classifier Interface.
func (o *Service) BleveType() string {
return "service"
}
// DefaultOrder returns the list of default ordering fields.
func (o *Service) DefaultOrder() []string {
return []string{
"namespace",
"name",
}
}
// Doc returns the documentation for the object
func (o *Service) Doc() string {
return `Defines a generic service object at layer 4 or layer 7 that encapsulates the
description of a micro-service. A service exposes APIs and can be implemented
through third party entities (such as a cloud provider) or through processing
units.`
}
func (o *Service) String() string {
return fmt.Sprintf("<%s:%s>", o.Identity().Name, o.Identifier())
}
// GetAnnotations returns the Annotations of the receiver.
func (o *Service) GetAnnotations() map[string][]string {
return o.Annotations
}
// SetAnnotations sets the property Annotations of the receiver using the given value.
func (o *Service) SetAnnotations(annotations map[string][]string) {
o.Annotations = annotations
}
// GetArchived returns the Archived of the receiver.
func (o *Service) GetArchived() bool {
return o.Archived
}
// SetArchived sets the property Archived of the receiver using the given value.
func (o *Service) SetArchived(archived bool) {
o.Archived = archived
}
// GetAssociatedTags returns the AssociatedTags of the receiver.
func (o *Service) GetAssociatedTags() []string {
return o.AssociatedTags
}
// SetAssociatedTags sets the property AssociatedTags of the receiver using the given value.
func (o *Service) SetAssociatedTags(associatedTags []string) {
o.AssociatedTags = associatedTags
}
// GetCreateIdempotencyKey returns the CreateIdempotencyKey of the receiver.
func (o *Service) GetCreateIdempotencyKey() string {
return o.CreateIdempotencyKey
}
// SetCreateIdempotencyKey sets the property CreateIdempotencyKey of the receiver using the given value.
func (o *Service) SetCreateIdempotencyKey(createIdempotencyKey string) {
o.CreateIdempotencyKey = createIdempotencyKey
}
// GetCreateTime returns the CreateTime of the receiver.
func (o *Service) GetCreateTime() time.Time {
return o.CreateTime
}
// SetCreateTime sets the property CreateTime of the receiver using the given value.
func (o *Service) SetCreateTime(createTime time.Time) {
o.CreateTime = createTime
}
// GetDescription returns the Description of the receiver.
func (o *Service) GetDescription() string {
return o.Description
}
// SetDescription sets the property Description of the receiver using the given value.
func (o *Service) SetDescription(description string) {
o.Description = description
}
// GetDisabled returns the Disabled of the receiver.
func (o *Service) GetDisabled() bool {
return o.Disabled
}
// SetDisabled sets the property Disabled of the receiver using the given value.
func (o *Service) SetDisabled(disabled bool) {
o.Disabled = disabled
}
// GetMetadata returns the Metadata of the receiver.
func (o *Service) GetMetadata() []string {
return o.Metadata
}
// SetMetadata sets the property Metadata of the receiver using the given value.
func (o *Service) SetMetadata(metadata []string) {
o.Metadata = metadata
}
// GetName returns the Name of the receiver.
func (o *Service) GetName() string {
return o.Name
}
// SetName sets the property Name of the receiver using the given value.
func (o *Service) SetName(name string) {
o.Name = name
}
// GetNamespace returns the Namespace of the receiver.
func (o *Service) GetNamespace() string {
return o.Namespace
}
// SetNamespace sets the property Namespace of the receiver using the given value.
func (o *Service) SetNamespace(namespace string) {
o.Namespace = namespace
}
// GetNormalizedTags returns the NormalizedTags of the receiver.
func (o *Service) GetNormalizedTags() []string {
return o.NormalizedTags
}
// SetNormalizedTags sets the property NormalizedTags of the receiver using the given value.
func (o *Service) SetNormalizedTags(normalizedTags []string) {
o.NormalizedTags = normalizedTags
}
// GetProtected returns the Protected of the receiver.
func (o *Service) GetProtected() bool {
return o.Protected
}
// SetProtected sets the property Protected of the receiver using the given value.
func (o *Service) SetProtected(protected bool) {
o.Protected = protected
}
// GetUpdateIdempotencyKey returns the UpdateIdempotencyKey of the receiver.
func (o *Service) GetUpdateIdempotencyKey() string {
return o.UpdateIdempotencyKey
}
// SetUpdateIdempotencyKey sets the property UpdateIdempotencyKey of the receiver using the given value.
func (o *Service) SetUpdateIdempotencyKey(updateIdempotencyKey string) {
o.UpdateIdempotencyKey = updateIdempotencyKey
}
// GetUpdateTime returns the UpdateTime of the receiver.
func (o *Service) GetUpdateTime() time.Time {
return o.UpdateTime
}
// SetUpdateTime sets the property UpdateTime of the receiver using the given value.
func (o *Service) SetUpdateTime(updateTime time.Time) {
o.UpdateTime = updateTime
}
// GetZHash returns the ZHash of the receiver.
func (o *Service) GetZHash() int {
return o.ZHash
}
// SetZHash sets the property ZHash of the receiver using the given value.
func (o *Service) SetZHash(zHash int) {
o.ZHash = zHash
}
// GetZone returns the Zone of the receiver.
func (o *Service) GetZone() int {
return o.Zone
}
// SetZone sets the property Zone of the receiver using the given value.
func (o *Service) SetZone(zone int) {
o.Zone = zone
}
// ToSparse returns the sparse version of the model.
// The returned object will only contain the given fields. No field means entire field set.
func (o *Service) ToSparse(fields ...string) elemental.SparseIdentifiable {
if len(fields) == 0 {
// nolint: goimports
return &SparseService{
ID: &o.ID,
IPs: &o.IPs,
JWTSigningCertificate: &o.JWTSigningCertificate,
MTLSCertificateAuthority: &o.MTLSCertificateAuthority,
OIDCCallbackURL: &o.OIDCCallbackURL,
OIDCClientID: &o.OIDCClientID,
OIDCClientSecret: &o.OIDCClientSecret,
OIDCProviderURL: &o.OIDCProviderURL,
OIDCScopes: &o.OIDCScopes,
TLSCertificate: &o.TLSCertificate,
TLSCertificateKey: &o.TLSCertificateKey,
TLSType: &o.TLSType,
AllAPITags: &o.AllAPITags,
AllServiceTags: &o.AllServiceTags,
Annotations: &o.Annotations,
Archived: &o.Archived,
AssociatedTags: &o.AssociatedTags,
AuthorizationType: &o.AuthorizationType,
ClaimsToHTTPHeaderMappings: &o.ClaimsToHTTPHeaderMappings,
CreateIdempotencyKey: &o.CreateIdempotencyKey,
CreateTime: &o.CreateTime,
Description: &o.Description,
Disabled: &o.Disabled,
Endpoints: &o.Endpoints,
ExposedAPIs: &o.ExposedAPIs,
ExposedPort: &o.ExposedPort,
ExposedServiceIsTLS: &o.ExposedServiceIsTLS,
External: &o.External,
Hosts: &o.Hosts,
Metadata: &o.Metadata,
Name: &o.Name,
Namespace: &o.Namespace,
NormalizedTags: &o.NormalizedTags,
Port: &o.Port,
Protected: &o.Protected,
PublicApplicationPort: &o.PublicApplicationPort,
RedirectURLOnAuthorizationFailure: &o.RedirectURLOnAuthorizationFailure,
Selectors: &o.Selectors,
TrustedCertificateAuthorities: &o.TrustedCertificateAuthorities,
Type: &o.Type,
UpdateIdempotencyKey: &o.UpdateIdempotencyKey,
UpdateTime: &o.UpdateTime,
ZHash: &o.ZHash,
Zone: &o.Zone,
}
}
sp := &SparseService{}
for _, f := range fields {
switch f {
case "ID":
sp.ID = &(o.ID)
case "IPs":
sp.IPs = &(o.IPs)
case "JWTSigningCertificate":
sp.JWTSigningCertificate = &(o.JWTSigningCertificate)
case "MTLSCertificateAuthority":
sp.MTLSCertificateAuthority = &(o.MTLSCertificateAuthority)
case "OIDCCallbackURL":
sp.OIDCCallbackURL = &(o.OIDCCallbackURL)
case "OIDCClientID":
sp.OIDCClientID = &(o.OIDCClientID)
case "OIDCClientSecret":
sp.OIDCClientSecret = &(o.OIDCClientSecret)
case "OIDCProviderURL":
sp.OIDCProviderURL = &(o.OIDCProviderURL)
case "OIDCScopes":
sp.OIDCScopes = &(o.OIDCScopes)
case "TLSCertificate":
sp.TLSCertificate = &(o.TLSCertificate)
case "TLSCertificateKey":
sp.TLSCertificateKey = &(o.TLSCertificateKey)
case "TLSType":
sp.TLSType = &(o.TLSType)
case "allAPITags":
sp.AllAPITags = &(o.AllAPITags)
case "allServiceTags":
sp.AllServiceTags = &(o.AllServiceTags)
case "annotations":
sp.Annotations = &(o.Annotations)
case "archived":
sp.Archived = &(o.Archived)
case "associatedTags":
sp.AssociatedTags = &(o.AssociatedTags)
case "authorizationType":
sp.AuthorizationType = &(o.AuthorizationType)
case "claimsToHTTPHeaderMappings":
sp.ClaimsToHTTPHeaderMappings = &(o.ClaimsToHTTPHeaderMappings)
case "createIdempotencyKey":
sp.CreateIdempotencyKey = &(o.CreateIdempotencyKey)
case "createTime":
sp.CreateTime = &(o.CreateTime)
case "description":
sp.Description = &(o.Description)
case "disabled":
sp.Disabled = &(o.Disabled)
case "endpoints":
sp.Endpoints = &(o.Endpoints)
case "exposedAPIs":
sp.ExposedAPIs = &(o.ExposedAPIs)
case "exposedPort":
sp.ExposedPort = &(o.ExposedPort)
case "exposedServiceIsTLS":
sp.ExposedServiceIsTLS = &(o.ExposedServiceIsTLS)
case "external":
sp.External = &(o.External)
case "hosts":
sp.Hosts = &(o.Hosts)
case "metadata":
sp.Metadata = &(o.Metadata)
case "name":
sp.Name = &(o.Name)
case "namespace":
sp.Namespace = &(o.Namespace)
case "normalizedTags":
sp.NormalizedTags = &(o.NormalizedTags)
case "port":
sp.Port = &(o.Port)
case "protected":
sp.Protected = &(o.Protected)
case "publicApplicationPort":
sp.PublicApplicationPort = &(o.PublicApplicationPort)
case "redirectURLOnAuthorizationFailure":
sp.RedirectURLOnAuthorizationFailure = &(o.RedirectURLOnAuthorizationFailure)
case "selectors":
sp.Selectors = &(o.Selectors)
case "trustedCertificateAuthorities":
sp.TrustedCertificateAuthorities = &(o.TrustedCertificateAuthorities)
case "type":
sp.Type = &(o.Type)
case "updateIdempotencyKey":
sp.UpdateIdempotencyKey = &(o.UpdateIdempotencyKey)
case "updateTime":
sp.UpdateTime = &(o.UpdateTime)
case "zHash":
sp.ZHash = &(o.ZHash)
case "zone":
sp.Zone = &(o.Zone)
}
}
return sp
}
// Patch apply the non nil value of a *SparseService to the object.
func (o *Service) Patch(sparse elemental.SparseIdentifiable) {
if !sparse.Identity().IsEqual(o.Identity()) {
panic("cannot patch from a parse with different identity")
}
so := sparse.(*SparseService)
if so.ID != nil {
o.ID = *so.ID
}
if so.IPs != nil {
o.IPs = *so.IPs
}
if so.JWTSigningCertificate != nil {
o.JWTSigningCertificate = *so.JWTSigningCertificate
}
if so.MTLSCertificateAuthority != nil {
o.MTLSCertificateAuthority = *so.MTLSCertificateAuthority
}
if so.OIDCCallbackURL != nil {
o.OIDCCallbackURL = *so.OIDCCallbackURL
}
if so.OIDCClientID != nil {
o.OIDCClientID = *so.OIDCClientID
}
if so.OIDCClientSecret != nil {
o.OIDCClientSecret = *so.OIDCClientSecret
}
if so.OIDCProviderURL != nil {
o.OIDCProviderURL = *so.OIDCProviderURL
}
if so.OIDCScopes != nil {
o.OIDCScopes = *so.OIDCScopes
}
if so.TLSCertificate != nil {
o.TLSCertificate = *so.TLSCertificate
}
if so.TLSCertificateKey != nil {
o.TLSCertificateKey = *so.TLSCertificateKey
}
if so.TLSType != nil {
o.TLSType = *so.TLSType
}
if so.AllAPITags != nil {
o.AllAPITags = *so.AllAPITags
}
if so.AllServiceTags != nil {
o.AllServiceTags = *so.AllServiceTags
}
if so.Annotations != nil {
o.Annotations = *so.Annotations
}
if so.Archived != nil {
o.Archived = *so.Archived
}
if so.AssociatedTags != nil {
o.AssociatedTags = *so.AssociatedTags
}
if so.AuthorizationType != nil {
o.AuthorizationType = *so.AuthorizationType
}
if so.ClaimsToHTTPHeaderMappings != nil {
o.ClaimsToHTTPHeaderMappings = *so.ClaimsToHTTPHeaderMappings
}
if so.CreateIdempotencyKey != nil {
o.CreateIdempotencyKey = *so.CreateIdempotencyKey
}
if so.CreateTime != nil {
o.CreateTime = *so.CreateTime
}
if so.Description != nil {
o.Description = *so.Description
}
if so.Disabled != nil {
o.Disabled = *so.Disabled
}
if so.Endpoints != nil {
o.Endpoints = *so.Endpoints
}
if so.ExposedAPIs != nil {
o.ExposedAPIs = *so.ExposedAPIs
}
if so.ExposedPort != nil {
o.ExposedPort = *so.ExposedPort
}
if so.ExposedServiceIsTLS != nil {
o.ExposedServiceIsTLS = *so.ExposedServiceIsTLS
}
if so.External != nil {
o.External = *so.External
}
if so.Hosts != nil {
o.Hosts = *so.Hosts
}
if so.Metadata != nil {
o.Metadata = *so.Metadata
}
if so.Name != nil {
o.Name = *so.Name
}
if so.Namespace != nil {
o.Namespace = *so.Namespace
}
if so.NormalizedTags != nil {
o.NormalizedTags = *so.NormalizedTags
}
if so.Port != nil {
o.Port = *so.Port
}
if so.Protected != nil {
o.Protected = *so.Protected
}
if so.PublicApplicationPort != nil {
o.PublicApplicationPort = *so.PublicApplicationPort
}
if so.RedirectURLOnAuthorizationFailure != nil {
o.RedirectURLOnAuthorizationFailure = *so.RedirectURLOnAuthorizationFailure
}
if so.Selectors != nil {
o.Selectors = *so.Selectors
}
if so.TrustedCertificateAuthorities != nil {
o.TrustedCertificateAuthorities = *so.TrustedCertificateAuthorities
}
if so.Type != nil {
o.Type = *so.Type
}
if so.UpdateIdempotencyKey != nil {
o.UpdateIdempotencyKey = *so.UpdateIdempotencyKey
}
if so.UpdateTime != nil {
o.UpdateTime = *so.UpdateTime
}
if so.ZHash != nil {
o.ZHash = *so.ZHash
}
if so.Zone != nil {
o.Zone = *so.Zone
}
}
// DeepCopy returns a deep copy if the Service.
func (o *Service) DeepCopy() *Service {
if o == nil {
return nil
}
out := &Service{}
o.DeepCopyInto(out)
return out
}
// DeepCopyInto copies the receiver into the given *Service.
func (o *Service) DeepCopyInto(out *Service) {
target, err := copystructure.Copy(o)
if err != nil {
panic(fmt.Sprintf("Unable to deepcopy Service: %s", err))
}
*out = *target.(*Service)
}
// Validate valides the current information stored into the structure.
func (o *Service) Validate() error {
errors := elemental.Errors{}
requiredErrors := elemental.Errors{}
if err := elemental.ValidateStringInList("TLSType", string(o.TLSType), []string{"Aporeto", "LetsEncrypt", "External", "None"}, false); err != nil {
errors = errors.Append(err)
}
if err := ValidateTagsWithoutReservedPrefixes("associatedTags", o.AssociatedTags); err != nil {
errors = errors.Append(err)
}
if err := elemental.ValidateStringInList("authorizationType", string(o.AuthorizationType), []string{"None", "JWT", "OIDC", "MTLS"}, false); err != nil {
errors = errors.Append(err)
}
for _, sub := range o.ClaimsToHTTPHeaderMappings {
if sub == nil {
continue
}
if err := sub.Validate(); err != nil {
errors = errors.Append(err)
}
}
if err := elemental.ValidateMaximumLength("description", o.Description, 1024, false); err != nil {
errors = errors.Append(err)
}
for _, sub := range o.Endpoints {
if sub == nil {
continue
}
if err := sub.Validate(); err != nil {
errors = errors.Append(err)
}
}
if err := ValidateTagsExpression("exposedAPIs", o.ExposedAPIs); err != nil {
errors = errors.Append(err)
}
if err := elemental.ValidateRequiredInt("exposedPort", o.ExposedPort); err != nil {
requiredErrors = requiredErrors.Append(err)
}
if err := elemental.ValidateMaximumInt("exposedPort", o.ExposedPort, int(65535), false); err != nil {
errors = errors.Append(err)
}
if err := ValidateMetadata("metadata", o.Metadata); err != nil {
errors = errors.Append(err)
}
if err := elemental.ValidateRequiredString("name", o.Name); err != nil {
requiredErrors = requiredErrors.Append(err)
}
if err := elemental.ValidateMaximumLength("name", o.Name, 256, false); err != nil {
errors = errors.Append(err)
}
if err := elemental.ValidateRequiredInt("port", o.Port); err != nil {
requiredErrors = requiredErrors.Append(err)
}
if err := elemental.ValidateMaximumInt("port", o.Port, int(65535), false); err != nil {
errors = errors.Append(err)
}