PowerShell

Set the FTP Password from a SecureString

Demonstrates the Chilkat Ftp2.SetSecurePassword method, which sets the login password from a SecureString. The only argument is the SecureString. It is equivalent to setting the Password property but avoids holding the password as an ordinary immutable string.

Background: An ordinary string password can linger in memory (and in memory dumps) because strings are immutable and copied freely. A SecureString keeps the value encrypted under a session key and clears it deterministically, reducing that exposure — a sensible upgrade for a credential the process holds for the life of the connection. Populate it from a runtime source rather than a hard-coded literal.

Chilkat PowerShell Downloads

Download Chilkat for PowerShell

PowerShell

Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"

$success = $false

#  Demonstrates the Ftp2.SetSecurePassword method, which sets the login password from a
#  SecureString.  The only argument is the SecureString.  This avoids holding the password as an
#  ordinary immutable string.

$ftp = New-Object Chilkat.Ftp2

$ftp.Hostname = "ftp.example.com"
$ftp.Username = "myFtpLogin"

#  Normally you would not hard-code the password in source.  You should instead obtain it
#  from an interactive prompt, environment variable, or a secrets vault.
$password = "myPassword"

#  Place the password into a SecureString, which keeps it encrypted in memory.
$securePassword = New-Object Chilkat.SecureString
$securePassword.Append($password)

#  Setting the secure password is equivalent to setting the Password property, but more
#  protective.
$success = $ftp.SetSecurePassword($securePassword)
if ($success -eq $false) {
    $($ftp.LastErrorText)
    exit
}

$success = $ftp.Connect()
if ($success -eq $false) {
    $($ftp.LastErrorText)
    exit
}

$("Connected using a secure password.")

$success = $ftp.Disconnect()
if ($success -eq $false) {
    $($ftp.LastErrorText)
    exit
}