(C) PKCS11 Import a Private Key onto the HSM

See more PKCS11 Examples

Demonstrates how to import an existing RSA private key onto the smartcard/token. The imported key is a token object, meaning it stays on the HSM and exists beyond the end of the PKCS11 session.

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

Chilkat C/C++ Library Downloads
MS Visual C/C++ Linux/CentOS C/C++ Alpine Linux C/C++ MAC OS X C/C++	armhf/aarch64 C/C++ C++ Builder iOS C/C++ Android C/C++	Solaris C/C++ MinGW C/C++

#include <C_CkPkcs11.h>
#include <C_CkCert.h>
#include <C_CkPrivateKey.h>
#include <C_CkJsonObject.h>

void ChilkatSample(void)
    {
    HCkPkcs11 pkcs11;
    const char *pin;
    int userType;
    BOOL success;
    HCkCert cert;
    HCkPrivateKey privKey;
    HCkJsonObject jsonTemplate;
    unsigned long keyHandle;

    // 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.
    // (The format of the path will change with the operating system.  Obviously, "C:/" is not used on non-Windows systems.
    CkPkcs11_putSharedLibPath(pkcs11,"C:/Program Files (x86)/Gemalto/IDGo 800 PKCS#11/IDPrimePKCS1164.dll");

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

    // Let's import a certificate's private key onto the HSM.
    // First, we'll load the certificate from a .pfx (also known as .p12), which is a file format
    // that also includes the certificate's private key.
    cert = CkCert_Create();
    success = CkCert_LoadPfxFile(cert,"qa_data/pfx/ehealth.fgov.be_testing.p12","p12_password");
    if (success == FALSE) {
        printf("%s\n",CkCert_lastErrorText(cert));
        CkPkcs11_Dispose(pkcs11);
        CkCert_Dispose(cert);
        return;
    }

    // Let's get the certificate's private key.
    privKey = CkCert_ExportPrivateKey(cert);
    if (CkCert_getLastMethodSuccess(cert) == FALSE) {
        printf("%s\n",CkCert_lastErrorText(cert));
        CkPkcs11_Dispose(pkcs11);
        CkCert_Dispose(cert);
        return;
    }

    // Build a PKCS11 template to provide additional information about the key to be imported.
    jsonTemplate = CkJsonObject_Create();

    // Indicate that the key is to be stored on the token.  It is NOT a session object.
    CkJsonObject_UpdateBool(jsonTemplate,"token",TRUE);

    // Indicate that the key can be used for signing.
    CkJsonObject_UpdateBool(jsonTemplate,"sign",TRUE);

    // Provide an arbitrary ID and label (anything you want).
    // The information in the ID and/or label provides one means for finding the key in future PKCS11 sessions.
    CkJsonObject_UpdateString(jsonTemplate,"id_hex","010203040A0B0C0D0E0F");
    CkJsonObject_UpdateString(jsonTemplate,"label","ehealth private key");

    // Import the key.  The private key handle is returned on success.  Otherwise 0 is returned.
    // If our only task for now is to simply import the key, we can ignore the returned handle, 
    // other than to check for success/failure.  Otherwise, the handle can be used in other PKCS11 operations.
    // This example just creates the key and does not use the returned handle.
    keyHandle = CkPkcs11_ImportPrivateKey(pkcs11,privKey,jsonTemplate);
    if (keyHandle == 0) {
        printf("%s\n",CkPkcs11_lastErrorText(pkcs11));
    }
    else {
        printf("key handle = %u\n",keyHandle);
        printf("Successfully imported a private key onto the HSM.\n");
    }

    CkPrivateKey_Dispose(privKey);

    CkPkcs11_Logout(pkcs11);
    CkPkcs11_CloseSession(pkcs11);


    CkPkcs11_Dispose(pkcs11);
    CkCert_Dispose(cert);
    CkJsonObject_Dispose(jsonTemplate);

    }