(PureBasic) 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 PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkPkcs11.pb"
IncludeFile "CkCert.pb"
IncludeFile "CkPrivateKey.pb"
IncludeFile "CkJsonObject.pb"

Procedure ChilkatExample()

    ; 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.i = CkPkcs11::ckCreate()
    If pkcs11.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; 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::setCkSharedLibPath(pkcs11, "C:/Program Files (x86)/Gemalto/IDGo 800 PKCS#11/IDPrimePKCS1164.dll")

    ; Establish a logged-on session.
    pin.s = "0000"
    userType.i = 1
    success.i = CkPkcs11::ckQuickSession(pkcs11,userType,pin)
    If success = 0
        Debug CkPkcs11::ckLastErrorText(pkcs11)
        CkPkcs11::ckDispose(pkcs11)
        ProcedureReturn
    EndIf

    ; 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.i = CkCert::ckCreate()
    If cert.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkCert::ckLoadPfxFile(cert,"qa_data/pfx/ehealth.fgov.be_testing.p12","p12_password")
    If success = 0
        Debug CkCert::ckLastErrorText(cert)
        CkPkcs11::ckDispose(pkcs11)
        CkCert::ckDispose(cert)
        ProcedureReturn
    EndIf

    ; Let's get the certificate's private key.
    privKey.i = CkCert::ckExportPrivateKey(cert)
    If CkCert::ckLastMethodSuccess(cert) = 0
        Debug CkCert::ckLastErrorText(cert)
        CkPkcs11::ckDispose(pkcs11)
        CkCert::ckDispose(cert)
        ProcedureReturn
    EndIf

    ; Build a PKCS11 template to provide additional information about the key to be imported.
    jsonTemplate.i = CkJsonObject::ckCreate()
    If jsonTemplate.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Indicate that the key is to be stored on the token.  It is NOT a session object.
    CkJsonObject::ckUpdateBool(jsonTemplate,"token",1)

    ; Indicate that the key can be used for signing.
    CkJsonObject::ckUpdateBool(jsonTemplate,"sign",1)

    ; 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::ckUpdateString(jsonTemplate,"id_hex","010203040A0B0C0D0E0F")
    CkJsonObject::ckUpdateString(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.i = CkPkcs11::ckImportPrivateKey(pkcs11,privKey,jsonTemplate)
    If keyHandle = 0
        Debug CkPkcs11::ckLastErrorText(pkcs11)
    Else
        Debug "key handle = " + Str(keyHandle)
        Debug "Successfully imported a private key onto the HSM."
    EndIf

    CkPrivateKey::ckDispose(privKey)

    CkPkcs11::ckLogout(pkcs11)
    CkPkcs11::ckCloseSession(pkcs11)


    CkPkcs11::ckDispose(pkcs11)
    CkCert::ckDispose(cert)
    CkJsonObject::ckDispose(jsonTemplate)


    ProcedureReturn
EndProcedure