(PowerShell) SFTP use Cert's Private Key for Authentication (Windows)

Demonstrates how to use the private key of a pre-installed certificate (on Windows) for SFTP authentication. The certificate's private key must be marked as "exportable" when originally installed.

Chilkat .NET Downloads Chilkat .NET Assemblies

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

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

$cert = New-Object Chilkat.Cert

# Load the certificate from the Windows certificate store
$success = $cert.LoadByCommonName("my_cert_common_name")
if ($success -eq $false) {
    $($cert.LastErrorText)
    exit
}

# Get the private key.  
$privKey = $cert.ExportPrivateKey()
if ($cert.LastMethodSuccess -eq $false) {
    $($cert.LastErrorText)
    exit
}

$privKeyPem = $privKey.GetPkcs8Pem()
if ($privKey.LastMethodSuccess -eq $false) {
    $($privKey.LastErrorText)
    exit
}

$sshKey = New-Object Chilkat.SshKey
$success = $sshKey.FromOpenSshPrivateKey($privKeyPem)
if ($success -eq $false) {
    $($sshKey.LastErrorText)
    exit
}

# Connect to an SSH/SFTP server
$sftp = New-Object Chilkat.SFtp
$success = $sftp.Connect("sftp.example.com",22)
if ($success -eq $false) {
    $($sftp.LastErrorText)
    exit
}

# Authenticate with the SSH server using a username + private key.
# (The private key serves as the password.  The username identifies
# the SSH user account on the server.)
$success = $sftp.AuthenticatePk("mySshLogin",$sshKey)
if ($success -eq $false) {
    $($sftp.LastErrorText)
    exit
}

$("OK, the connection and authentication with the SSH server is completed.")

# This example is only to show the connection + authentication using a private key associated with a certificate in the Windows certificate store...