Public/New-WinSCPSession.ps1
|
Function New-WinSCPSession { [CmdletBinding( SupportsShouldProcess = $true, HelpUri = 'https://github.com/dotps1/WinSCP/wiki/New-WinSCPSession' )] [OutputType( [WinSCP.Session] )] Param ( [Parameter( Mandatory = $true, ValueFromPipeline = $true )] [ValidateNotNull()] [System.Management.Automation.PSCredential] [System.Management.Automation.Credential()] $Credential, [Parameter()] [WinSCP.FtpMode] $FtpMode = (New-Object -TypeName WinSCP.FtpMode), [Parameter()] [WinSCP.FtpSecure] $FtpSecure = (New-Object -TypeName WinSCP.FtpSecure), [Parameter()] [Switch] $GiveUpSecurityAndAcceptAnySshHostKey, [Parameter()] [Switch] $GiveUpSecureityAndAcceptAnyTlsHostCertificate, [Parameter( Mandatory = $true )] [String] $HostName = $null, [Parameter()] [Int] $PortNumber = 0, [Parameter()] [WinSCP.Protocol] $Protocol = (New-Object -TypeName WinSCP.Protocol), [Parameter( ValueFromPipelineByPropertyName = $true )] [String[]] $SshHostKeyFingerprint = $null, [Parameter()] [ValidateScript({ if (Test-Path -Path $_) { return $true } else { throw "$_ not found." } })] [String] $SshPrivateKeyPath = $null, [Parameter( ValueFromPipelineByPropertyName = $true )] [SecureString] $SshPrivateKeySecurePassphrase = $null, [Parameter( ValueFromPipelineByPropertyName = $true )] [String] $TlsHostCertificateFingerprint = $null, [Parameter()] [TimeSpan] $Timeout = (New-TimeSpan -Seconds 15), [Parameter()] [Switch] $WebdavSecure, [Parameter()] [String] $WebdavRoot = $null, [Parameter()] [HashTable] $RawSetting = $null, [Parameter()] [ValidateScript({ if (Test-Path -Path (Split-Path -Path $_)) { return $true } else { throw "Path not found $(Split-Path -Path $_)." } })] [String] $DebugLogPath = $null, [Parameter()] [ValidateScript({ if (Test-Path -Path (Split-Path -Path $_)) { return $true } else { throw "Path not found $(Split-Path -Path $_)." } })] [String] $SessionLogPath = $null, [Parameter()] [TimeSpan] $ReconnectTime = (New-TimeSpan -Seconds 120), [Parameter()] [ScriptBlock] $FileTransferProgress = $null ) # Create WinSCP.Session and WinSCP.SessionOptions Objects, parameter values will be assigned to matching object properties. $sessionOptions = New-Object -TypeName WinSCP.SessionOptions $session = New-Object -TypeName WinSCP.Session -Property @{ ExecutablePath = "$PSScriptRoot\..\bin\winscp.exe" } # Convert PSCredential Object to match names of the WinSCP.SessionOptions Object. $PSBoundParameters.Add('UserName', $Credential.UserName) $PSBoundParameters.Add('SecurePassword', $Credential.Password) # Resolve Full Path, WinSCP.exe does not like dot sourced path for the Certificate. if (-not [String]::IsNullOrEmpty($SshPrivateKeyPath)) { $PSBoundParameters.SshPrivateKeyPath = (Resolve-Path -Path $SshPrivateKeyPath).Path } # Convert SshPrivateKeySecurePasspahrase to plain text and set it to the corresponding SessionOptions property. if ($SshPrivateKeySecurePassphrase -ne $null) { try { $sessionOptions.SshPrivateKeyPassphrase = [System.Runtime.InteropServices.Marshal]::PtrToStringAuto([System.Runtime.InteropServices.Marshal]::SecureStringToBSTR($SshPrivateKeySecurePassphrase)) } catch { Write-Error -Message $_.ToString() return $null } } try { # Enumerate each parameter. foreach ($key in $PSBoundParameters.Keys) { # If the property is a member of the WinSCP.SessionOptions object, set the matching value. if (($sessionOptions | Get-Member -MemberType Properties).Name -contains $key) { $sessionOptions.$key = $PSBoundParameters.$key } # If the property is a member of the WinSCP.Session object, set the matching value. elseif (($session | Get-Member -MemberType Properties).Name -contains $key) { $session.$key = $PSBoundParameters.$key } } # Enumerate raw settings and add the options to the WinSCP.SessionOptions object. foreach ($key in $RawSetting.Keys) { $sessionOptions.AddRawSettings($key, $RawSetting[$key]) } # Add FileTransferProgress ScriptBlock if present. if ($FileTransferProgress -ne $null) { $session.Add_FileTransferProgress($FileTransferProgress) } } catch { Write-Error -Message $_.ToString() return $null } if ($PSCmdlet.ShouldProcess($session)) { try { # Open the WinSCP.Session object using the WinSCP.SessionOptions object. $session.Open($sessionOptions) # Set the default -WinSCPSession Parameter Value for other cmdlets. Get-Command -Module WinSCP -ParameterName WinSCPSession | ForEach-Object { $Global:PSDefaultParameterValues.Remove("$($_.Name):WinSCPSession") $Global:PSDefaultParameterValues.Add("$($_.Name):WinSCPSession", $session) } # Return the WinSCP.Session object. return $session } catch { Write-Error -Message $_.ToString() $session.Dispose() return $null } } } |