-
Notifications
You must be signed in to change notification settings - Fork 601
/
asmauth.go
430 lines (359 loc) · 14.2 KB
/
asmauth.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
// Copyright Amazon.com Inc. or its affiliates. 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. A copy of the
// License is located at
//
// http://aws.amazon.com/apache2.0/
//
// or in the "license" file accompanying this file. This file 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 asmauth
import (
"encoding/json"
"sync"
"time"
apicontainer "github.com/aws/amazon-ecs-agent/agent/api/container"
"github.com/aws/amazon-ecs-agent/agent/asm"
"github.com/aws/amazon-ecs-agent/agent/asm/factory"
"github.com/aws/amazon-ecs-agent/agent/taskresource"
resourcestatus "github.com/aws/amazon-ecs-agent/agent/taskresource/status"
apicontainerstatus "github.com/aws/amazon-ecs-agent/ecs-agent/api/container/status"
"github.com/aws/amazon-ecs-agent/ecs-agent/api/task/status"
"github.com/aws/amazon-ecs-agent/ecs-agent/credentials"
"github.com/cihub/seelog"
"github.com/docker/docker/api/types"
"github.com/pkg/errors"
)
const (
// ResourceName is the name of the ASM auth resource
ResourceName = "asm-auth"
)
// ASMAuthResource represents private registry credentials as a task resource.
// These credentials are stored in AWS Secrets Manager
type ASMAuthResource struct {
taskARN string
createdAt time.Time
desiredStatusUnsafe resourcestatus.ResourceStatus
knownStatusUnsafe resourcestatus.ResourceStatus
// appliedStatus is the status that has been "applied" (e.g., we've called some
// operation such as 'Create' on the resource) but we don't yet know that the
// application was successful, which may then change the known status. This is
// used while progressing resource states in progressTask() of task manager
appliedStatus resourcestatus.ResourceStatus
resourceStatusToTransitionFunction map[resourcestatus.ResourceStatus]func() error
credentialsManager credentials.Manager
executionCredentialsID string
// required for asm private registry auth
requiredASMResources []*apicontainer.ASMAuthData
dockerAuthData map[string]types.AuthConfig
// asmClientCreator is a factory interface that creates new ASM clients. This is
// needed mostly for testing as we're creating an asm client per every item in
// the requiredASMResources list. Each of these items could be from different
// regions.
// TODO: Refactor this struct so that each ASMAuthData gets associated with
// exactly one ASMAuthResource object
asmClientCreator factory.ClientCreator
// terminalReason should be set for resource creation failures. This ensures
// the resource object carries some context for why provisoning failed.
terminalReason string
terminalReasonOnce sync.Once
// lock is used for fields that are accessed and updated concurrently
lock sync.RWMutex
}
// NewASMAuthResource creates a new ASMAuthResource object
func NewASMAuthResource(taskARN string,
asmRequirements []*apicontainer.ASMAuthData,
executionCredentialsID string,
credentialsManager credentials.Manager,
asmClientCreator factory.ClientCreator) *ASMAuthResource {
c := &ASMAuthResource{
taskARN: taskARN,
requiredASMResources: asmRequirements,
credentialsManager: credentialsManager,
executionCredentialsID: executionCredentialsID,
asmClientCreator: asmClientCreator,
}
c.initStatusToTransition()
return c
}
func (auth *ASMAuthResource) initStatusToTransition() {
resourceStatusToTransitionFunction := map[resourcestatus.ResourceStatus]func() error{
resourcestatus.ResourceStatus(ASMAuthStatusCreated): auth.Create,
}
auth.resourceStatusToTransitionFunction = resourceStatusToTransitionFunction
}
func (auth *ASMAuthResource) setTerminalReason(reason string) {
auth.terminalReasonOnce.Do(func() {
seelog.Infof("ASM Auth: setting terminal reason for asm auth resource in task: [%s]", auth.taskARN)
auth.terminalReason = reason
})
}
// GetTerminalReason returns an error string to propagate up through to task
// state change messages
func (auth *ASMAuthResource) GetTerminalReason() string {
return auth.terminalReason
}
// SetDesiredStatus safely sets the desired status of the resource
func (auth *ASMAuthResource) SetDesiredStatus(status resourcestatus.ResourceStatus) {
auth.lock.Lock()
defer auth.lock.Unlock()
auth.desiredStatusUnsafe = status
}
// GetDesiredStatus safely returns the desired status of the task
func (auth *ASMAuthResource) GetDesiredStatus() resourcestatus.ResourceStatus {
auth.lock.RLock()
defer auth.lock.RUnlock()
return auth.desiredStatusUnsafe
}
// GetName safely returns the name of the resource
func (auth *ASMAuthResource) GetName() string {
auth.lock.RLock()
defer auth.lock.RUnlock()
return ResourceName
}
// DesiredTerminal returns true if the cgroup's desired status is REMOVED
func (auth *ASMAuthResource) DesiredTerminal() bool {
auth.lock.RLock()
defer auth.lock.RUnlock()
return auth.desiredStatusUnsafe == resourcestatus.ResourceStatus(ASMAuthStatusRemoved)
}
// KnownCreated returns true if the cgroup's known status is CREATED
func (auth *ASMAuthResource) KnownCreated() bool {
auth.lock.RLock()
defer auth.lock.RUnlock()
return auth.knownStatusUnsafe == resourcestatus.ResourceStatus(ASMAuthStatusCreated)
}
// TerminalStatus returns the last transition state of cgroup
func (auth *ASMAuthResource) TerminalStatus() resourcestatus.ResourceStatus {
return resourcestatus.ResourceStatus(ASMAuthStatusRemoved)
}
// NextKnownState returns the state that the resource should
// progress to based on its `KnownState`.
func (auth *ASMAuthResource) NextKnownState() resourcestatus.ResourceStatus {
return auth.GetKnownStatus() + 1
}
// ApplyTransition calls the function required to move to the specified status
func (auth *ASMAuthResource) ApplyTransition(nextState resourcestatus.ResourceStatus) error {
transitionFunc, ok := auth.resourceStatusToTransitionFunction[nextState]
if !ok {
return errors.Errorf("resource [%s]: transition to %s impossible", auth.GetName(),
auth.StatusString(nextState))
}
return transitionFunc()
}
// SteadyState returns the transition state of the resource defined as "ready"
func (auth *ASMAuthResource) SteadyState() resourcestatus.ResourceStatus {
return resourcestatus.ResourceStatus(ASMAuthStatusCreated)
}
// SetKnownStatus safely sets the currently known status of the resource
func (auth *ASMAuthResource) SetKnownStatus(status resourcestatus.ResourceStatus) {
auth.lock.Lock()
defer auth.lock.Unlock()
auth.knownStatusUnsafe = status
auth.updateAppliedStatusUnsafe(status)
}
// updateAppliedStatusUnsafe updates the resource transitioning status
func (auth *ASMAuthResource) updateAppliedStatusUnsafe(knownStatus resourcestatus.ResourceStatus) {
if auth.appliedStatus == resourcestatus.ResourceStatus(ASMAuthStatusNone) {
return
}
// Check if the resource transition has already finished
if auth.appliedStatus <= knownStatus {
auth.appliedStatus = resourcestatus.ResourceStatus(ASMAuthStatusNone)
}
}
// SetAppliedStatus sets the applied status of resource and returns whether
// the resource is already in a transition
func (auth *ASMAuthResource) SetAppliedStatus(status resourcestatus.ResourceStatus) bool {
auth.lock.Lock()
defer auth.lock.Unlock()
if auth.appliedStatus != resourcestatus.ResourceStatus(ASMAuthStatusNone) {
// return false to indicate the set operation failed
return false
}
auth.appliedStatus = status
return true
}
// GetKnownStatus safely returns the currently known status of the task
func (auth *ASMAuthResource) GetKnownStatus() resourcestatus.ResourceStatus {
auth.lock.RLock()
defer auth.lock.RUnlock()
return auth.knownStatusUnsafe
}
// StatusString returns the string of the cgroup resource status
func (auth *ASMAuthResource) StatusString(status resourcestatus.ResourceStatus) string {
return ASMAuthStatus(status).String()
}
// SetCreatedAt sets the timestamp for resource's creation time
func (auth *ASMAuthResource) SetCreatedAt(createdAt time.Time) {
if createdAt.IsZero() {
return
}
auth.lock.Lock()
defer auth.lock.Unlock()
auth.createdAt = createdAt
}
// GetCreatedAt sets the timestamp for resource's creation time
func (auth *ASMAuthResource) GetCreatedAt() time.Time {
auth.lock.RLock()
defer auth.lock.RUnlock()
return auth.createdAt
}
// Create fetches credentials from ASM
func (auth *ASMAuthResource) Create() error {
seelog.Infof("ASM Auth: Retrieving credentials for containers in task: [%s]", auth.taskARN)
if auth.dockerAuthData == nil {
auth.dockerAuthData = make(map[string]types.AuthConfig)
}
for _, a := range auth.GetRequiredASMResources() {
err := auth.retrieveASMDockerAuthData(a)
if err != nil {
auth.setTerminalReason(err.Error())
return err
}
}
return nil
}
func (auth *ASMAuthResource) retrieveASMDockerAuthData(asmAuthData *apicontainer.ASMAuthData) error {
secretID := asmAuthData.CredentialsParameter
if _, ok := auth.GetASMDockerAuthConfig(secretID); ok {
// resource for this secretID already retrieved
return nil
}
executionCredentials, ok := auth.credentialsManager.GetTaskCredentials(auth.GetExecutionCredentialsID())
if !ok {
// No need to log here. managedTask.applyResourceState already does that
return errors.New("asm resource: unable to find execution role credentials")
}
iamCredentials := executionCredentials.GetIAMRoleCredentials()
asmClient := auth.asmClientCreator.NewASMClient(asmAuthData.Region, iamCredentials)
seelog.Debugf("ASM Auth: Retrieving resource with ID [%s] in task: [%s]", secretID, auth.taskARN)
dac, err := asm.GetDockerAuthFromASM(secretID, asmClient)
if err != nil {
return err
}
auth.lock.Lock()
defer auth.lock.Unlock()
// put retrieved dac in dockerAuthMap
auth.dockerAuthData[secretID] = dac
return nil
}
// GetRequiredASMResources returns the list of ASMAuthData that has to be
// retrieved from AWS Secrets Manager
func (auth *ASMAuthResource) GetRequiredASMResources() []*apicontainer.ASMAuthData {
auth.lock.RLock()
defer auth.lock.RUnlock()
return auth.requiredASMResources
}
// GetExecutionCredentialsID returns the execution role's credential ID
func (auth *ASMAuthResource) GetExecutionCredentialsID() string {
auth.lock.RLock()
defer auth.lock.RUnlock()
return auth.executionCredentialsID
}
// Cleanup removes the asm auth resource created for the task
func (auth *ASMAuthResource) Cleanup() error {
auth.clearASMDockerAuthConfig()
return nil
}
// clearASMDockerAuthConfig cycles through the collection of docker private
// registry auth data and removes them from the task
func (auth *ASMAuthResource) clearASMDockerAuthConfig() {
auth.lock.Lock()
defer auth.lock.Unlock()
for k := range auth.dockerAuthData {
delete(auth.dockerAuthData, k)
}
}
// GetASMDockerAuthConfig retrieves the docker private registry auth data from
// the task
func (auth *ASMAuthResource) GetASMDockerAuthConfig(secretID string) (types.AuthConfig, bool) {
auth.lock.RLock()
defer auth.lock.RUnlock()
d, ok := auth.dockerAuthData[secretID]
return d, ok
}
func (auth *ASMAuthResource) Initialize(resourceFields *taskresource.ResourceFields,
taskKnownStatus status.TaskStatus,
taskDesiredStatus status.TaskStatus) {
auth.initStatusToTransition()
auth.credentialsManager = resourceFields.CredentialsManager
auth.asmClientCreator = resourceFields.ASMClientCreator
if taskKnownStatus < status.TaskPulled && // Containers in the task need to be pulled
taskDesiredStatus <= status.TaskRunning { // and the task is not terminal.
// Reset the ASM resource's known status as None so that the NONE -> CREATED
// transition gets triggered
auth.SetKnownStatus(resourcestatus.ResourceStatusNone)
}
}
type asmAuthResourceJSON struct {
TaskARN string `json:"taskARN"`
CreatedAt *time.Time `json:"createdAt,omitempty"`
DesiredStatus *ASMAuthStatus `json:"desiredStatus"`
KnownStatus *ASMAuthStatus `json:"knownStatus"`
RequiredASMResources []*apicontainer.ASMAuthData `json:"asmResources"`
ExecutionCredentialsID string `json:"executionCredentialsID"`
}
// MarshalJSON serialises the ASMAuthResource struct to JSON
func (auth *ASMAuthResource) MarshalJSON() ([]byte, error) {
if auth == nil {
return nil, errors.New("asm-auth resource is nil")
}
createdAt := auth.GetCreatedAt()
return json.Marshal(asmAuthResourceJSON{
TaskARN: auth.taskARN,
CreatedAt: &createdAt,
DesiredStatus: func() *ASMAuthStatus {
desiredState := auth.GetDesiredStatus()
status := ASMAuthStatus(desiredState)
return &status
}(),
KnownStatus: func() *ASMAuthStatus {
knownState := auth.GetKnownStatus()
status := ASMAuthStatus(knownState)
return &status
}(),
RequiredASMResources: auth.GetRequiredASMResources(),
ExecutionCredentialsID: auth.GetExecutionCredentialsID(),
})
}
// UnmarshalJSON deserialises the raw JSON to a ASMAuthResource struct
func (auth *ASMAuthResource) UnmarshalJSON(b []byte) error {
temp := asmAuthResourceJSON{}
if err := json.Unmarshal(b, &temp); err != nil {
return err
}
if temp.DesiredStatus != nil {
auth.SetDesiredStatus(resourcestatus.ResourceStatus(*temp.DesiredStatus))
}
if temp.KnownStatus != nil {
auth.SetKnownStatus(resourcestatus.ResourceStatus(*temp.KnownStatus))
}
if temp.CreatedAt != nil && !temp.CreatedAt.IsZero() {
auth.SetCreatedAt(*temp.CreatedAt)
}
if temp.RequiredASMResources != nil {
auth.requiredASMResources = temp.RequiredASMResources
}
auth.taskARN = temp.TaskARN
auth.executionCredentialsID = temp.ExecutionCredentialsID
return nil
}
// GetAppliedStatus safely returns the currently applied status of the resource
func (auth *ASMAuthResource) GetAppliedStatus() resourcestatus.ResourceStatus {
auth.lock.RLock()
defer auth.lock.RUnlock()
return auth.appliedStatus
}
func (auth *ASMAuthResource) DependOnTaskNetwork() bool {
return false
}
func (auth *ASMAuthResource) BuildContainerDependency(containerName string, satisfied apicontainerstatus.ContainerStatus,
dependent resourcestatus.ResourceStatus) {
}
func (auth *ASMAuthResource) GetContainerDependencies(dependent resourcestatus.ResourceStatus) []apicontainer.ContainerDependency {
return nil
}