SSH Authenticate using a Smart Card Private Key

See more SSH Examples

Demonstrates using a private key stored on an HSM (smart card or token) for SSH public-key authentication. A JSON template locates the private and public key objects by class, key type, and label, and the returned handles are bound to an SshKey object.

func chilkatTest() {
    var success: Bool = false

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

    //  Demonstrates using a private key stored on an HSM (smart card or token) for SSH public-key
    //  authentication.  Public-key authentication means the client uses the private key, while the
    //  corresponding public key is installed on the server under the SSH account.
    //  
    //  Note: Chilkat's PKCS#11 implementation runs on Windows, Linux, macOS, and other supported
    //  operating systems.

    let pkcs11 = CkoPkcs11()!

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

    //  The HSM PIN should come from a secure source rather than being hard-coded.
    var pin: String? = "0000"

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

    success = pkcs11.quickSession(userType: userType, pin: pin)
    if success == false {
        print("\(pkcs11.lastErrorText!)")
        return
    }

    //  Provide a template describing the PKCS#11 object to find: an RSA private key labeled
    //  "MySshKey".  For how such a key is originally imported, see
    //  PKCS11 Import SSH Key
    let jsonTemplate = CkoJsonObject()!
    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 handle is only valid for the duration of this PKCS#11 session.  To use the key in a
    //  later session, find it again.
    print("private key handle: \(privKeyHandle)")

    //  Find the corresponding public key by changing the class in the same template.
    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 PKCS#11 handles, indicating the key type.
    let sshKey = CkoSshKey()!
    success = sshKey.usePkcs11(session: pkcs11, privKeyHandle: privKeyHandle, pubKeyHandle: pubKeyHandle, keyType: "rsa")
    if success == false {
        print("\(sshKey.lastErrorText!)")
        return
    }

    let ssh = CkoSsh()!

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

    //  Authentication uses the existing PKCS#11 session.  The signing happens on the smart card --
    //  the private key never leaves the device.
    success = ssh.authenticatePk(username: "mySshLogin", privateKey: sshKey)
    if success == false {
        print("\(ssh.lastErrorText!)")
        return
    }

    print("Public-key authentication successful.")

    //  ... use the authenticated SSH session ...

    ssh.disconnect()

    pkcs11.logout()
    pkcs11.closeSession()

}