(PureBasic) PKCS11 Import an Existing AES Key onto the HSM

See more PKCS11 Examples

Demonstrates how to import an existing AES symmetric encrytion key onto the smartcard/token. The imported AES key is a session object, and only exists for the duration of the PKCS11 session. (AES keys are typically used for wrapping/unwrapping RSA and EC keys.)

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

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkPkcs11.pb"
IncludeFile "CkStringBuilder.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

    ; Generate a 256-bit AES key.
    ; (32 bytes is 256 bits)
    ; Append 32 bytes of random data in the base64 encoding.
    sbAesKey.i = CkStringBuilder::ckCreate()
    If sbAesKey.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkStringBuilder::ckAppendRandom(sbAesKey,32,"base64")

    attrs.i = CkJsonObject::ckCreate()
    If attrs.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Specify the type of object, and the type of key.
    CkJsonObject::ckUpdateString(attrs,"class","CKO_SECRET_KEY")
    CkJsonObject::ckUpdateString(attrs,"key_type","CKK_AES")
    ; Add an optional label if desired.
    CkJsonObject::ckUpdateString(attrs,"label","My AES wrapping/unwrapping key")
    ; Allow the key to be use for wrapping and unwrapping operations.
    CkJsonObject::ckUpdateBool(attrs,"wrap",1)
    CkJsonObject::ckUpdateBool(attrs,"unwrap",1)

    ; Provide the AES key material.
    CkJsonObject::ckUpdateString(attrs,"value",CkStringBuilder::ckGetAsString(sbAesKey))

    ; Create the object (i.e. create the AES key with the given key material.)
    ; Returns the PKCS11 object handle of the created AES session key.
    objHandle.i = CkPkcs11::ckCreatePkcs11Object(pkcs11,attrs)
    If objHandle = 0
        Debug CkPkcs11::ckLastErrorText(pkcs11)
        Debug "Failed."
    Else
        Debug "PKCS11 object handle = " + Str(objHandle)
        Debug "Successfully created a 256-bit AES session key."
    EndIf

    ; Typically, you would do other things in the PKCS11 session that use the handle of AES key we just created.
    ; ...
    ; ...

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


    CkPkcs11::ckDispose(pkcs11)
    CkStringBuilder::ckDispose(sbAesKey)
    CkJsonObject::ckDispose(attrs)


    ProcedureReturn
EndProcedure