-
-
Notifications
You must be signed in to change notification settings - Fork 90
/
verify.go
487 lines (447 loc) · 13.7 KB
/
verify.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
package ecspresso
import (
"context"
"encoding/json"
"fmt"
"net/url"
"regexp"
"strconv"
"strings"
"time"
"github.com/aws/aws-sdk-go/aws"
"github.com/aws/aws-sdk-go/aws/credentials"
"github.com/aws/aws-sdk-go/aws/session"
"github.com/aws/aws-sdk-go/service/cloudwatchlogs"
"github.com/aws/aws-sdk-go/service/ecr"
"github.com/aws/aws-sdk-go/service/ecs"
"github.com/aws/aws-sdk-go/service/elbv2"
"github.com/aws/aws-sdk-go/service/iam"
"github.com/aws/aws-sdk-go/service/secretsmanager"
"github.com/aws/aws-sdk-go/service/ssm"
"github.com/aws/aws-sdk-go/service/sts"
"github.com/fatih/color"
"github.com/kayac/ecspresso/registry"
"github.com/pkg/errors"
)
type verifier struct {
cwl *cloudwatchlogs.CloudWatchLogs
elbv2 []*elbv2.ELBV2 // fallback to executionRole until v1.6
ssm *ssm.SSM
secretsmanager *secretsmanager.SecretsManager
ecr *ecr.ECR
opt *VerifyOption
isAssumed bool
}
func newVerifier(execSess, appSess *session.Session, opt *VerifyOption) *verifier {
return &verifier{
cwl: cloudwatchlogs.New(execSess),
elbv2: []*elbv2.ELBV2{elbv2.New(appSess), elbv2.New(execSess)},
ssm: ssm.New(execSess),
secretsmanager: secretsmanager.New(execSess),
ecr: ecr.New(execSess),
opt: opt,
isAssumed: execSess != appSess,
}
}
func (v *verifier) existsSecretValue(ctx context.Context, from string) error {
if !aws.BoolValue(v.opt.GetSecrets) {
return verifySkipErr(fmt.Sprintf("get a secret value for %s", from))
}
// secrets manager
if strings.HasPrefix(from, "arn:aws:secretsmanager:") {
// https://docs.aws.amazon.com/ja_jp/AmazonECS/latest/developerguide/specifying-sensitive-data-secrets.html
// Truncate additional params in secretsmanager Arn.
part := strings.Split(from, ":")
if len(part) < 7 {
return errors.New("invalid arn format")
}
secretArn := strings.Join(part[0:7], ":")
_, err := v.secretsmanager.GetSecretValueWithContext(ctx, &secretsmanager.GetSecretValueInput{
SecretId: &secretArn,
})
return err
}
// ssm
var name string
if strings.HasPrefix(from, "arn:aws:ssm:") {
ns := strings.Split(from, ":")
name = strings.TrimPrefix(ns[len(ns)-1], "parameter")
} else {
name = from
}
_, err := v.ssm.GetParameterWithContext(ctx, &ssm.GetParameterInput{
Name: &name,
WithDecryption: aws.Bool(true),
})
return err
}
func (d *App) newAssumedVerifier(sess *session.Session, executionRole *string, opt *VerifyOption) (*verifier, error) {
if executionRole == nil {
return newVerifier(sess, sess, opt), nil
}
svc := sts.New(sess)
out, err := svc.AssumeRole(&sts.AssumeRoleInput{
RoleArn: executionRole,
RoleSessionName: aws.String("ecspresso-verifier"),
})
if err != nil {
fmt.Println(
color.CyanString("INFO: failed to assume role to taskExecutuionRole. Continue to verifiy with current session. %s", err.Error()),
)
return newVerifier(sess, sess, opt), nil
}
assumedSess := session.New(&aws.Config{
Region: sess.Config.Region,
Credentials: credentials.NewStaticCredentials(
*out.Credentials.AccessKeyId,
*out.Credentials.SecretAccessKey,
*out.Credentials.SessionToken,
),
})
return newVerifier(assumedSess, sess, opt), nil
}
// VerifyOption represents options for Verify()
type VerifyOption struct {
GetSecrets *bool
PutLogs *bool
}
type verifyResourceFunc func(context.Context) error
type verifySkipErr string
func (v verifySkipErr) Error() string {
return string(v)
}
// Verify verifies service / task definitions related resources are valid.
func (d *App) Verify(opt VerifyOption) error {
td, err := d.LoadTaskDefinition(d.config.TaskDefinitionPath)
if err != nil {
return err
}
d.verifier, err = d.newAssumedVerifier(d.sess, td.ExecutionRoleArn, &opt)
if err != nil {
return err
}
ctx, cancel := d.Start()
defer cancel()
d.Log("Starting verify")
resources := []struct {
name string
fn verifyResourceFunc
}{
{name: "TaskDefinition", fn: d.verifyTaskDefinition},
{name: "ServiceDefinition", fn: d.verifyServiceDefinition},
{name: "Cluster", fn: d.verifyCluster},
}
for _, r := range resources {
if err := d.verifyResource(ctx, r.name, r.fn); err != nil {
return err
}
}
d.Log("Verify OK!")
return nil
}
var verifyResourceNestLevel = 0
func (d *App) verifyResource(ctx context.Context, resourceType string, verifyFunc func(context.Context) error) error {
verifyResourceNestLevel++
defer func() { verifyResourceNestLevel-- }()
indent := strings.Repeat(" ", verifyResourceNestLevel)
print := func(f string, args ...interface{}) {
fmt.Printf(indent+f+"\n", args...)
}
print("%s", resourceType)
err := verifyFunc(ctx)
if err != nil {
if _, ok := err.(verifySkipErr); ok {
print("--> %s [%s] %s", resourceType, color.CyanString("SKIP"), color.CyanString(err.Error()))
return nil
}
print("--> %s [%s] %s", resourceType, color.RedString("NG"), color.RedString(err.Error()))
return errors.Wrapf(err, "verify %s failed", resourceType)
}
print("--> [%s]", color.GreenString("OK"))
return nil
}
func (d *App) verifyCluster(ctx context.Context) error {
cluster := d.config.Cluster
out, err := d.ecs.DescribeClustersWithContext(ctx, &ecs.DescribeClustersInput{
Clusters: aws.StringSlice([]string{cluster}),
})
if err != nil {
return err
} else if len(out.Clusters) == 0 {
return errors.Errorf("cluster %s is not found", cluster)
} else {
d.DebugLog(out.Clusters[0].GoString())
}
return nil
}
func (d *App) verifyServiceDefinition(ctx context.Context) error {
if d.config.ServiceDefinitionPath == "" {
return verifySkipErr("no ServiceDefinition")
}
sv, err := d.LoadServiceDefinition(d.config.ServiceDefinitionPath)
if err != nil {
return err
}
td, err := d.LoadTaskDefinition(d.config.TaskDefinitionPath)
if err != nil {
return err
}
// networkMode
if aws.StringValue(td.NetworkMode) == "awsvpc" {
if sv.NetworkConfiguration == nil || sv.NetworkConfiguration.AwsvpcConfiguration == nil {
return errors.New(
`networkConfiguration.awsvpcConfiguration required for the taskDefinition networkMode=awsvpc`,
)
}
}
// LB
for i, lb := range sv.LoadBalancers {
name := fmt.Sprintf("LoadBalancer[%d]", i)
err := d.verifyResource(ctx, name, func(context.Context) error {
out, err := d.verifier.elbv2[0].DescribeTargetGroupsWithContext(ctx, &elbv2.DescribeTargetGroupsInput{
TargetGroupArns: []*string{lb.TargetGroupArn},
})
if err != nil && d.verifier.isAssumed {
fmt.Println(
color.YellowString(
"WARNING: verifying the target group using the task execution role has been DEPRECATED and will be removed in the future. " +
"Allow `elasticloadbalancing: DescribeTargetGroups` to the role that executes ecspresso."),
)
out, err = d.verifier.elbv2[1].DescribeTargetGroupsWithContext(ctx, &elbv2.DescribeTargetGroupsInput{
TargetGroupArns: []*string{lb.TargetGroupArn},
})
}
if err != nil {
return err
} else if len(out.TargetGroups) == 0 {
return errors.Errorf("target group %s is not found", *lb.TargetGroupArn)
}
d.DebugLog(out.GoString())
tgPort := aws.Int64Value(out.TargetGroups[0].Port)
cPort := aws.Int64Value(lb.ContainerPort)
if tgPort != cPort {
return errors.Errorf("target group's port %d and container's port %d mismatch", tgPort, cPort)
}
cname := aws.StringValue(lb.ContainerName)
var container *ecs.ContainerDefinition
for _, c := range td.ContainerDefinitions {
if aws.StringValue(c.Name) == cname {
container = c
break
}
}
if container == nil {
return errors.Errorf("container name %s is not defined in task definition", cname)
}
return nil
})
if err != nil {
return err
}
}
if len(sv.LoadBalancers) == 0 && sv.HealthCheckGracePeriodSeconds != nil {
return errors.Errorf("service has no load balancers, but healthCheckGracePeriodSeconds is defined.")
}
return nil
}
func (d *App) verifyTaskDefinition(ctx context.Context) error {
td, err := d.LoadTaskDefinition(d.config.TaskDefinitionPath)
if err != nil {
return err
}
if execRole := td.ExecutionRoleArn; execRole != nil {
name := fmt.Sprintf("ExecutionRole[%s]", *execRole)
err := d.verifyResource(ctx, name, func(ctx context.Context) error {
return d.verifyRole(ctx, *execRole)
})
if err != nil {
return err
}
}
if taskRole := td.TaskRoleArn; taskRole != nil {
name := fmt.Sprintf("TaskRole[%s]", *taskRole)
err := d.verifyResource(ctx, name, func(ctx context.Context) error {
return d.verifyRole(ctx, *taskRole)
})
if err != nil {
return err
}
}
for _, c := range td.ContainerDefinitions {
name := fmt.Sprintf("ContainerDefinition[%s]", aws.StringValue(c.Name))
err := d.verifyResource(ctx, name, func(ctx context.Context) error {
return d.verifyContainer(ctx, c)
})
if err != nil {
return err
}
}
return nil
}
var (
ecrImageURLRegex = regexp.MustCompile(`dkr\.ecr\..+.amazonaws\.com/.*:.*`)
)
func (d *App) verifyECRImage(ctx context.Context, image string) error {
d.DebugLog("VERIFY ECR Image")
out, err := d.verifier.ecr.GetAuthorizationTokenWithContext(
ctx,
&ecr.GetAuthorizationTokenInput{},
)
if err != nil {
return err
}
token := out.AuthorizationData[0].AuthorizationToken
return d.verifyRegistryImage(ctx, image, "AWS", aws.StringValue(token))
}
func (d *App) verifyRegistryImage(ctx context.Context, image, user, password string) error {
rr := strings.SplitN(image, ":", 2)
image = rr[0]
var tag string
if len(rr) == 1 {
tag = "latest"
} else {
tag = rr[1]
}
d.DebugLog(fmt.Sprintf("image=%s tag=%s", image, tag))
repo := registry.New(image, user, password)
ok, err := repo.HasImage(tag)
if err != nil {
return err
}
if ok {
return nil
}
return errors.Errorf("%s:%s is not found in Registry", image, tag)
}
func (d *App) verifyImage(ctx context.Context, image string) error {
if image == "" {
return errors.New("image is not defined")
}
if ecrImageURLRegex.MatchString(image) {
return d.verifyECRImage(ctx, image)
}
return d.verifyRegistryImage(ctx, image, "", "")
}
func (d *App) verifyContainer(ctx context.Context, c *ecs.ContainerDefinition) error {
image := aws.StringValue(c.Image)
name := fmt.Sprintf("Image[%s]", image)
err := d.verifyResource(ctx, name, func(ctx context.Context) error {
return d.verifyImage(ctx, image)
})
if err != nil {
return err
}
for _, secret := range c.Secrets {
name := fmt.Sprintf("Secret %s[%s]", *secret.Name, *secret.ValueFrom)
err := d.verifyResource(ctx, name, func(ctx context.Context) error {
return d.verifier.existsSecretValue(ctx, *secret.ValueFrom)
})
if err != nil {
return err
}
}
if c.LogConfiguration != nil && aws.StringValue(c.LogConfiguration.LogDriver) == "awslogs" {
err := d.verifyResource(ctx, "LogConfiguration[awslogs]", func(ctx context.Context) error {
return d.verifyLogConfiguration(ctx, c)
})
if err != nil {
return err
}
}
return nil
}
func (d *App) verifyLogConfiguration(ctx context.Context, c *ecs.ContainerDefinition) error {
options := c.LogConfiguration.Options
group, region, prefix := options["awslogs-group"], options["awslogs-region"], options["awslogs-stream-prefix"]
if group == nil {
return errors.New("awslogs-group is required")
}
if region == nil {
return errors.New("awslogs-region is required")
}
if !aws.BoolValue(d.verifier.opt.PutLogs) {
return verifySkipErr(fmt.Sprintf("putting logs to %s", *group))
}
var stream string
suffix := strconv.FormatInt(time.Now().UnixNano(), 10)
if prefix != nil {
stream = fmt.Sprintf("%s/%s/%s-%s", *prefix, *c.Name, "ecspresso-verify", suffix)
} else {
stream = fmt.Sprintf("%s/%s-%s", *c.Name, "ecspresso-verify", suffix)
}
if _, err := d.verifier.cwl.CreateLogStreamWithContext(ctx, &cloudwatchlogs.CreateLogStreamInput{
LogGroupName: group,
LogStreamName: aws.String(stream),
}); err != nil {
return err
}
if _, err := d.verifier.cwl.PutLogEventsWithContext(ctx, &cloudwatchlogs.PutLogEventsInput{
LogGroupName: group,
LogStreamName: aws.String(stream),
LogEvents: []*cloudwatchlogs.InputLogEvent{
{
Message: aws.String("This is a verify message by ecspresso"),
Timestamp: aws.Int64(time.Now().Unix() * 1000),
},
},
}); err != nil {
return err
}
return nil
}
func parseRoleArn(arn string) (roleName string, err error) {
if !strings.HasPrefix(arn, "arn:aws:iam::") {
return "", errors.Errorf("not a valid role arn")
}
rn := strings.Split(arn, "/")
if len(rn) < 2 {
return "", errors.New("invalid role syntax")
}
if !strings.HasSuffix(rn[0], ":role") {
return "", errors.Errorf("not a valid role arn")
}
return rn[1], nil
}
func (d *App) verifyRole(ctx context.Context, arn string) error {
roleName, err := parseRoleArn(arn)
if err != nil {
return err
}
out, err := d.iam.GetRoleWithContext(ctx, &iam.GetRoleInput{
RoleName: aws.String(roleName),
})
if err != nil {
return err
}
doc, err := parseIAMPolicyDocument(*out.Role.AssumeRolePolicyDocument)
if err != nil {
return errors.Wrap(err, "failed to parse IAM policy document")
}
for _, st := range doc.Statement {
if st.Principal.Service == "ecs-tasks.amazonaws.com" && st.Action == "sts:AssumeRole" {
return nil
}
}
return errors.Errorf("executionRole %s has not a valid policy document", roleName)
}
type iamPolicyDocument struct {
Version string `json:"Version"`
Statement []struct {
Effect string `json:"Effect"`
Principal struct {
Service string `json:"Service"`
} `json:"Principal"`
Action string `json:"Action"`
} `json:"Statement"`
}
func parseIAMPolicyDocument(s string) (*iamPolicyDocument, error) {
var doc iamPolicyDocument
s, err := url.QueryUnescape(s)
if err != nil {
return nil, err
}
if err := json.Unmarshal([]byte(s), &doc); err != nil {
return nil, err
}
return &doc, nil
}