Swift

SCP Download Text File to String Variable

See more SCP Examples

Downloads a file using the SCP protocol (Secure Copy Protocol over SSH), from a specific remote directory located on the SSH server directly into a string variable. Swift

func chilkatTest() {
    var success: Bool = false

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

    let ssh = CkoSsh()!

    // Hostname may be an IP address or hostname:
    var hostname: String? = "www.some-ssh-server.com"
    var port: Int = 22

    // Connect to an SSH server:
    success = ssh.connect(hostname: hostname, port: port)
    if success != true {
        print("\(ssh.lastErrorText!)")
        return
    }

    // Wait a max of 5 seconds when reading responses..
    ssh.idleTimeoutMs = 5000

    // Authenticate using login/password:
    success = ssh.authenticatePw(login: "myLogin", password: "myPassword")
    if success != true {
        print("\(ssh.lastErrorText!)")
        return
    }

    // Once the SSH object is connected and authenticated, we use it
    // in our SCP object.
    let scp = CkoScp()!

    success = scp.useSsh(sshConnection: ssh)
    if success != true {
        print("\(scp.lastErrorText!)")
        return
    }

    // This downloads a file from the "repositor/xml/" subdirectory (relative to the SSH user account's HOME directory).  
    var remotePath: String? = "repository/xml/hamlet.xml"

    // The byte representation of the remote text file (i.e. the charset) must be
    // indicated to allow the receiving software to correctly interpret the incoming
    // bytes as the correct chars.
    // See https://www.chilkatsoft.com/p/p_463.asp for a list of valid charset names.
    var charset: String? = "utf-8"

    var fileContents: String? = scp.downloadString(remotePath: remotePath, charset: charset)
    if scp.lastMethodSuccess != true {
        print("\(scp.lastErrorText!)")
        return
    }

    print("Received file:")
    print("\(fileContents!)")

    print("SCP download string success.")

    // Disconnect
    ssh.disconnect()

}