PureBasic

SFTP Authenticate Secure

Demonstrates how to do SFTP password authentication with secure strings.

This example requires Chilkat v9.5.0.71 or greater.

PureBasic

IncludeFile "CkJsonObject.pb"
IncludeFile "CkSecureString.pb"
IncludeFile "CkSFtp.pb"
IncludeFile "CkCrypt2.pb"

Procedure ChilkatExample()

    success.i = 0

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

    ; Imagine we've previously saved our encrypted login and password within a JSON config file
    ; that contains this:

    ; {
    ;   "ssh_login": "2+qylFfC56Ck7OQQt/U2/w==",
    ;   "ssh_password": "5neIq9Jmn0E3p71N6Yc8TA=="
    ; }

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadFile(json,"qa_data/passwords/ssh.json")

    crypt.i = CkCrypt2::ckCreate()
    If crypt.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; These are the encryption settings we previously used to encrypt the credentials within the JSON config file.
    CkCrypt2::setCkCryptAlgorithm(crypt, "aes")
    CkCrypt2::setCkCipherMode(crypt, "cbc")
    CkCrypt2::setCkKeyLength(crypt, 128)
    CkCrypt2::ckSetEncodedKey(crypt,"000102030405060708090A0B0C0D0E0F","hex")
    CkCrypt2::ckSetEncodedIV(crypt,"000102030405060708090A0B0C0D0E0F","hex")
    CkCrypt2::setCkEncodingMode(crypt, "base64")

    ssLogin.i = CkSecureString::ckCreate()
    If ssLogin.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ssPassword.i = CkSecureString::ckCreate()
    If ssPassword.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Decrypt to the secure string.  (the strings will still held in memory encrypted, but are now encrypted using
    ; a randomly generated session key.)
    CkCrypt2::ckDecryptSecureENC(crypt,CkJsonObject::ckStringOf(json,"ssh_login"),ssLogin)
    CkCrypt2::ckDecryptSecureENC(crypt,CkJsonObject::ckStringOf(json,"ssh_password"),ssPassword)

    sftp.i = CkSFtp::ckCreate()
    If sftp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkSFtp::ckConnect(sftp,"MY-SSH-SERVER-DOMAIN-OR-IP",22)
    If success <> 1
        Debug CkSFtp::ckLastErrorText(sftp)
        CkJsonObject::ckDispose(json)
        CkCrypt2::ckDispose(crypt)
        CkSecureString::ckDispose(ssLogin)
        CkSecureString::ckDispose(ssPassword)
        CkSFtp::ckDispose(sftp)
        ProcedureReturn
    EndIf

    ; Authenticate using secure strings
    success = CkSFtp::ckAuthenticateSecPw(sftp,ssLogin,ssPassword)
    If success <> 1
        Debug CkSFtp::ckLastErrorText(sftp)
        CkJsonObject::ckDispose(json)
        CkCrypt2::ckDispose(crypt)
        CkSecureString::ckDispose(ssLogin)
        CkSecureString::ckDispose(ssPassword)
        CkSFtp::ckDispose(sftp)
        ProcedureReturn
    EndIf

    Debug "SFTP Authentication successful."

    CkSFtp::ckDisconnect(sftp)


    CkJsonObject::ckDispose(json)
    CkCrypt2::ckDispose(crypt)
    CkSecureString::ckDispose(ssLogin)
    CkSecureString::ckDispose(ssPassword)
    CkSFtp::ckDispose(sftp)


    ProcedureReturn
EndProcedure