-
Notifications
You must be signed in to change notification settings - Fork 5
/
policy.ts
546 lines (488 loc) · 15.5 KB
/
policy.ts
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
// Copyright 2016-2019, Pulumi Corporation.
//
// 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.
import { Resource, Unwrap } from "@pulumi/pulumi";
import * as q from "@pulumi/pulumi/queryable";
import { PolicyConfigJSONSchema } from "./schema";
import { serve } from "./server";
const defaultEnforcementLevel: EnforcementLevel = "advisory";
/**
* The set of arguments for constructing a PolicyPack.
*/
export interface PolicyPackArgs {
/**
* The policies associated with a PolicyPack.
*/
policies: Policies;
/**
* Indicates what to do on policy violation, e.g., block deployment but allow override with
* proper permissions. Default for all policies in the PolicyPack. Individual policies can
* override.
*/
enforcementLevel?: EnforcementLevel;
}
/**
* A PolicyPack contains one or more policies to enforce.
*
* For example:
*
* ```typescript
* import * as aws from "@pulumi/aws";
* import { PolicyPack, validateResourceOfType } from "@pulumi/policy";
*
* new PolicyPack("aws-typescript", {
* policies: [{
* name: "s3-no-public-read",
* description: "Prohibits setting the publicRead or publicReadWrite permission on AWS S3 buckets.",
* enforcementLevel: "mandatory",
* validateResource: validateResourceOfType(aws.s3.Bucket, (bucket, args, reportViolation) => {
* if (bucket.acl === "public-read" || bucket.acl === "public-read-write") {
* reportViolation("You cannot set public-read or public-read-write on an S3 bucket.");
* }
* }),
* }],
* });
* ```
*/
export class PolicyPack {
private readonly policies: Policies;
constructor(private name: string, args: PolicyPackArgs, initialConfig?: PolicyPackConfig) {
this.policies = args.policies;
// Get package version from the package.json file.
const cwd = process.cwd();
const pkg = require(`${cwd}/package.json`);
const version = pkg.version;
if (!version || version === "") {
throw new Error("Version must be defined in the package.json file.");
}
const enforcementLevel = args.enforcementLevel || defaultEnforcementLevel;
serve(this.name, version, enforcementLevel, this.policies, initialConfig);
}
}
/**
* Indicates the impact of a policy violation.
*/
export type EnforcementLevel = "advisory" | "mandatory" | "disabled";
/**
* Represents configuration for the policy pack.
*/
export type PolicyPackConfig = { [policy: string]: PolicyConfig };
type PolicyConfig = EnforcementLevel | ({ enforcementLevel?: EnforcementLevel } & { [key: string]: any });
/**
* A policy function that returns true if a resource definition violates some policy (e.g., "no
* public S3 buckets"), and a set of metadata useful for generating helpful messages when the policy
* is violated.
*/
export interface Policy {
/** An ID for the policy. Must be unique within the current policy set. */
name: string;
/**
* A brief description of the policy rule. e.g., "S3 buckets should have default encryption
* enabled."
*/
description: string;
/**
* Indicates what to do on policy violation, e.g., block deployment but allow override with
* proper permissions.
*/
enforcementLevel?: EnforcementLevel;
/**
* This policy's configuration schema.
*
* For example:
*
* ```typescript
* {
* configSchema: {
* properties: {
* expiration: {
* type: "integer",
* default: 14,
* },
* identifier: {
* type: "string",
* },
* },
* },
*
* validateResource: (args, reportViolation) => {
* const { expiration, identifier } = args.getConfig<{ expiration: number; identifier?: string; }>();
*
* // ...
* }),
* }
* ```
*/
configSchema?: PolicyConfigSchema;
}
/**
* Represents the configuration schema for a policy.
*/
export interface PolicyConfigSchema {
/**
* The policy's configuration properties.
*/
properties: {
[key: string]: PolicyConfigJSONSchema;
};
/**
* The configuration properties that are required.
*/
required?: string[];
}
/**
* An array of Policies.
*/
export type Policies = (ResourceValidationPolicy | StackValidationPolicy)[];
/**
* ResourceValidationPolicy is a policy that validates a resource definition.
*
* For example:
*
* ```typescript
* import * as aws from "@pulumi/aws";
* import { validateResourceOfType } from "@pulumi/policy";
*
* const s3NoPublicReadPolicy: ResourceValidationPolicy = {
* name: "s3-no-public-read",
* description: "Prohibits setting the publicRead or publicReadWrite permission on AWS S3 buckets.",
* enforcementLevel: "mandatory",
* validateResource: validateResourceOfType(aws.s3.Bucket, (bucket, args, reportViolation) => {
* if (bucket.acl === "public-read" || bucket.acl === "public-read-write") {
* reportViolation("You cannot set public-read or public-read-write on an S3 bucket.");
* }
* }),
* };
* ```
*/
export interface ResourceValidationPolicy extends Policy {
/**
* A callback function that validates if a resource definition violates a policy (e.g. "S3 buckets
* can't be public"). A single callback function can be specified, or multiple functions, which are
* called in order.
*/
validateResource: ResourceValidation | ResourceValidation[];
}
/**
* ResourceValidation is the callback signature for a `ResourceValidationPolicy`. A resource validation
* is passed `args` with more information about the resource and a `reportViolation` callback that can be
* used to report a policy violation. `reportViolation` can be called multiple times to report multiple
* violations against the same resource. `reportViolation` must be passed a message about the violation.
* The `reportViolation` signature accepts an optional `urn` argument, which is ignored when validating
* resources (the `urn` of the resource being validated is always used).
*/
export type ResourceValidation = (args: ResourceValidationArgs, reportViolation: ReportViolation) => Promise<void> | void;
/**
* ResourceValidationArgs is the argument bag passed to a resource validation.
*/
export interface ResourceValidationArgs {
/**
* The type of the resource.
*/
type: string;
/**
* The inputs of the resource.
*/
props: Record<string, any>;
/**
* The URN of the resource.
*/
urn: string;
/**
* The name of the resource.
*/
name: string;
/**
* The options of the resource.
*/
opts: PolicyResourceOptions;
/**
* The provider of the resource.
*/
provider?: PolicyProviderResource;
/**
* Returns true if the type of this resource is the same as `resourceClass`.
*
* For example:
*
* ```typescript
* if (args.isType(aws.s3.Bucket)) {
* // ...
* }
* ```
*/
isType<TResource extends Resource>(
resourceClass: { new(...rest: any[]): TResource },
): boolean;
/**
* Returns the resource args for `resourceClass` if the type of this resource is the same as `resourceClass`,
* otherwise `undefined`.
*
* For example:
*
* ```typescript
* const bucketArgs = args.AsType(aws.s3.Bucket);
* if (bucketArgs) {
* // ...
* }
* ```
*/
asType<TResource extends Resource, TArgs>(
resourceClass: { new(name: string, args: TArgs, ...rest: any[]): TResource },
): Unwrap<NonNullable<TArgs>> | undefined;
/**
* Returns configuration for the policy.
*/
getConfig<T extends object>(): T;
}
/**
* PolicyResourceOptions is the bag of settings that control a resource's behavior.
*/
export interface PolicyResourceOptions {
/**
* When set to true, protect ensures this resource cannot be deleted.
*/
protect: boolean;
/**
* Ignore changes to any of the specified properties.
*/
ignoreChanges: string[];
/**
* When set to true, indicates that this resource should be deleted before
* its replacement is created when replacement is necessary.
*/
deleteBeforeReplace?: boolean;
/**
* Additional URNs that should be aliased to this resource.
*/
aliases: string[];
/**
* Custom timeouts for resource create, update, and delete operations.
*/
customTimeouts: PolicyCustomTimeouts;
/**
* Outputs that should always be treated as secrets.
*/
additionalSecretOutputs: string[];
}
/**
* Custom timeout options.
*/
export interface PolicyCustomTimeouts {
/**
* The create resource timeout.
*/
createSeconds: number;
/**
* The update resource timeout.
*/
updateSeconds: number;
/**
* The delete resource timeout.
*/
deleteSeconds: number;
}
/**
* Information about the provider.
*/
export interface PolicyProviderResource {
/**
* The type of the provider resource.
*/
type: string;
/**
* The properties of the provider resource.
*/
props: Record<string, any>;
/**
* The URN of the provider resource.
*/
urn: string;
/**
* The name of the provider resource.
*/
name: string;
}
/**
* A helper function that returns a strongly-typed resource validation function, used to check only resources of the
* specified resource class.
*
* For example:
*
* ```typescript
* validateResource: validateResourceOfType(aws.s3.Bucket, (bucket, args, reportViolation) => {
* for (const bucket of buckets) {
* // ...
* }
* }),
* ```
*
* @param resourceClass Used to filter this check to only resources of the specified resource class.
* @param validate A callback function that validates if the resource definition violates a policy.
*/
export function validateResourceOfType<TResource extends Resource, TArgs>(
resourceClass: { new(name: string, args: TArgs, ...rest: any[]): TResource },
validate: (
props: Unwrap<NonNullable<TArgs>>,
args: ResourceValidationArgs,
reportViolation: ReportViolation) => Promise<void> | void,
): ResourceValidation {
return (args: ResourceValidationArgs, reportViolation: ReportViolation) => {
if (args.isType(resourceClass)) {
return validate(args.props as Unwrap<NonNullable<TArgs>>, args, reportViolation);
}
};
}
/**
* StackValidationPolicy is a policy that validates a stack.
*/
export interface StackValidationPolicy extends Policy {
/**
* A callback function that validates if a stack violates a policy.
*/
validateStack: StackValidation;
}
/**
* StackValidation is the callback signature for a `StackValidationPolicy`. A stack validation is passed
* `args` with more information about the stack and a `reportViolation` callback that can be used to
* report a policy violation. `reportViolation` can be called multiple times to report multiple violations
* against the stack. `reportViolation` must be passed a message about the violation, and an optional `urn`
* to a resource in the stack that's in violation of the policy. Not specifying a `urn` indicates the
* overall stack is in violation of the policy.
*/
export type StackValidation = (args: StackValidationArgs, reportViolation: ReportViolation) => Promise<void> | void;
/**
* StackValidationArgs is the argument bag passed to a stack validation.
*/
export interface StackValidationArgs {
/**
* The resources in the stack.
*/
resources: PolicyResource[];
/**
* Returns configuration for the policy.
*/
getConfig<T extends object>(): T;
}
/**
* PolicyResource represents a resource in the stack.
*/
export interface PolicyResource {
/**
* The type of the resource.
*/
type: string;
/**
* The outputs of the resource.
*/
props: Record<string, any>;
/**
* The URN of the resource.
*/
urn: string;
/**
* The name of the resource.
*/
name: string;
/**
* The options of the resource.
*/
opts: PolicyResourceOptions;
/**
* The provider of the resource.
*/
provider?: PolicyProviderResource;
/**
* An optional parent that this resource belongs to.
*/
parent?: PolicyResource;
/**
* The dependencies of the resource.
*/
dependencies: PolicyResource[];
/**
* The set of dependencies that affect each property.
*/
propertyDependencies: Record<string, PolicyResource[]>;
/**
* Returns true if the type of this resource is the same as `resourceClass`.
*
* For example:
*
* ```typescript
* for (const resource of args.resources) {
* if (resource.isType(aws.s3.Bucket)) {
* // ...
* }
* }
* ```
*/
isType<TResource extends Resource>(
resourceClass: { new(...rest: any[]): TResource },
): boolean;
/**
* Returns the resource if the type of this resource is the same as `resourceClass`,
* otherwise `undefined`.
*
* For example:
*
* ```typescript
* const buckets = args.resources
* .map(r = r.asType(aws.s3.Bucket))
* .filter(b => b);
* for (const bucket of buckets) {
* // ...
* }
* ```
*/
asType<TResource extends Resource>(
resourceClass: { new(...rest: any[]): TResource },
): q.ResolvedResource<TResource> | undefined;
}
/**
* A helper function that returns a strongly-typed stack validation function, used to check only resources of the
* specified resource class.
*
* For example:
*
* ```typescript
* validateStack: validateStackResourcesOfType(aws.s3.Bucket, (buckets, args, reportViolation) => {
* for (const bucket of buckets) {
* // ...
* }
* }),
* ```
*
* @param resourceClass Used to filter this check to only resources of the specified resource class.
* @param validate A callback function that validates if a stack violates a policy.
*/
export function validateStackResourcesOfType<TResource extends Resource>(
resourceClass: { new(...rest: any[]): TResource },
validate: (
resources: q.ResolvedResource<TResource>[],
args: StackValidationArgs,
reportViolation: ReportViolation) => Promise<void> | void,
): StackValidation {
return (args: StackValidationArgs, reportViolation: ReportViolation) => {
const filtered = args.resources.filter(r => r.isType(resourceClass));
if (filtered.length > 0) {
const filteredTyped = filtered.map(r => r.props as q.ResolvedResource<TResource>);
const filteredArgs = { resources: filtered, getConfig: args.getConfig };
return validate(filteredTyped, filteredArgs, reportViolation);
}
};
}
/**
* ReportViolation is the callback signature used to report policy violations.
*/
export type ReportViolation = (message: string, urn?: string) => void;