(PureBasic) PKCS11 Generate Secret Key (such as AES)

See more PKCS11 Examples

Generates a symmetric secret key such as AES on the HSM.

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

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkPkcs11.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 generate a 256-bit AES key on the token, which will exist for the duration of this session.
    ; Symmetric keys, such as AES keys, are typically created (or imported) and used during a single session.

    ; Other possible values for keyType are "AES XTS", "Blowfish", "Twofish", "ChaCha20", and others. 
    ; In virtually all cases, you'll want to create an AES key.
    keyType.s = "AES"

    ; Specify attributes and abilities (how this key can be used) by providing a JSON template.
    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; The key can be extracted or wrapped.
    CkJsonObject::ckUpdateBool(json,"extractable",1)

    ; Allow the key to be used for encryption, decryption, wrapping other keys, and unwrapping other keys.
    CkJsonObject::ckUpdateBool(json,"encrypt",1)
    CkJsonObject::ckUpdateBool(json,"decrypt",1)
    CkJsonObject::ckUpdateBool(json,"wrap",1)
    CkJsonObject::ckUpdateBool(json,"unwrap",1)

    ; Indicate a 256-bit AES key is to be generated by setting the value_len attribute equal to the key size in bytes.
    ; (32 bytes * 8 bits/byte = 256 bits)
    CkJsonObject::ckUpdateInt(json,"value_len",32)

    keyHandle.i = CkPkcs11::ckGenSecretKey(pkcs11,keyType,json)
    If keyHandle = 0
        Debug CkPkcs11::ckLastErrorText(pkcs11)
        Debug "Failed to generate an AES key."
    Else
        Debug "key handle = " + Str(keyHandle)
        Debug "Success."
    EndIf

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


    CkPkcs11::ckDispose(pkcs11)
    CkJsonObject::ckDispose(json)


    ProcedureReturn
EndProcedure