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.

#include <C_CkPkcs11W.h>
#include <C_CkJsonObjectW.h>
#include <C_CkSshKeyW.h>
#include <C_CkSshW.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkPkcs11W pkcs11;
    const wchar_t *pin;
    int userType;
    HCkJsonObjectW jsonTemplate;
    unsigned long privKeyHandle;
    unsigned long pubKeyHandle;
    HCkSshKeyW sshKey;
    HCkSshW ssh;
    int port;

    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 = CkPkcs11W_Create();

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

    //  Normal user = 1
    userType = 1;

    success = CkPkcs11W_QuickSession(pkcs11,userType,pin);
    if (success == FALSE) {
        wprintf(L"%s\n",CkPkcs11W_lastErrorText(pkcs11));
        CkPkcs11W_Dispose(pkcs11);
        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 = CkJsonObjectW_Create();
    CkJsonObjectW_UpdateString(jsonTemplate,L"class",L"private_key");
    CkJsonObjectW_UpdateString(jsonTemplate,L"key_type",L"rsa");
    CkJsonObjectW_UpdateString(jsonTemplate,L"label",L"MySshKey");

    privKeyHandle = CkPkcs11W_FindObject(pkcs11,jsonTemplate);
    if (privKeyHandle == 0) {
        wprintf(L"%s\n",CkPkcs11W_lastErrorText(pkcs11));
        CkPkcs11W_Dispose(pkcs11);
        CkJsonObjectW_Dispose(jsonTemplate);
        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.
    wprintf(L"private key handle: %u\n",privKeyHandle);

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

    pubKeyHandle = CkPkcs11W_FindObject(pkcs11,jsonTemplate);
    if (pubKeyHandle == 0) {
        wprintf(L"%s\n",CkPkcs11W_lastErrorText(pkcs11));
        CkPkcs11W_Dispose(pkcs11);
        CkJsonObjectW_Dispose(jsonTemplate);
        return;
    }

    wprintf(L"public key handle: %u\n",pubKeyHandle);

    //  Create an empty SSH key object and tell it to use the PKCS#11 handles, indicating the key type.
    sshKey = CkSshKeyW_Create();
    success = CkSshKeyW_UsePkcs11(sshKey,pkcs11,privKeyHandle,pubKeyHandle,L"rsa");
    if (success == FALSE) {
        wprintf(L"%s\n",CkSshKeyW_lastErrorText(sshKey));
        CkPkcs11W_Dispose(pkcs11);
        CkJsonObjectW_Dispose(jsonTemplate);
        CkSshKeyW_Dispose(sshKey);
        return;
    }

    ssh = CkSshW_Create();

    port = 22;
    success = CkSshW_Connect(ssh,L"ssh.example.com",port);
    if (success == FALSE) {
        wprintf(L"%s\n",CkSshW_lastErrorText(ssh));
        CkPkcs11W_Dispose(pkcs11);
        CkJsonObjectW_Dispose(jsonTemplate);
        CkSshKeyW_Dispose(sshKey);
        CkSshW_Dispose(ssh);
        return;
    }

    //  Authentication uses the existing PKCS#11 session.  The signing happens on the smart card --
    //  the private key never leaves the device.
    success = CkSshW_AuthenticatePk(ssh,L"mySshLogin",sshKey);
    if (success == FALSE) {
        wprintf(L"%s\n",CkSshW_lastErrorText(ssh));
        CkPkcs11W_Dispose(pkcs11);
        CkJsonObjectW_Dispose(jsonTemplate);
        CkSshKeyW_Dispose(sshKey);
        CkSshW_Dispose(ssh);
        return;
    }

    wprintf(L"Public-key authentication successful.\n");

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

    CkSshW_Disconnect(ssh);

    CkPkcs11W_Logout(pkcs11);
    CkPkcs11W_CloseSession(pkcs11);


    CkPkcs11W_Dispose(pkcs11);
    CkJsonObjectW_Dispose(jsonTemplate);
    CkSshKeyW_Dispose(sshKey);
    CkSshW_Dispose(ssh);

    }