Swift

SSH Authenticate using Smart Card Private Key

See more SSH Examples

Demonstrates how to use a private key stored on an HSM (smartcard or token) for SSH public-key authentication. (Public-key authentication means the client, which is your application, uses the private key, while the corresponding public key is installed on the server under your SSH account.)

Note: This example requires Chilkat v9.5.0.96 or later.

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.

    // Note: Chilkat's PKCS11 implementation runs on Windows, Linux, Mac OS X, and other supported operating systems.

    let pkcs11 = CkoPkcs11()!

    // Use the PKCS11 driver (.dll, .so, .dylib) for your particular HSM.
    // For example:
    pkcs11.sharedLibPath = "C:/Program Files (x86)/Gemalto/IDGo 800 PKCS#11/IDPrimePKCS11.dll"

    // Use your HSM's PIN.
    var pin: String? = "0000"

    // Normal user = 1
    var userType: Int = 1

    // Establish a logged-on user session with the HSM.
    success = pkcs11.quickSession(userType: userType, pin: pin)
    if success == false {
        print("\(pkcs11.lastErrorText!)")
        return
    }

    // Provide a template to find a PKCS11 object.
    let jsonTemplate = CkoJsonObject()!

    // Find an RSA private key with the label "MySshKey".
    // Here's an example of how the key was originally imported: 
    // PKCS11 Import SSH Key
    jsonTemplate.updateString(jsonPath: "class", value: "private_key")
    jsonTemplate.updateString(jsonPath: "key_type", value: "rsa")
    jsonTemplate.updateString(jsonPath: "label", value: "MySshKey")

    var privKeyHandle: UInt32 = pkcs11.find(jsonTemplate: jsonTemplate)
    if privKeyHandle == 0 {
        print("\(pkcs11.lastErrorText!)")
        return
    }

    // The private key handle is only valid during the PKCS11 session.
    // If you wish to use the private key in another PKCS11 session,
    // you'll first need to find it.  See:  
    print("private key handle: \(privKeyHandle)")

    // We'll also need the PKCS11 public key handle
    // Modify the template by updating the "class" to "public_key"
    jsonTemplate.updateString(jsonPath: "class", value: "public_key")

    var pubKeyHandle: UInt32 = pkcs11.find(jsonTemplate: jsonTemplate)
    if pubKeyHandle == 0 {
        print("\(pkcs11.lastErrorText!)")
        return
    }

    print("public key handle: \(pubKeyHandle)")

    // Create an empty SSH key object, and tell it to use the PKCS11 handles.
    // We also need to indicate the key type.
    let sshKey = CkoSshKey()!
    success = sshKey.usePkcs11(session: pkcs11, privKeyHandle: privKeyHandle, pubKeyHandle: pubKeyHandle, keyType: "rsa")
    if success == false {
        print("\(sshKey.lastErrorText!)")
        return
    }

    // Create an SSH object and authenticate using the SSH key, which will utilize the existing PKCS11 session.
    let ssh = CkoSsh()!

    success = ssh.connect(hostname: "my-ssh-server.com", port: 22)
    if success == false {
        print("\(ssh.lastErrorText!)")
        return
    }

    // This is where the PKCS11 private key on the smart card is used.
    success = ssh.authenticatePk(username: "your_ssh_username", privateKey: sshKey)
    if success == false {
        print("\(ssh.lastErrorText!)")
        return
    }

    // Do whatever it is your app needs to do using the authenticated SSH session....
    // ...
    // ...

    ssh.disconnect()

    pkcs11.logout()
    pkcs11.closeSession()

}