forked from Azure/Community-Policy
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Format-PolicyDefinition.ps1
566 lines (509 loc) · 19.6 KB
/
Format-PolicyDefinition.ps1
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
<#
.SYNOPSIS
Validates and repairs (formats) Azure Policy definitions.
.DESCRIPTION
Ingests complete Policy definition file
Checks required elements
Fixes some errors with a warning
Splits the file into the required three files
.PARAMETER content
Content of the Policy definition.
.PARAMETER category
Category of the Policy definition, if metadat does not conatin a valid category. Default is empty indicating to fail validation if metadata category no valid.
.EXAMPLE
$definition = Format-PolicyDefinition -content $content -category "Compute"
#>
function Format-PolicyDefinition {
[CmdletBinding()]
param(
[parameter(Mandatory = $true, Position = 0)]
[string] $content,
[parameter(Mandatory = $false)]
[string] $alternateDisplayName = "",
[parameter(Mandatory = $false)]
[string] $category = ""
)
begin {
$allowedCategories = @(
"API for FHIR",
"API Management",
"App Configuration",
"App Platform",
"App Service",
"Attestation",
"Authorization",
"Automanage",
"Automation",
"Azure Active Directory",
"Azure Arc",
"Azure Data Explorer",
"Azure Databricks",
"Azure Edge Hardware Center",
"Azure Load Testing",
"Azure Purview",
"Azure Stack Edge",
"Backup",
"Batch",
"Bot Service",
"Cache",
"CDN",
"ChangeTrackingAndInventory",
"Cognitive Services",
"Compute",
"Container Apps",
"Container Instance",
"Container Instances",
"Container Registry",
"Cosmos DB",
"Cost Optimization",
"Custom Provider",
"Data Box",
"Data Factory",
"Data Lake",
"Dev Test Labs",
"Desktop Virtualization",
"Event Grid",
"Event Hub",
"Fluid Relay",
"General",
"Guest Configuration",
"HDInsight",
"Health Bot",
"Health Data Services workspace",
"Healthcare APIs",
"Internet of Things",
"Key Vault",
"Kubernetes",
"Lab Services",
"Lighthouse",
"Logic Apps",
"Machine Learning",
"Managed Application",
"Managed Grafana",
"Managed Identity",
"Maps",
"Media Services",
"Migrate",
"Monitoring",
"Network",
"Policy",
"Portal",
"Regulatory Compliance",
"SDN",
"Search",
"Security Center",
"Service Bus",
"Service Fabric",
"SignalR",
"Site Recovery",
"SQL",
"SQL Server",
"Storage",
"Stream Analytics",
"Synapse",
"Tags",
"Trusted Launch",
"Update Management Center",
"Video Analyzers",
"VM Image Builder",
"Web PubSub"
)
$allowedValuesSets = @(
@{
hasMember = "Append"
defaultValue = "Append"
allowedValues = @("Append", "Deny", "Audit", "Disabled")
defaultValues = @("Append", "Audit")
description = "Append, Deny, Audit or Disable the execution of the Policy"
},
@{
hasMember = "Modify"
defaultValue = "Modify"
allowedValues = @("Modify", "Deny", "Audit", "Disabled")
defaultValues = @("Modify", "Audit")
description = "Modify, Deny, Audit or Disabled the execution of the Policy"
},
@{
hasMember = "Deny"
defaultValue = "Audit"
allowedValues = @("Deny", "Audit", "Disabled")
defaultValues = @("Audit")
description = "Deny, Audit or Disabled the execution of the Policy"
},
@{
hasMember = "Audit"
defaultValue = "Audit"
allowedValues = @("Audit", "Disabled")
defaultValues = @("Audit")
description = "Audit or Disabled the execution of the Policy"
},
@{
hasMember = "DeployIfNotExists"
defaultValue = "DeployIfNotExists"
allowedValues = @("DeployIfNotExists", "AuditIfNotExists", "Disabled")
defaultValues = @("DeployIfNotExists", "AuditIfNotExists")
description = "DeployIfNotExists, AuditIfNotExists or Disabled the execution of the Policy"
},
@{
hasMember = "AuditIfNotExists"
defaultValue = "AuditIfNotExists"
allowedValues = @("AuditIfNotExists", "Disabled")
defaultValues = @("AuditIfNotExists")
description = "AuditIfNotExists or Disabled the execution of the Policy"
},
@{
hasMember = "DenyAction"
defaultValue = "DenyAction"
allowedValues = @("DenyAction", "Disabled")
defaultValues = @("DenyAction")
description = "DenyAction or Disabled the execution of the Policy"
},
@{
hasMember = "Manual"
defaultValue = "Manual"
allowedValues = @("Manual", "Disabled")
defaultValues = @("Manual")
description = "Manual or Disabled the execution of the Policy"
}
)
[char[]] $invalidChars = [IO.Path]::GetInvalidFileNameChars()
$invalidChars += ("[]()$ /\".ToCharArray())
}
process {
$errorMessages = [System.Collections.ArrayList]::new()
$warningMessages = [System.Collections.ArrayList]::new()
if (!(Test-Json $content -ErrorAction SilentlyContinue)) {
throw "'$($file.FullName)' is not valid JSON."
}
# test if there are keys that differ only by casing
try {
$test = $content | ConvertFrom-Json
}
catch {
throw $_.Exception.Message
}
$definition = ConvertFrom-Json $content -AsHashtable -Depth 100
#region fix tolerate flat or nested properties structure, wrong capiatalization of property members
$properties = $definition
if ($definition.properties) {
$properties = $definition.properties
}
elseif ($definition.Properties) {
$properties = $definition.Properties
}
$name = $definition.name
if (!$name) {
$name = $definition.Name
}
if (!$name) {
$name = $properties.name
}
if (!$name) {
$name = $properties.Name
}
$displayName = $properties.displayName
if (!$displayName) {
$displayName = $properties.DisplayName
}
$description = $properties.description
if (!$description) {
$description = $properties.Description
}
$metadata = $properties.metadata
if (!$metadata) {
$metadata = $properties.Metadata
if (!$metadata) {
$metadata = @{}
}
}
$mode = $properties.mode
if (!$mode) {
$mode = $properties.Mode
}
$parameters = $properties.parameters
if (!$parameters) {
$parameters = $properties.Parameters
if (!$parameters) {
$parameters = @{}
}
}
$policyRule = $properties.policyRule
if (!$policyRule) {
$policyRule = $properties.PolicyRule
}
#endregion
# region check that it is a Policy definition , ignore file if it is not, uses primitive heuristic
$notPolicyDefinition = $false
$if = $null
$then = $null
$effect = $null
if ($null -ne $policyRule) {
$if = $policyRule.if
if ($null -eq $if) {
$notPolicyDefinition = $true
}
$then = $policyRule.then
if ($null -ne $then) {
$effect = $then.effect
if ($null -eq $effect) {
$notPolicyDefinition = $true
}
}
else {
$notPolicyDefinition = $true
}
}
else {
$notPolicyDefinition = $true
}
if ($notPolicyDefinition) {
$messagesString = "'$($file.FullName)' is not a Policy definition."
$null = $errorMessages.Add($messagesString)
return $null, $warningMessages, $errorMessages, $null
}
#endregion
#region naming
if (!$name) {
if ($definition.id) {
$idSplits = $definition.id -split "/"
$name = $idSplits[-1]
}
elseif ($properties.id) {
$idSplits = $properties.id -split "/"
$name = $idSplits[-1]
}
}
$isGuid = $false
if ($name) {
$guid = [guid]::Empty
$isGuid = [guid]::TryParse($name, $([ref]$guid))
}
$nonGuidName = $null
if (!$isGuid) {
$nonGuidName = $name
}
if (!$displayName) {
if ($nonGuidName -and $alternateDisplayName -ne "") {
$displayName = $nonGuidName
$null = $warningMessages.Add("Policy displayName not found. Using name '$displayName' as the displayName.")
}
elseif ($alternateDisplayName -ne "") {
$displayName = $alternateDisplayName
$null = $warningMessages.Add("Policy displayName not found. Using alternateDisplayName '$displayName' as the displayName.")
}
else {
$null = $errorMessages.Add("Policy displayName not found.")
}
}
elseif ($displayName.Length -gt 128) {
$null = $warningMessages.Add("Policy displayName is too long. Must be 128 characters or less; truncating displayName.")
$displayName = $displayName.Substring(0, 128)
}
if (!$description) {
if ($alternateDisplayName -eq "") {
$null = $errorMessages.Add("Policy description not found.")
}
else {
$description = "need to add description"
$null = $warningMessages.Add("Policy description not found. Using '$description' as the description.")
}
}
elseif ($description.Length -gt 512) {
$null = $warningMessages.Add("Policy description is too long. Must be 512 characters or less; truncating description")
$description = $description.Substring(0, 512)
}
if (!$isGuid) {
$name = (New-Guid).Guid
$null = $warningMessages.Add("Policy name missing or not a GUID. Fix using generated GUID '$name' as the name.")
}
#endregion
#region metadata
# Temporary until versions available
if (!$metadata.version) {
$metadata.version = "1.0.0"
$null = $warningMessages.Add("Policy metadata version not found. Fix using 1.0.0.")
}
# $metadataVersion = $metadata.version
# $version = $properties.version
# if (!$version) {
# if ($metadata.version) {
# $version = $metadata.version
# $null = $warningMessages.Add("version not found. Using version from metadata $($version)")
# }
# else {
# $version = "1.0.0"
# $null = $warningMessages.Add("version not found. Defaulting to $($version)")
# }
# }
if ($metadata.category) {
if ($allowedCategories -ccontains $metadata.category) {
$category = $metadata.category
}
elseif ($category.Length -gt 0) {
if ($allowedCategories -ccontains $category) {
$metadata.category = $category
$null = $warningMessages.Add("Category '$($metadata.category)' is not in allowed list. Using category parameter $category instead.")
}
else {
$null = $errorMessages.Add("Metadata category '$($metadata.category)' and category parameter $($category) are not in allowed list.")
}
}
else {
$null = $errorMessages.Add("Metadata category '$($metadata.category)' is not in allowed list and category parameter is empty.")
}
}
elseif ($category.Length -gt 0) {
if ($allowedCategories -ccontains $category) {
$null = $warningMessages.Add("Metadata category is not supplied. Using category parameter $category instead.")
$metadata.category = $category
}
else {
$null = $errorMessages.Add("Metadata category is not supplied and category parameter $($category) is not in allowed list.")
}
}
else {
$null = $errorMessages.Add("Metadata category is not supplied and category parameter is empty.")
}
#endregion
if (!$mode) {
$mode = "All"
$null = $warningMessages.Add("Policy mode not found. Fix using 'All'.")
}
#region effect paramteter
$defaultValue = $null
$allowedValues = $null
$allowedValuesSet = $null
if ($effect.StartsWith(("[parameters('")) -and $effect.EndsWith("')]")) {
# parameterized effect
$value1 = $effect.Replace("[parameters('", "")
$parameterName = $value1.Replace("')]", "")
$effectParameter = $parameters.$parameterName
$allowedValues = $effectParameter.allowedValues
$defaultValue = $effectParameter.defaultValue
if ($parameterName -cne "effect") {
$null = $warningMessages.Add("Policy effect parameter name must be effect. Autofix available.")
}
if (!$defaultValue) {
$null = $warningMessages.Add("Policy effect parameter default value not found. Autofix available.")
}
if (!$allowedValues) {
$null = $warningMessages.Add("Policy effect parameter allowed values not found. Autofix available.")
}
if ($effectParameter.type -ne "String") {
$null = $warningMessages.Add("Policy effect parameter type must be String. Autofix available.")
}
if ($effectParameter.metadata.displayName -ne "Effect") {
$null = $warningMessages.Add("Policy effect parameter displayName must be Effect. Autofix available.")
}
if ($null -eq $effectParameter.metadata.description) {
$null = $warningMessages.Add("Policy effect parameter description must be set. Autofix available.")
}
$parameters.Remove($parameterName)
}
else {
# hard coded effect
$defaultValue = $effect
$null = $warningMessages.Add("Policy effect is hard coded. Autofix available.")
}
# find allowed values set
if (!$allowedValues -and $defaultValue) {
# find allowed values set by default value
foreach ($set in $allowedValuesSets) {
if ($defaultValue -eq $set.hasMember) {
$allowedValuesSet = $set
break
}
}
}
elseif ($allowedValues) {
# find allowed values set by allowed values
foreach ($set in $allowedValuesSets) {
foreach ($allowedValue in $allowedValues) {
if ($set.hasMember -eq $allowedValue) {
$allowedValuesSet = $set
break
}
}
if ($allowedValuesSet) {
break
}
}
}
# create effect parameter
if ($allowedValuesSet) {
$newEffect = [ordered]@{
type = "String"
metadata = [ordered]@{
displayName = "Effect"
description = $allowedValuesSet.description
}
allowedValues = $allowedValuesSet.allowedValues
defaultValue = $allowedValuesSet.defaultValue
}
$parameters["effect"] = $newEffect
$then["effect"] = "[parameters('effect')]"
}
else {
$null = $errorMessages.Add("Policy effect parameter does not specify a valid allowedValues or a valid defaultValue; therefore the values cannot be inferred.")
}
#endregion
#region remove invalid elements
if ($properties.policyType -or $properties.PolicyType) {
$null = $warningMessages.Add("policyType ($($properties.policyType)) is not allowed, fix by removing it from the definition.")
}
if ($metadata.createdBy) {
$null = $warningMessages.Add("createdBy ($($metadata.createdBy)) is not allowed, fix by removing it from the definition.")
$metadata.Remove("createdBy")
}
if ($metadata.createdOn) {
$null = $warningMessages.Add("createdOn ($($metadata.createdOn)) is not allowed, fix by removing it from the definition.")
$metadata.Remove("createdOn")
}
if ($metadata.updatedBy) {
$null = $warningMessages.Add("updatedBy ($($metadata.updatedBy)) is not allowed, fix by removing it from the definition.")
$metadata.Remove("updatedBy")
}
if ($metadata.updatedOn) {
$null = $warningMessages.Add("updatedOn ($($metadata.updatedOn)) is not allowed, fix by removing it from the definition.")
$metadata.Remove("updatedOn")
}
#endregion
#region create new structure
$newDefinition = [ordered]@{
name = $name
type = "Microsoft.Authorization/policyDefinitions"
properties = [ordered]@{
displayName = $displayName
description = $description
metadata = $metadata
# version = $version
mode = $mode
parameters = $parameters
policyRule = [ordered]@{
if = $if
then = $then
}
}
}
#endregion
#region create new directory name
$pathTemp = $name
if (!([string]::IsNullOrEmpty($displayName))) {
$pathTemp = $displayName.Trim()
$pathTemp = $pathTemp.ToLower()
$pathSplits = $pathTemp.Split($invalidChars, [System.StringSplitOptions]::RemoveEmptyEntries)
$pathTemp = $pathSplits -join "-"
$previousPath = ""
while ($previousPath -ne $pathTemp) {
# remove multiple --
$previousPath = $pathTemp
$pathTemp = $pathTemp -replace "--", "-"
}
$pathTemp = $pathTemp.Trim("-")
}
#endregion
return $newDefinition, $warningMessages, $errorMessages, "$category/$pathTemp"
}
end {
}
}