Public/cmdb/firewall/policy.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 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 |
# # Copyright 2019, Alexis La Goutte <alexis dot lagoutte at gmail dot com> # Copyright 2019, Benjamin Perrier <ben dot perrier at outlook dot com> # # SPDX-License-Identifier: Apache-2.0 # function Add-FGTFirewallPolicy { <# .SYNOPSIS Add a FortiGate Policy .DESCRIPTION Add a FortiGate Policy/Rules (source port/ip, destination port, ip, action, status...) .EXAMPLE Add-FGTFirewallPolicy -name MyFGTPolicy -srcintf port1 -dstintf port2 -srcaddr all -dstaddr all Add a MyFGTPolicy with source port port1 and destination port2 and source and destination all .EXAMPLE Add-FGTFirewallPolicy -name MyFGTPolicy -srcintf port1 -dstintf port2 -srcaddr all -dstaddr all -nat Add a MyFGTPolicy with NAT is enable .EXAMPLE Add-FGTFirewallPolicy -name MyFGTPolicy -srcintf port1 -dstintf port2 -srcaddr all -dstaddr all -action "deny" Add a MyFGTPolicy with action is Deny .EXAMPLE Add-FGTFirewallPolicy -name MyFGTPolicy -srcintf port1 -dstintf port2 -srcaddr all -dstaddr all -status:$false Add a MyFGTPolicy with status is disable .EXAMPLE Add-FGTFirewallPolicy -name MyFGTPolicy -srcintf port1 -dstintf port2 -srcaddr all -dstaddr all -service "HTTP, HTTPS, SSH" Add a MyFGTPolicy with multiple service port .EXAMPLE Add-FGTFirewallPolicy -name MyFGTPolicy -srcintf port1 -dstintf port2 -srcaddr all -dstaddr all -schedule workhour Add a MyFGTPolicy with schedule is workhour .EXAMPLE Add-FGTFirewallPolicy -name MyFGTPolicy -srcintf port1 -dstintf port2 -srcaddr all -dstaddr all -comments "My FGT Policy" Add a MyFGTPolicy with comment "My FGT Policy" .EXAMPLE Add-FGTFirewallPolicy -name MyFGTPolicy -srcintf port1 -dstintf port2 -srcaddr all -dstaddr all -logtraffic "all" Add a MyFGTPolicy with log traffic all .EXAMPLE Add-FGTFirewallPolicy -name MyFGTPolicy -srcintf port1 -dstintf port2 -srcaddr all -dstaddr all -nat -ippool "MyIPPool" Add a MyFGTPolicy with IP Pool MyIPPool (with nat) .EXAMPLE Add-FGTFirewallPolicy -name MyFGTPolicy -srcintf port1 -dstintf port2 -srcaddr all -dstaddr all -policyid 23 Add a MyFGTPolicy with Policy ID equal 23 #> Param( [Parameter (Mandatory = $false)] [string]$name, [Parameter (Mandatory = $false)] [int]$policyid, [Parameter (Mandatory = $true)] [string[]]$srcintf, [Parameter (Mandatory = $true)] [string[]]$dstintf, [Parameter (Mandatory = $true)] [string[]]$srcaddr, [Parameter (Mandatory = $true)] [string[]]$dstaddr, [Parameter (Mandatory = $false)] [ValidateSet("accept", "deny")] [string]$action = "accept", [Parameter (Mandatory = $false)] [switch]$status, [Parameter (Mandatory = $false)] [string]$schedule = "always", [Parameter (Mandatory = $false)] [string[]]$service = "ALL", [Parameter (Mandatory = $false)] [switch]$nat = $false, [Parameter (Mandatory = $false)] [ValidateLength(0, 255)] [string]$comments, [Parameter (Mandatory = $false)] [ValidateSet("disable", "utm", "all")] [string]$logtraffic, [Parameter (Mandatory = $false)] [string[]]$ippool, [Parameter (Mandatory = $false)] [switch]$skip, [Parameter(Mandatory = $false)] [String[]]$vdom, [Parameter(Mandatory = $false)] [psobject]$connection = $DefaultFGTConnection ) Begin { } Process { $invokeParams = @{ } if ( $PsBoundParameters.ContainsKey('skip') ) { $invokeParams.add( 'skip', $skip ) } if ( $PsBoundParameters.ContainsKey('vdom') ) { $invokeParams.add( 'vdom', $vdom ) } if ( $PsBoundParameters.ContainsKey('name') ) { if ( Get-FGTFirewallPolicy -connection $connection @invokeParams -name $name ) { Throw "Already a Policy using the same name" } } else { #check if Allow Unnamed Policy is enable $settings = Get-FGTSystemSettings -connection $connection @invokeParams if ($settings.'gui-allow-unnamed-policy' -eq "disable") { throw "You need to specifiy a name" } } $uri = "api/v2/cmdb/firewall/policy" # Source interface $srcintf_array = @() #TODO check if the interface (zone ?) is valid foreach ($intf in $srcintf) { $srcintf_array += @{ 'name' = $intf } } # Destination interface $dstintf_array = @() #TODO check if the interface (zone ?) is valid foreach ($intf in $dstintf) { $dstintf_array += @{ 'name' = $intf } } # Source address $srcaddr_array = @() #TODO check if the address (group, vip...) is valid foreach ($addr in $srcaddr) { $srcaddr_array += @{ 'name' = $addr } } # Destination address $dstaddr_array = @() #TODO check if the address (group, vip...) is valid foreach ($addr in $dstaddr) { $dstaddr_array += @{ 'name' = $addr } } # Service $service_array = @() #TODO check if the service (group...) is valid foreach ($s in $service) { $service_array += @{ 'name' = $s } } $policy = new-Object -TypeName PSObject if ( $PsBoundParameters.ContainsKey('name') ) { $policy | add-member -name "name" -membertype NoteProperty -Value $name } if ( $PsBoundParameters.ContainsKey('policyid') ) { $policy | add-member -name "policyid" -membertype NoteProperty -Value $policyid } $policy | add-member -name "srcintf" -membertype NoteProperty -Value $srcintf_array $policy | add-member -name "dstintf" -membertype NoteProperty -Value $dstintf_array $policy | add-member -name "srcaddr" -membertype NoteProperty -Value $srcaddr_array $policy | add-member -name "dstaddr" -membertype NoteProperty -Value $dstaddr_array $policy | add-member -name "action" -membertype NoteProperty -Value $action #set status enable by default (PSSA don't like to set default value for a switch parameter) if ( -not $PsBoundParameters.ContainsKey('status') ) { $status = $true } if ($status) { $policy | add-member -name "status" -membertype NoteProperty -Value "enable" } else { $policy | add-member -name "status" -membertype NoteProperty -Value "disable" } $policy | add-member -name "schedule" -membertype NoteProperty -Value $schedule $policy | add-member -name "service" -membertype NoteProperty -Value $service_array if ($nat) { $policy | add-member -name "nat" -membertype NoteProperty -Value "enable" } else { $policy | add-member -name "nat" -membertype NoteProperty -Value "disable" } if ( $PsBoundParameters.ContainsKey('comments') ) { $policy | add-member -name "comments" -membertype NoteProperty -Value $comments } if ( $PsBoundParameters.ContainsKey('logtraffic') ) { $policy | add-member -name "logtraffic" -membertype NoteProperty -Value $logtraffic } if ( $PsBoundParameters.ContainsKey('ippool') ) { if (-not $nat) { throw "You need to enable NAT (-nat)" } $ippool_array = @() #TODO check if the IP Pool is valid foreach ($i in $ippool) { $ippool_array += @{ 'name' = $i } } $policy | add-member -name "ippool" -membertype NoteProperty -Value "enable" $policy | add-member -name "poolname" -membertype NoteProperty -Value $ippool_array } Invoke-FGTRestMethod -method "POST" -body $policy -uri $uri -connection $connection @invokeParams | Out-Null Get-FGTFirewallPolicy -name $name -connection $connection @invokeParams } End { } } function Add-FGTFirewallPolicyMember { <# .SYNOPSIS Add a FortiGate Policy Member .DESCRIPTION Add a FortiGate Policy Member (source or destination address) .EXAMPLE $MyFGTPolicy = Get-FGTFirewallPolicy -name MyFGTPolicy PS C:\>$MyFGTPolicy | Add-FGTFirewallPolicyMember -srcaddr MyAddress1 Add MyAddress1 member to source of MyFGTPolicy .EXAMPLE $MyFGTPolicy = Get-FGTFirewallPolicy -name MyFGTPolicy PS C:\>$MyFGTPolicy | Add-FGTFirewallPolicyMember -dstaddr MyAddress1, MyAddress2 Add MyAddress1 and MyAddress2 member to destination of MyFGTPolicy #> Param( [Parameter (Mandatory = $true, ValueFromPipeline = $true, Position = 1)] [ValidateScript( { Confirm-FGTFirewallPolicy $_ })] [psobject]$policy, [Parameter(Mandatory = $false)] [string[]]$srcaddr, [Parameter(Mandatory = $false)] [string[]]$dstaddr, [Parameter(Mandatory = $false)] [String[]]$vdom, [Parameter(Mandatory = $false)] [psobject]$connection = $DefaultFGTConnection ) Begin { } Process { $invokeParams = @{ } if ( $PsBoundParameters.ContainsKey('vdom') ) { $invokeParams.add( 'vdom', $vdom ) } $uri = "api/v2/cmdb/firewall/policy/$($policy.policyid)" $_policy = new-Object -TypeName PSObject if ( $PsBoundParameters.ContainsKey('srcaddr') ) { #Add member to existing source address $members = $policy.srcaddr foreach ( $member in $srcaddr ) { $member_name = @{ } $member_name.add( 'name', $member) $members += $member_name } $_policy | add-member -name "srcaddr" -membertype NoteProperty -Value $members } if ( $PsBoundParameters.ContainsKey('dstaddr') ) { #Add member to existing destination address $members = $policy.dstaddr foreach ( $member in $dstaddr ) { $member_name = @{ } $member_name.add( 'name', $member) $members += $member_name } $_policy | add-member -name "dstaddr" -membertype NoteProperty -Value $members } Invoke-FGTRestMethod -method "PUT" -body $_policy -uri $uri -connection $connection @invokeParams | Out-Null Get-FGTFirewallPolicy -connection $connection @invokeParams -name $policy.name } End { } } function Get-FGTFirewallPolicy { <# .SYNOPSIS Get list of all policies/rules .DESCRIPTION Get list of all policies (name, interface source/destination, address (network) source/destination, service, action...) .EXAMPLE Get-FGTFirewallPolicy Get list of all policies .EXAMPLE Get-FGTFirewallPolicy -name myPolicy Get Policy named myPolicy .EXAMPLE Get-FGTFirewallPolicy -policyid 23 Get policy with id 23 .EXAMPLE Get-FGTFirewallPolicy -name FGT -filter_type contains Get policy contains with *FGT* .EXAMPLE Get-FGTFirewallPolicy -uuid 9e73a10e-1772-51ea-a8d7-297686fd7702 Get policy with uuid 9e73a10e-1772-51ea-a8d7-297686fd7702 .EXAMPLE Get-FGTFirewallPolicy -skip Get list of all policies (but only relevant attributes) .EXAMPLE Get-FGTFirewallPolicy -vdom vdomX Get list of all policies on vdomX #> [CmdletBinding(DefaultParameterSetName = "default")] Param( [Parameter (Mandatory = $false, Position = 1, ParameterSetName = "name")] [string]$name, [Parameter (Mandatory = $false, ParameterSetName = "uuid")] [string]$uuid, [Parameter (Mandatory = $false, ParameterSetName = "policyid")] [string]$policyid, [Parameter (Mandatory = $false)] [Parameter (ParameterSetName = "filter")] [string]$filter_attribute, [Parameter (Mandatory = $false)] [Parameter (ParameterSetName = "name")] [Parameter (ParameterSetName = "uuid")] [Parameter (ParameterSetName = "policyid")] [Parameter (ParameterSetName = "filter")] [ValidateSet('equal', 'contains')] [string]$filter_type = "equal", [Parameter (Mandatory = $false)] [Parameter (ParameterSetName = "filter")] [psobject]$filter_value, [Parameter(Mandatory = $false)] [switch]$skip, [Parameter(Mandatory = $false)] [String[]]$vdom, [Parameter(Mandatory = $false)] [psobject]$connection = $DefaultFGTConnection ) Begin { } Process { $invokeParams = @{ } if ( $PsBoundParameters.ContainsKey('skip') ) { $invokeParams.add( 'skip', $skip ) } if ( $PsBoundParameters.ContainsKey('vdom') ) { $invokeParams.add( 'vdom', $vdom ) } #Filtering switch ( $PSCmdlet.ParameterSetName ) { "name" { $filter_value = $name $filter_attribute = "name" } "uuid" { $filter_value = $uuid $filter_attribute = "uuid" } "policyid" { $filter_value = $policyid $filter_attribute = "policyid" } default { } } #if filter value and filter_attribute, add filter (by default filter_type is equal) if ( $filter_value -and $filter_attribute ) { $invokeParams.add( 'filter_value', $filter_value ) $invokeParams.add( 'filter_attribute', $filter_attribute ) $invokeParams.add( 'filter_type', $filter_type ) } $reponse = Invoke-FGTRestMethod -uri 'api/v2/cmdb/firewall/policy' -method 'GET' -connection $connection @invokeParams $reponse.results } End { } } function Remove-FGTFirewallPolicy { <# .SYNOPSIS Remove a FortiGate Policy .DESCRIPTION Remove a Policy/Rule object on the FortiGate .EXAMPLE $MyFGTPolicy = Get-FGTFirewallPolicy -name MyFGTPolicy PS C:\>$MyFGTPolicy | Remove-FGTFirewallPolicy Remove Policy object $MyFGTPolicy .EXAMPLE $MyFGTPolicy = Get-FGTFirewallPolicy -name MyFGTPolicy PS C:\>$MyFGTPolicy | Remove-FGTFirewallPolicy -confirm:$false Remove Policy object MyFGTPolicy with no confirmation #> [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'high')] Param( [Parameter (Mandatory = $true, ValueFromPipeline = $true, Position = 1)] [ValidateScript( { Confirm-FGTFirewallPolicy $_ })] [psobject]$policy, [Parameter(Mandatory = $false)] [String[]]$vdom, [Parameter(Mandatory = $false)] [psobject]$connection = $DefaultFGTConnection ) Begin { } Process { $invokeParams = @{ } if ( $PsBoundParameters.ContainsKey('vdom') ) { $invokeParams.add( 'vdom', $vdom ) } $uri = "api/v2/cmdb/firewall/policy/$($policy.policyid)" if ($PSCmdlet.ShouldProcess($policy.name, 'Remove Firewall Policy')) { $null = Invoke-FGTRestMethod -method "DELETE" -uri $uri -connection $connection @invokeParams } } End { } } function Remove-FGTFirewallPolicyMember { <# .SYNOPSIS Remove a FortiGate Policy Member .DESCRIPTION Remove a FortiGate Policy Member (source or destination address) .EXAMPLE $MyFGTPolicy = Get-FGTFirewallAddressGroup -name MyFGTPolicy PS C:\>$MyFGTPolicy | Remove-FGTFirewallAddressGroupMember -member MyAddress1 Remove MyAddress1 member to MyFGTPolicy .EXAMPLE $MyFGTPolicy = Get-FGTFirewallAddressGroup -name MyFGTPolicy PS C:\>$MyFGTPolicy | Remove-FGTFirewallAddressGroupMember -member MyAddress1, MyAddress2 Remove MyAddress1 and MyAddress2 member to MyFGTPolicy #> [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'medium')] Param( [Parameter (Mandatory = $true, ValueFromPipeline = $true, Position = 1)] [ValidateScript( { Confirm-FGTFirewallPolicy $_ })] [psobject]$policy, [Parameter(Mandatory = $false)] [string[]]$srcaddr, [Parameter(Mandatory = $false)] [string[]]$dstaddr, [Parameter(Mandatory = $false)] [String[]]$vdom, [Parameter(Mandatory = $false)] [psobject]$connection = $DefaultFGTConnection ) Begin { } Process { $invokeParams = @{ } if ( $PsBoundParameters.ContainsKey('vdom') ) { $invokeParams.add( 'vdom', $vdom ) } $uri = "api/v2/cmdb/firewall/policy/$($policy.policyid)" $_policy = new-Object -TypeName PSObject if ( $PsBoundParameters.ContainsKey('srcaddr') ) { #Create a new source addrarray $members = @() foreach ($m in $policy.srcaddr) { $member_name = @{ } $member_name.add( 'name', $m.name) $members += $member_name } #Remove member foreach ($remove_member in $srcaddr) { #May be a better (and faster) solution... $members = $members | Where-Object { $_.name -ne $remove_member } } #if there is only One or less member force to be an array if ( $members.count -le 1 ) { $members = @($members) } $_policy | add-member -name "srcaddr" -membertype NoteProperty -Value $members } if ( $PsBoundParameters.ContainsKey('dstaddr') ) { #Create a new source addrarray $members = @() foreach ($m in $policy.dstaddr) { $member_name = @{ } $member_name.add( 'name', $m.name) $members += $member_name } #Remove member foreach ($remove_member in $dstaddr) { #May be a better (and faster) solution... $members = $members | Where-Object { $_.name -ne $remove_member } } #if there is only One or less member force to be an array if ( $members.count -le 1 ) { $members = @($members) } $_policy | add-member -name "dstaddr" -membertype NoteProperty -Value $members } if ($PSCmdlet.ShouldProcess($policy.name, 'Remove Firewall Policy Group Member')) { Invoke-FGTRestMethod -method "PUT" -body $_policy -uri $uri -connection $connection @invokeParams | Out-Null Get-FGTFirewallPolicy -connection $connection @invokeParams -name $addrgrp.name } } End { } } |