DSCResources/DSC_FirewallProfile/DSC_FirewallProfile.psm1
|
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 |
$modulePath = Join-Path -Path (Split-Path -Path (Split-Path -Path $PSScriptRoot -Parent) -Parent) -ChildPath 'Modules' # Import the Networking Common Modules Import-Module -Name (Join-Path -Path $modulePath ` -ChildPath (Join-Path -Path 'NetworkingDsc.Common' ` -ChildPath 'NetworkingDsc.Common.psm1')) Import-Module -Name (Join-Path -Path $modulePath -ChildPath 'DscResource.Common') # Import Localization Strings $script:localizedData = Get-LocalizedData -DefaultUICulture 'en-US' <# This is an array of all the parameters used by this resource. #> $resourceData = Import-LocalizedData ` -BaseDirectory $PSScriptRoot ` -FileName 'DSC_FirewallProfile.data.psd1' # This must be a script parameter so that it is accessible $script:parameterList = $resourceData.ParameterList <# .SYNOPSIS Returns the current Firewall Profile. .PARAMETER Name The name of the firewall profile to configure. #> function Get-TargetResource { [CmdletBinding()] [OutputType([System.Collections.Hashtable])] param ( [Parameter(Mandatory = $true)] [ValidateSet('Domain', 'Public', 'Private')] [System.String] $Name ) Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.GettingFirewallProfileMessage) ` -f $Name ) -join '' ) # Get the current Dns Client Global Settings $netFirewallProfile = Get-NetFirewallProfile -Name $Name ` -ErrorAction Stop # Generate the return object. $returnValue = @{ Name = $Name } foreach ($parameter in $script:parameterList) { $returnValue += @{ $parameter.Name = $netFirewallProfile.$($parameter.name) } } # foreach return $returnValue } # Get-TargetResource <# .SYNOPSIS Sets the Firewall Profile. .PARAMETER Name The name of the firewall profile to configure. .PARAMETER AllowInboundRules Specifies that the firewall blocks inbound traffic. .PARAMETER AllowLocalFirewallRules Specifies that the local firewall rules should be merged into the effective policy along with Group Policy settings. .PARAMETER AllowLocalIPsecRules Specifies that the local IPsec rules should be merged into the effective policy along with Group Policy settings. .PARAMETER AllowUnicastResponseToMulticast Allows unicast responses to multi-cast traffic. .PARAMETER AllowUserApps Specifies that traffic from local user applications is allowed through the firewall. .PARAMETER AllowUserPorts Specifies that traffic is allowed through local user ports. .PARAMETER DefaultInboundAction Specifies how to filter inbound traffic. .PARAMETER DefaultOutboundAction Specifies how to filter outbound traffic. .PARAMETER DisabledInterfaceAliases Specifies a list of interfaces on which firewall settings are excluded. .PARAMETER Enabled Specifies that devolution is activated. .PARAMETER EnableStealthModeForIPsec Enables stealth mode for IPsec traffic. .PARAMETER LogAllowed Specifies how to log the allowed packets in the location specified by the LogFileName parameter. .PARAMETER LogBlocked Specifies how to log the dropped packets in the location specified by the LogFileName parameter. .PARAMETER LogFileName Specifies the path and filename of the file to which Windows Server writes log entries. .PARAMETER LogIgnored Specifies how to log the ignored packets in the location specified by the LogFileName parameter. .PARAMETER LogMaxSizeKilobytes Specifies the maximum file size of the log, in kilobytes. The acceptable values for this parameter are: 1 through 32767. .PARAMETER NotifyOnListen Allows the notification of listening for inbound connections by a service. #> function Set-TargetResource { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [ValidateSet('Domain', 'Public', 'Private')] [System.String] $Name, [Parameter()] [ValidateSet('True', 'False', 'NotConfigured')] [System.String] $AllowInboundRules, [Parameter()] [ValidateSet('True', 'False', 'NotConfigured')] [System.String] $AllowLocalFirewallRules, [Parameter()] [ValidateSet('True', 'False', 'NotConfigured')] [System.String] $AllowLocalIPsecRules, [Parameter()] [ValidateSet('True', 'False', 'NotConfigured')] [System.String] $AllowUnicastResponseToMulticast, [Parameter()] [ValidateSet('True', 'False', 'NotConfigured')] [System.String] $AllowUserApps, [Parameter()] [ValidateSet('True', 'False', 'NotConfigured')] [System.String] $AllowUserPorts, [Parameter()] [ValidateSet('Block', 'Allow', 'NotConfigured')] [System.String] $DefaultInboundAction, [Parameter()] [ValidateSet('Block', 'Allow', 'NotConfigured')] [System.String] $DefaultOutboundAction, [Parameter()] [System.String[]] $DisabledInterfaceAliases, [Parameter()] [ValidateSet('True', 'False', 'NotConfigured')] [System.String] $Enabled, [Parameter()] [ValidateSet('True', 'False', 'NotConfigured')] [System.String] $EnableStealthModeForIPsec, [Parameter()] [ValidateSet('True', 'False', 'NotConfigured')] [System.String] $LogAllowed, [Parameter()] [ValidateSet('True', 'False', 'NotConfigured')] [System.String] $LogBlocked, [Parameter()] [ValidateNotNullOrEmpty()] [System.String] $LogFileName, [Parameter()] [ValidateSet('True', 'False', 'NotConfigured')] [System.String] $LogIgnored, [Parameter()] [ValidateRange(1,32767)] [System.Uint64] $LogMaxSizeKilobytes, [Parameter()] [ValidateSet('True', 'False', 'NotConfigured')] [System.String] $NotifyOnListen ) Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.SettingFirewallProfileMessage) ` -f $Name ) -join '' ) # Get the current Firewall Profile Settings $netFirewallProfile = Get-NetFirewallProfile -Name $Name ` -ErrorAction Stop # Generate a list of parameters that will need to be changed. $changeParameters = @{} foreach ($parameter in $script:parameterList) { $parameterSourceValue = $netFirewallProfile.$($parameter.name) $parameterNewValue = (Get-Variable -Name ($parameter.name)).Value if ($PSBoundParameters.ContainsKey($parameter.Name) ` -and (Compare-Object -ReferenceObject $parameterSourceValue -DifferenceObject $parameterNewValue -SyncWindow 0)) { $changeParameters += @{ $($parameter.name) = $parameterNewValue } Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.FirewallProfileUpdateParameterMessage) ` -f $Name,$parameter.Name,$parameterNewValue ) -join '' ) } # if } # foreach if ($changeParameters.Count -gt 0) { # Update any parameters that were identified as different $null = Set-NetFirewallProfile -Name $Name ` @ChangeParameters ` -ErrorAction Stop Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.FirewallProfileUpdatedMessage) ` -f $Name ) -join '' ) } # if } # Set-TargetResource <# .SYNOPSIS Tests the state of Firewall Profile. .PARAMETER Name The name of the firewall profile to configure. .PARAMETER AllowInboundRules Specifies that the firewall blocks inbound traffic. .PARAMETER AllowLocalFirewallRules Specifies that the local firewall rules should be merged into the effective policy along with Group Policy settings. .PARAMETER AllowLocalIPsecRules Specifies that the local IPsec rules should be merged into the effective policy along with Group Policy settings. .PARAMETER AllowUnicastResponseToMulticast Allows unicast responses to multi-cast traffic. .PARAMETER AllowUserApps Specifies that traffic from local user applications is allowed through the firewall. .PARAMETER AllowUserPorts Specifies that traffic is allowed through local user ports. .PARAMETER DefaultInboundAction Specifies how to filter inbound traffic. .PARAMETER DefaultOutboundAction Specifies how to filter outbound traffic. .PARAMETER DisabledInterfaceAliases Specifies a list of interfaces on which firewall settings are excluded. .PARAMETER Enabled Specifies that devolution is activated. .PARAMETER EnableStealthModeForIPsec Enables stealth mode for IPsec traffic. .PARAMETER LogAllowed Specifies how to log the allowed packets in the location specified by the LogFileName parameter. .PARAMETER LogBlocked Specifies how to log the dropped packets in the location specified by the LogFileName parameter. .PARAMETER LogFileName Specifies the path and filename of the file to which Windows Server writes log entries. .PARAMETER LogIgnored Specifies how to log the ignored packets in the location specified by the LogFileName parameter. .PARAMETER LogMaxSizeKilobytes Specifies the maximum file size of the log, in kilobytes. The acceptable values for this parameter are: 1 through 32767. .PARAMETER NotifyOnListen Allows the notification of listening for inbound connections by a service. #> function Test-TargetResource { [CmdletBinding()] [OutputType([System.Boolean])] param ( [Parameter(Mandatory = $true)] [ValidateSet('Domain', 'Public', 'Private')] [System.String] $Name, [Parameter()] [ValidateSet('True', 'False', 'NotConfigured')] [System.String] $AllowInboundRules, [Parameter()] [ValidateSet('True', 'False', 'NotConfigured')] [System.String] $AllowLocalFirewallRules, [Parameter()] [ValidateSet('True', 'False', 'NotConfigured')] [System.String] $AllowLocalIPsecRules, [Parameter()] [ValidateSet('True', 'False', 'NotConfigured')] [System.String] $AllowUnicastResponseToMulticast, [Parameter()] [ValidateSet('True', 'False', 'NotConfigured')] [System.String] $AllowUserApps, [Parameter()] [ValidateSet('True', 'False', 'NotConfigured')] [System.String] $AllowUserPorts, [Parameter()] [ValidateSet('Block', 'Allow', 'NotConfigured')] [System.String] $DefaultInboundAction, [Parameter()] [ValidateSet('Block', 'Allow', 'NotConfigured')] [System.String] $DefaultOutboundAction, [Parameter()] [System.String[]] $DisabledInterfaceAliases, [Parameter()] [ValidateSet('True', 'False', 'NotConfigured')] [System.String] $Enabled, [Parameter()] [ValidateSet('True', 'False', 'NotConfigured')] [System.String] $EnableStealthModeForIPsec, [Parameter()] [ValidateSet('True', 'False', 'NotConfigured')] [System.String] $LogAllowed, [Parameter()] [ValidateSet('True', 'False', 'NotConfigured')] [System.String] $LogBlocked, [Parameter()] [ValidateNotNullOrEmpty()] [System.String] $LogFileName, [Parameter()] [ValidateSet('True', 'False', 'NotConfigured')] [System.String] $LogIgnored, [Parameter()] [ValidateRange(1,32767)] [System.Uint64] $LogMaxSizeKilobytes, [Parameter()] [ValidateSet('True', 'False', 'NotConfigured')] [System.String] $NotifyOnListen ) Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.TestingFirewallProfileMessage) ` -f $Name ) -join '' ) # Flag to signal whether settings are correct $desiredConfigurationMatch = $true # Get the current Dns Client Global Settings $netFirewallProfile = Get-NetFirewallProfile -Name $Name ` -ErrorAction Stop # Check each parameter foreach ($parameter in $script:parameterList) { $parameterSourceValue = $netFirewallProfile.$($parameter.name) $parameterNewValue = (Get-Variable -Name ($parameter.name)).Value if ($PSBoundParameters.ContainsKey($parameter.Name) ` -and (Compare-Object -ReferenceObject $parameterSourceValue -DifferenceObject $parameterNewValue -SyncWindow 0)) { Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.FirewallProfileParameterNeedsUpdateMessage) ` -f $Name,$parameter.Name,$parameterSourceValue,$parameterNewValue ) -join '' ) $desiredConfigurationMatch = $false } # if } # foreach return $desiredConfigurationMatch } # Test-TargetResource Export-ModuleMember -Function *-TargetResource |