PureBasic

SCP Download from a Specific Directory

See more SCP Examples

Demonstrates how to download a file using the SCP protocol (Secure Copy Protocol over SSH), from a specific remote directory located on the SSH server. The remote directory can be a path relative to the HOME directory of the SSH user account, or an absolute path on the remote filesystem. Obviously, in both cases the SSH user account must have permission to open and read the file in the specified directory. PureBasic

IncludeFile "CkSsh.pb"
IncludeFile "CkScp.pb"

Procedure ChilkatExample()

    success.i = 0

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

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

    ; Hostname may be an IP address or hostname:
    hostname.s = "www.some-ssh-server.com"
    port.i = 22

    ; Connect to an SSH server:
    success = CkSsh::ckConnect(ssh,hostname,port)
    If success <> 1
        Debug CkSsh::ckLastErrorText(ssh)
        CkSsh::ckDispose(ssh)
        ProcedureReturn
    EndIf

    ; Wait a max of 5 seconds when reading responses..
    CkSsh::setCkIdleTimeoutMs(ssh, 5000)

    ; Authenticate using login/password:
    success = CkSsh::ckAuthenticatePw(ssh,"myLogin","myPassword")
    If success <> 1
        Debug CkSsh::ckLastErrorText(ssh)
        CkSsh::ckDispose(ssh)
        ProcedureReturn
    EndIf

    ; Once the SSH object is connected and authenticated, we use it
    ; in our SCP object.
    scp.i = CkScp::ckCreate()
    If scp.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkScp::ckUseSsh(scp,ssh)
    If success <> 1
        Debug CkScp::ckLastErrorText(scp)
        CkSsh::ckDispose(ssh)
        CkScp::ckDispose(scp)
        ProcedureReturn
    EndIf

    ; This downloads a file from the "testApp/logs/" subdirectory (relative to the SSH user account's HOME directory).  
    ; For example, if the HOME directory is /Users/chilkat, then the following downloads
    ; /Users/chilkat/testApp/logs/test1.log
    remotePath.s = "testApp/logs/test1.log"
    localPath.s = "c:/testApp/logs/test1.log"
    success = CkScp::ckDownloadFile(scp,remotePath,localPath)
    If success <> 1
        Debug CkScp::ckLastErrorText(scp)
        CkSsh::ckDispose(ssh)
        CkScp::ckDispose(scp)
        ProcedureReturn
    EndIf

    ; The following call to DownloadFile specifies an absolute file path on the SSH server:
    remotePath = "/Users/chilkat/Documents/gecko.jpg"
    localPath = "c:/temp/images/gecko.jpg"
    success = CkScp::ckDownloadFile(scp,remotePath,localPath)
    If success <> 1
        Debug CkScp::ckLastErrorText(scp)
        CkSsh::ckDispose(ssh)
        CkScp::ckDispose(scp)
        ProcedureReturn
    EndIf

    Debug "SCP download file success."

    ; Disconnect
    CkSsh::ckDisconnect(ssh)


    CkSsh::ckDispose(ssh)
    CkScp::ckDispose(scp)


    ProcedureReturn
EndProcedure