Swift

Open a Custom SSH Channel Type

Demonstrates the Chilkat Ssh.OpenCustomChannel method, which requests a channel whose application-defined type is supplied as the only argument. It returns the channel number, or -1 if the server rejects the channel. The server must implement that channel type.

Background: The SSH protocol allows vendor- and application-specific channel types beyond the standard session and direct-tcpip kinds; by convention these carry an @domain suffix to avoid name collisions. This method is the escape hatch for talking to a server that implements such a type. On rejection, inspect ChannelOpenFailCode to learn why.

Chilkat Swift Downloads

Download Chilkat for Swift

Swift


func chilkatTest() {
    var success: Bool = false

    //  Demonstrates the Ssh.OpenCustomChannel method, which requests a custom SSH channel whose
    //  application-defined type is supplied as the only argument.  It returns the channel number,
    //  or -1 if the server rejects the channel.  The server must implement that channel type.

    let ssh = CkoSsh()!

    var sshPort: Int = 22
    success = ssh.connect(hostname: "ssh.example.com", port: sshPort)
    if success == false {
        print("\(ssh.lastErrorText!)")
        return
    }

    //  Normally you would not hard-code the password in source.  You should instead obtain it
    //  from an interactive prompt, environment variable, or a secrets vault.
    var password: String? = "mySshPassword"

    success = ssh.authenticatePw(login: "mySshLogin", password: password)
    if success == false {
        print("\(ssh.lastErrorText!)")
        return
    }

    //  Request an application-defined channel type.  The server must support it.
    var channelType: String? = "my-custom-channel@example.com"
    var channelNum: Int = ssh.openCustomChannel(channelType: channelType).intValue
    if channelNum < 0 {
        print("\(ssh.lastErrorText!)")
        return
    }

    print("Opened custom channel: \(channelNum)")

    //  The channel is used with the normal channel send, receive, EOF, CLOSE, and release methods.

    ssh.disconnect()

}