SFTP Set Allowed SSH Algorithms

See more SFTP Examples

Demonstrates the Chilkat SFtp.SetAllowedAlgorithms method, which configures the exact set of SSH algorithms permitted for the connection. A JsonObject supplies comma-separated allow-lists for the kex, hostKey, cipher, and mac categories. It must be called before Connect.

Important: You typically should not set allowed algorithms explicitly. By default Chilkat orders algorithms according to best practices and accounts for known vulnerabilities.

integer li_rc
integer li_Success
oleobject loo_Sftp
oleobject loo_Json
string ls_Allowed_kex
string ls_Allowed_hostKey
string ls_Allowed_cipher
string ls_Allowed_mac
integer li_Port

li_Success = 0

//  Demonstrates the SFtp.SetAllowedAlgorithms method, which configures the exact set of SSH
//  algorithms permitted for the connection.  The only argument is a JsonObject.  It must be
//  called before Connect.
//  
//  -------------------------------------------------------------------------------------------
//  Note: You typically should NOT explicitly set allowed algorithms.
//  By default, Chilkat orders algorithms according to best practices and accounts for known
//  vulnerabilities such as the "Terrapin Attack".  Hard-coding algorithms can make an
//  application brittle over time: if a server later changes its allowed algorithms, or if you
//  connect to a different server, the client and server may fail to agree on a mutually
//  supported set.
//  -------------------------------------------------------------------------------------------

loo_Sftp = create oleobject
li_rc = loo_Sftp.ConnectToNewObject("Chilkat.SFtp")
if li_rc < 0 then
    destroy loo_Sftp
    MessageBox("Error","Connecting to COM object failed")
    return
end if

loo_Json = create oleobject
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")

//  The algorithms supported by Chilkat, by category:
//  
//  Key-exchange:
//    curve25519-sha256
//    curve25519-sha256@libssh.org
//    ecdh-sha2-nistp256
//    ecdh-sha2-nistp384
//    ecdh-sha2-nistp521
//    diffie-hellman-group14-sha256
//    diffie-hellman-group16-sha512
//    diffie-hellman-group18-sha512
//    diffie-hellman-group-exchange-sha256
//    diffie-hellman-group1-sha1
//    diffie-hellman-group14-sha1
//    diffie-hellman-group-exchange-sha1
//  
//  Host key:
//    ssh-ed25519
//    ecdsa-sha2-nistp256
//    ecdsa-sha2-nistp384
//    ecdsa-sha2-nistp521
//    rsa-sha2-256
//    rsa-sha2-512
//    ssh-rsa
//    ssh-dss
//  
//  Cipher (encryption):
//    chacha20-poly1305@openssh.com
//    aes128-ctr
//    aes256-ctr
//    aes192-ctr
//    aes128-cbc
//    aes256-cbc
//    aes192-cbc
//    aes128-gcm@openssh.com
//    aes256-gcm@openssh.com
//    twofish256-cbc
//    twofish128-cbc
//    blowfish-cbc
//  
//  MAC (hash):
//    hmac-sha2-256
//    hmac-sha2-512
//    hmac-sha2-256-etm@openssh.com
//    hmac-sha2-512-etm@openssh.com
//    hmac-sha1-etm@openssh.com
//    hmac-sha1
//    hmac-ripemd160
//    hmac-sha1-96
//    hmac-md5

//  List the allowed key-exchange, host-key, cipher (encryption), and mac (hash) algorithms, in
//  order of preference.
ls_Allowed_kex = "curve25519-sha256@libssh.org,ecdh-sha2-nistp256"
ls_Allowed_hostKey = "ssh-ed25519,ecdsa-sha2-nistp256"
ls_Allowed_cipher = "chacha20-poly1305@openssh.com,aes256-ctr"
ls_Allowed_mac = "hmac-sha2-256,hmac-sha2-512"

loo_Json.UpdateString("kex",ls_Allowed_kex)
loo_Json.UpdateString("hostKey",ls_Allowed_hostKey)
loo_Json.UpdateString("cipher",ls_Allowed_cipher)
loo_Json.UpdateString("mac",ls_Allowed_mac)

//  Apply the allow-list before connecting.
li_Success = loo_Sftp.SetAllowedAlgorithms(loo_Json)
if li_Success = 0 then
    Write-Debug loo_Sftp.LastErrorText
    destroy loo_Sftp
    destroy loo_Json
    return
end if

li_Port = 22
li_Success = loo_Sftp.Connect("sftp.example.com",li_Port)
if li_Success = 0 then
    Write-Debug loo_Sftp.LastErrorText
    destroy loo_Sftp
    destroy loo_Json
    return
end if

Write-Debug "Connected."

loo_Sftp.Disconnect()


destroy loo_Sftp
destroy loo_Json