-
Notifications
You must be signed in to change notification settings - Fork 1.7k
/
audit.go
285 lines (231 loc) · 8.41 KB
/
audit.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
/*
Copyright 2021 Gravitational, Inc.
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
http://www.apache.org/licenses/LICENSE-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 OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package types
import (
"time"
"github.com/gravitational/trace"
"github.com/gravitational/teleport/api/utils"
)
// ClusterAuditConfig defines cluster-wide audit log configuration. This is
// a configuration resource, never create more than one instance of it.
type ClusterAuditConfig interface {
Resource
// Type gets the audit backend type.
Type() string
// SetType sets the audit backend type.
SetType(string)
// Region gets a cloud provider region.
Region() string
// SetRegion sets a cloud provider region.
SetRegion(string)
// ShouldUploadSessions returns whether audit config
// instructs server to upload sessions.
ShouldUploadSessions() bool
// AuditSessionsURI gets the audit sessions URI.
AuditSessionsURI() string
// SetAuditSessionsURI sets the audit sessions URI.
SetAuditSessionsURI(string)
// AuditEventsURIs gets the audit events URIs.
AuditEventsURIs() []string
// SetAuditEventsURIs sets the audit events URIs.
SetAuditEventsURIs([]string)
// SetUseFIPSEndpoint sets the FIPS endpoint state for S3/Dynamo backends.
SetUseFIPSEndpoint(state ClusterAuditConfigSpecV2_FIPSEndpointState)
// GetUseFIPSEndpoint gets the current FIPS endpoint setting
GetUseFIPSEndpoint() ClusterAuditConfigSpecV2_FIPSEndpointState
// EnableContinuousBackups is used to enable (or disable) PITR (Point-In-Time Recovery).
EnableContinuousBackups() bool
// EnableAutoScaling is used to enable (or disable) auto scaling policy.
EnableAutoScaling() bool
// ReadMaxCapacity is the maximum provisioned read capacity.
ReadMaxCapacity() int64
// ReadMinCapacity is the minimum provisioned read capacity.
ReadMinCapacity() int64
// ReadTargetValue is the ratio of consumed read to provisioned capacity.
ReadTargetValue() float64
// WriteMaxCapacity is the maximum provisioned write capacity.
WriteMaxCapacity() int64
// WriteMinCapacity is the minimum provisioned write capacity.
WriteMinCapacity() int64
// WriteTargetValue is the ratio of consumed write to provisioned capacity.
WriteTargetValue() float64
// RetentionPeriod is the retention period for audit events.
RetentionPeriod() *Duration
// Clone performs a deep copy.
Clone() ClusterAuditConfig
}
// NewClusterAuditConfig is a convenience method to to create ClusterAuditConfigV2.
func NewClusterAuditConfig(spec ClusterAuditConfigSpecV2) (ClusterAuditConfig, error) {
auditConfig := &ClusterAuditConfigV2{Spec: spec}
if err := auditConfig.CheckAndSetDefaults(); err != nil {
return nil, trace.Wrap(err)
}
return auditConfig, nil
}
// DefaultClusterAuditConfig returns the default audit log configuration.
func DefaultClusterAuditConfig() ClusterAuditConfig {
config, _ := NewClusterAuditConfig(ClusterAuditConfigSpecV2{})
return config
}
// GetVersion returns resource version.
func (c *ClusterAuditConfigV2) GetVersion() string {
return c.Version
}
// GetName returns the name of the resource.
func (c *ClusterAuditConfigV2) GetName() string {
return c.Metadata.Name
}
// SetName sets the name of the resource.
func (c *ClusterAuditConfigV2) SetName(e string) {
c.Metadata.Name = e
}
// SetExpiry sets expiry time for the object.
func (c *ClusterAuditConfigV2) SetExpiry(expires time.Time) {
c.Metadata.SetExpiry(expires)
}
// Expiry returns object expiry setting.
func (c *ClusterAuditConfigV2) Expiry() time.Time {
return c.Metadata.Expiry()
}
// GetMetadata returns object metadata.
func (c *ClusterAuditConfigV2) GetMetadata() Metadata {
return c.Metadata
}
// GetResourceID returns resource ID.
func (c *ClusterAuditConfigV2) GetResourceID() int64 {
return c.Metadata.ID
}
// SetResourceID sets resource ID.
func (c *ClusterAuditConfigV2) SetResourceID(id int64) {
c.Metadata.ID = id
}
// GetRevision returns the revision
func (c *ClusterAuditConfigV2) GetRevision() string {
return c.Metadata.GetRevision()
}
// SetRevision sets the revision
func (c *ClusterAuditConfigV2) SetRevision(rev string) {
c.Metadata.SetRevision(rev)
}
// GetKind returns resource kind.
func (c *ClusterAuditConfigV2) GetKind() string {
return c.Kind
}
// GetSubKind returns resource subkind.
func (c *ClusterAuditConfigV2) GetSubKind() string {
return c.SubKind
}
// SetSubKind sets resource subkind.
func (c *ClusterAuditConfigV2) SetSubKind(sk string) {
c.SubKind = sk
}
// Type gets the audit backend type.
func (c *ClusterAuditConfigV2) Type() string {
return c.Spec.Type
}
// SetType sets the audit backend type.
func (c *ClusterAuditConfigV2) SetType(backendType string) {
c.Spec.Type = backendType
}
// Region gets a cloud provider region.
func (c *ClusterAuditConfigV2) Region() string {
return c.Spec.Region
}
// SetRegion sets a cloud provider region.
func (c *ClusterAuditConfigV2) SetRegion(region string) {
c.Spec.Region = region
}
// ShouldUploadSessions returns whether audit config
// instructs server to upload sessions.
func (c *ClusterAuditConfigV2) ShouldUploadSessions() bool {
return c.Spec.AuditSessionsURI != ""
}
// AuditSessionsURI gets the audit sessions URI.
func (c *ClusterAuditConfigV2) AuditSessionsURI() string {
return c.Spec.AuditSessionsURI
}
// SetAuditSessionsURI sets the audit sessions URI.
func (c *ClusterAuditConfigV2) SetAuditSessionsURI(uri string) {
c.Spec.AuditSessionsURI = uri
}
// AuditEventsURIs gets the audit events URIs.
func (c *ClusterAuditConfigV2) AuditEventsURIs() []string {
return c.Spec.AuditEventsURI
}
// SetAuditEventsURIs sets the audit events URIs.
func (c *ClusterAuditConfigV2) SetAuditEventsURIs(uris []string) {
c.Spec.AuditEventsURI = uris
}
// SetUseFIPSEndpoint sets the FIPS endpoint state for S3/Dynamo backends.
func (c *ClusterAuditConfigV2) SetUseFIPSEndpoint(state ClusterAuditConfigSpecV2_FIPSEndpointState) {
c.Spec.UseFIPSEndpoint = state
}
// GetUseFIPSEndpoint gets the current FIPS endpoint setting
func (c *ClusterAuditConfigV2) GetUseFIPSEndpoint() ClusterAuditConfigSpecV2_FIPSEndpointState {
return c.Spec.UseFIPSEndpoint
}
// EnableContinuousBackups is used to enable (or disable) PITR (Point-In-Time Recovery).
func (c *ClusterAuditConfigV2) EnableContinuousBackups() bool {
return c.Spec.EnableContinuousBackups
}
// EnableAutoScaling is used to enable (or disable) auto scaling policy.
func (c *ClusterAuditConfigV2) EnableAutoScaling() bool {
return c.Spec.EnableAutoScaling
}
// ReadMaxCapacity is the maximum provisioned read capacity.
func (c *ClusterAuditConfigV2) ReadMaxCapacity() int64 {
return c.Spec.ReadMaxCapacity
}
// ReadMinCapacity is the minimum provisioned read capacity.
func (c *ClusterAuditConfigV2) ReadMinCapacity() int64 {
return c.Spec.ReadMinCapacity
}
// ReadTargetValue is the ratio of consumed read to provisioned capacity.
func (c *ClusterAuditConfigV2) ReadTargetValue() float64 {
return c.Spec.ReadTargetValue
}
// WriteMaxCapacity is the maximum provisioned write capacity.
func (c *ClusterAuditConfigV2) WriteMaxCapacity() int64 {
return c.Spec.WriteMaxCapacity
}
// WriteMinCapacity is the minimum provisioned write capacity.
func (c *ClusterAuditConfigV2) WriteMinCapacity() int64 {
return c.Spec.WriteMinCapacity
}
// WriteTargetValue is the ratio of consumed write to provisioned capacity.
func (c *ClusterAuditConfigV2) WriteTargetValue() float64 {
return c.Spec.WriteTargetValue
}
// RetentionPeriod is the retention period for audit events.
func (c *ClusterAuditConfigV2) RetentionPeriod() *Duration {
value := c.Spec.RetentionPeriod
return &value
}
// Clone performs a deep copy.
func (c *ClusterAuditConfigV2) Clone() ClusterAuditConfig {
return utils.CloneProtoMsg(c)
}
// setStaticFields sets static resource header and metadata fields.
func (c *ClusterAuditConfigV2) setStaticFields() {
c.Kind = KindClusterAuditConfig
c.Version = V2
c.Metadata.Name = MetaNameClusterAuditConfig
}
// CheckAndSetDefaults verifies the constraints for ClusterAuditConfig.
func (c *ClusterAuditConfigV2) CheckAndSetDefaults() error {
c.setStaticFields()
if err := c.Metadata.CheckAndSetDefaults(); err != nil {
return trace.Wrap(err)
}
return nil
}