Unicode C

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.

Unicode C

#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;

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

    pkcs11 = CkPkcs11W_Create();

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

    // Use your HSM's PIN.
    pin = L"0000";

    // Normal user = 1
    userType = 1;

    // Establish a logged-on user session with the HSM.
    success = CkPkcs11W_QuickSession(pkcs11,userType,pin);
    if (success == FALSE) {
        wprintf(L"%s\n",CkPkcs11W_lastErrorText(pkcs11));
        CkPkcs11W_Dispose(pkcs11);
        return;
    }

    // Provide a template to find a PKCS11 object.
    jsonTemplate = CkJsonObjectW_Create();

    // Find an RSA private key with the label "MySshKey".
    // Here's an example of how the key was originally imported: 
    // PKCS11 Import SSH Key
    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 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:  
    wprintf(L"private key handle: %u\n",privKeyHandle);

    // We'll also need the PKCS11 public key handle
    // Modify the template by updating the "class" to "public_key"
    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 PKCS11 handles.
    // We also need to indicate 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;
    }

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

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

    // This is where the PKCS11 private key on the smart card is used.
    success = CkSshW_AuthenticatePk(ssh,L"your_ssh_username",sshKey);
    if (success == FALSE) {
        wprintf(L"%s\n",CkSshW_lastErrorText(ssh));
        CkPkcs11W_Dispose(pkcs11);
        CkJsonObjectW_Dispose(jsonTemplate);
        CkSshKeyW_Dispose(sshKey);
        CkSshW_Dispose(ssh);
        return;
    }

    // Do whatever it is your app needs to do using 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);

    }