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.

    success := 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.

    pkcs11 := chilkat.NewPkcs11()

    //  Use the PKCS#11 driver (.dll, .so, or .dylib) for your particular HSM.
    pkcs11.SetSharedLibPath("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.
    pin := "0000"

    //  Normal user = 1
    userType := 1

    success = pkcs11.QuickSession(userType,pin)
    if success == false {
        fmt.Println(pkcs11.LastErrorText())
        pkcs11.DisposePkcs11()
        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
    jsonTemplate := chilkat.NewJsonObject()
    jsonTemplate.UpdateString("class","private_key")
    jsonTemplate.UpdateString("key_type","rsa")
    jsonTemplate.UpdateString("label","MySshKey")

    privKeyHandle := pkcs11.FindObject(jsonTemplate)
    if privKeyHandle == 0 {
        fmt.Println(pkcs11.LastErrorText())
        pkcs11.DisposePkcs11()
        jsonTemplate.DisposeJsonObject()
        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.
    fmt.Println("private key handle: ", privKeyHandle)

    //  Find the corresponding public key by changing the class in the same template.
    jsonTemplate.UpdateString("class","public_key")

    pubKeyHandle := pkcs11.FindObject(jsonTemplate)
    if pubKeyHandle == 0 {
        fmt.Println(pkcs11.LastErrorText())
        pkcs11.DisposePkcs11()
        jsonTemplate.DisposeJsonObject()
        return
    }

    fmt.Println("public key handle: ", pubKeyHandle)

    //  Create an empty SSH key object and tell it to use the PKCS#11 handles, indicating the key type.
    sshKey := chilkat.NewSshKey()
    success = sshKey.UsePkcs11(pkcs11,privKeyHandle,pubKeyHandle,"rsa")
    if success == false {
        fmt.Println(sshKey.LastErrorText())
        pkcs11.DisposePkcs11()
        jsonTemplate.DisposeJsonObject()
        sshKey.DisposeSshKey()
        return
    }

    ssh := chilkat.NewSsh()

    port := 22
    success = ssh.Connect("ssh.example.com",port)
    if success == false {
        fmt.Println(ssh.LastErrorText())
        pkcs11.DisposePkcs11()
        jsonTemplate.DisposeJsonObject()
        sshKey.DisposeSshKey()
        ssh.DisposeSsh()
        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("mySshLogin",sshKey)
    if success == false {
        fmt.Println(ssh.LastErrorText())
        pkcs11.DisposePkcs11()
        jsonTemplate.DisposeJsonObject()
        sshKey.DisposeSshKey()
        ssh.DisposeSsh()
        return
    }

    fmt.Println("Public-key authentication successful.")

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

    ssh.Disconnect()

    pkcs11.Logout()
    pkcs11.CloseSession()

    pkcs11.DisposePkcs11()
    jsonTemplate.DisposeJsonObject()
    sshKey.DisposeSshKey()
    ssh.DisposeSsh()