Public/Connection.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 |
# # Copyright 2018, Alexis La Goutte <alexis dot lagoutte at gmail dot com> # # SPDX-License-Identifier: Apache-2.0 # function Connect-FMG { <# .SYNOPSIS Connect to a FortiManager .DESCRIPTION Connect to a FortiManager .EXAMPLE Connect-FMG -Server 192.0.2.1 Connect to a FortiManager with IP 192.0.2.1 .EXAMPLE Connect-FMG -Server 192.0.2.1 -SkipCertificateCheck Connect to a FortiManager with IP 192.0.2.1 and disable Certificate (chain) check .EXAMPLE Connect-FMG -Server 192.0.2.1 -port 4443 Connect to a FortiManager using HTTPS (with port 4443) with IP 192.0.2.1 using (Get-)credential .EXAMPLE $cred = get-credential Connect-FMG -Server 192.0.2.1 -credential $cred Connect to a FortiManager with IP 192.0.2.1 and passing (Get-)credential .EXAMPLE $mysecpassword = ConvertTo-SecureString mypassword -AsPlainText -Force Connect-FMG -Server 192.0.2.1 -Username manager -Password $mysecpassword Connect to a FortiManager with IP 192.0.2.1 using Username and Password .EXAMPLE $fw1 = Connect-FMG -Server 192.0.2.1 Connect to a FortiManager with IP 192.0.2.1 and store connection info to $fw1 variable .EXAMPLE $fw2 = Connect-FMG -Server 192.0.2.1 -DefaultConnection:$false Connect to a FortiManager with IP 192.0.2.1 and store connection info to $fw2 variable and don't store connection on global ($DefaultFMGConnection) variable #> Param( [Parameter(Mandatory = $true, position = 1)] [String]$Server, [Parameter(Mandatory = $false)] [String]$Username, [Parameter(Mandatory = $false)] [SecureString]$Password, [Parameter(Mandatory = $false)] [PSCredential]$Credential, [Parameter(Mandatory = $false)] [switch]$SkipCertificateCheck = $false, [Parameter(Mandatory = $false)] [ValidateRange(1, 65535)] [int]$port, [Parameter(Mandatory = $false)] [int]$Timeout = 0, [Parameter(Mandatory = $false)] [string]$adom = "root", [Parameter(Mandatory = $false)] [boolean]$DefaultConnection = $true ) Begin { } Process { $connection = @{server = ""; session = ""; websession = ""; port = ""; headers = ""; invokeParams = ""; adom = ""; version = "" ; id = 0 } #If there is a password (and a user), create a credential if ($Password) { $Credential = New-Object System.Management.Automation.PSCredential($Username, $Password) } #Not Credential (and no password) if ($null -eq $Credential) { $Credential = Get-Credential -Message 'Please enter administrative credential for your FortiManager' } $postParams = @{ id = $connection.id++ method = "exec" verbose = 1 session = $null params = @( @{ data = @{ user = $Credential.username; passwd = $Credential.GetNetworkCredential().Password; } url = 'sys/login/user' } ) } $invokeParams = @{DisableKeepAlive = $false; UseBasicParsing = $true; SkipCertificateCheck = $SkipCertificateCheck; TimeoutSec = $Timeout } if ("Desktop" -eq $PSVersionTable.PsEdition) { #Remove -SkipCertificateCheck from Invoke Parameter (not supported <= PS 5) $invokeParams.remove("SkipCertificateCheck") } else { #Core Edition #Remove -UseBasicParsing (Enable by default with PowerShell 6/Core) $invokeParams.remove("UseBasicParsing") } if (!$port) { $port = 443 } #for PowerShell (<=) 5 (Desktop), Enable TLS 1.1, 1.2 and Disable SSL chain trust (needed/recommanded by FortiManager) if ("Desktop" -eq $PSVersionTable.PsEdition) { #Enable TLS 1.1 and 1.2 Set-FMGCipherSSL if ($SkipCertificateCheck) { #Disable SSL chain trust... Set-FMGuntrustedSSL } } $uri = "https://${Server}:${port}/jsonrpc" try { $irmResponse = Invoke-RestMethod $uri -Method POST -Body ($postParams | ConvertTo-Json -Depth 10) -SessionVariable FMG @invokeParams } catch { Show-FMGException $_ throw "Unable to connect to FortiManager" } # if ($irmResponse.result.status.code -ne "0") { throw "Unable to connect to FortiManager (" + $irmResponse.result.status.code + ") " + $irmResponse.result.status.message } $connection.server = $server $connection.session = $irmResponse.session $connection.websession = $FMG $connection.headers = $headers $connection.port = $port $connection.invokeParams = $invokeParams $connection.adom = $adom #get FMG version $status = Invoke-FMGRestMethod sys/status -connection $connection $connection.version = [version]"$($status.major).$($status.minor).$($status.patch)" if ( $DefaultConnection ) { set-variable -name DefaultFMGConnection -value $connection -scope Global } $connection } End { } } function Disconnect-FMG { <# .SYNOPSIS Disconnect a FortiManager .DESCRIPTION Disconnect the connection of FortiManager .EXAMPLE Disconnect-FMG Disconnect the connection .EXAMPLE Disconnect-FMG -confirm:$false Disconnect the connection with no confirmation #> [CmdletBinding(SupportsShouldProcess, ConfirmImpact = 'High')] Param( [Parameter(Mandatory = $false)] [psobject]$connection = $DefaultFMGConnection ) Begin { } Process { $url = "sys/logout" if ($PSCmdlet.ShouldProcess($connection.server, 'Proceed with removal of FortiManager connection ?')) { $null = Invoke-FMGRestMethod -method "exec" -uri $url -connection $connection if (Test-Path variable:global:DefaultFMGConnection) { Remove-Variable -name DefaultFMGConnection -scope global } } } End { } } |