C

Import an SSH Key to an HSM using PKCS11

See more PKCS11 Examples

Demonstrates how to import an SSH private key to an HSM (smartcard or token).

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

C

#include <C_CkPkcs11.h>
#include <C_CkJsonObject.h>
#include <C_CkSshKey.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkPkcs11 pkcs11;
    const char *pin;
    int userType;
    HCkJsonObject jsonTemplate;
    HCkSshKey sshKey;
    const char *ppkContents;
    unsigned long privKeyHandle;

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

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

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

    // Normal user = 1
    userType = 1;

    // Establish a logged-on user session with the HSM.
    success = CkPkcs11_QuickSession(pkcs11,userType,pin);
    if (success == FALSE) {
        printf("%s\n",CkPkcs11_lastErrorText(pkcs11));
        CkPkcs11_Dispose(pkcs11);
        return;
    }

    // Create a PKCS11 template for importing the SSH key.
    jsonTemplate = CkJsonObject_Create();

    // Indicate the key is to be stored on the token (i.e. it is not a session-only key)
    CkJsonObject_UpdateBool(jsonTemplate,"token",TRUE);
    // The key should have the ability to sign
    CkJsonObject_UpdateBool(jsonTemplate,"sign",TRUE);

    // Let's provide a few attributes to help us find the this key at a later time.
    // See SSH Public-Key Authentication using an HSM

    // The ID is byte data, so it should be base64 or hex.
    // Specify "id" if passing base64 data, "id_hex" for hexidecimal, or "id_ascii" for directly copying the ascii bytes of the string.
    // You can provide any ID of your choice.  It is optional.
    CkJsonObject_UpdateString(jsonTemplate,"id_hex","0A0B0C0D01020304");

    // Optionally specify a label.
    CkJsonObject_UpdateString(jsonTemplate,"label","MySshKey");

    // Load the SSH key to be imported to the HSM (smartcard or token)
    sshKey = CkSshKey_Create();
    CkSshKey_putPassword(sshKey,"password_of_the_encrypted_ppk_file");
    ppkContents = CkSshKey_loadText(sshKey,"c:/my_ssh_keys/someSshKey.ppk");
    success = CkSshKey_FromPuttyPrivateKey(sshKey,ppkContents);
    if (success == FALSE) {
        printf("%s\n",CkSshKey_lastErrorText(sshKey));
        CkPkcs11_Dispose(pkcs11);
        CkJsonObject_Dispose(jsonTemplate);
        CkSshKey_Dispose(sshKey);
        return;
    }

    // Import the SSH private key onto the HSM.
    // The PKCS11 handle to the imported private key is returned.
    // A 0 is returned on failure.
    privKeyHandle = CkPkcs11_ImportSshKey(pkcs11,sshKey,jsonTemplate);
    if (privKeyHandle == 0) {
        printf("%s\n",CkPkcs11_lastErrorText(pkcs11));
        CkPkcs11_Dispose(pkcs11);
        CkJsonObject_Dispose(jsonTemplate);
        CkSshKey_Dispose(sshKey);
        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  SSH Public-Key Authentication using a Smartcard
    printf("private key handle: %u\n",privKeyHandle);

    printf("Successfully imported the SSH key onto the HSM.\n");

    CkPkcs11_Logout(pkcs11);
    CkPkcs11_CloseSession(pkcs11);


    CkPkcs11_Dispose(pkcs11);
    CkJsonObject_Dispose(jsonTemplate);
    CkSshKey_Dispose(sshKey);

    }