PureBasic

PKCS11 Generate a Session RSA Key on the HSM

See more PKCS11 Examples

Generates an RSA key on the smart card or token and returns the public and private key handles. The generated RSA key exists only for the duration of the PKCS11 session.

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

PureBasic

IncludeFile "CkPkcs11.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkPublicKey.pb"

Procedure ChilkatExample()

    success.i = 0

    ; 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 = CkPkcs11::ckQuickSession(pkcs11,userType,pin)
    If success = 0
        Debug CkPkcs11::ckLastErrorText(pkcs11)
        CkPkcs11::ckDispose(pkcs11)
        ProcedureReturn
    EndIf

    ; Specify attributes and abilities (how this key can be used) by providing a JSON template.
    ; One template is for the public key, and the other for the private key.
    pubKeyAttr.i = CkJsonObject::ckCreate()
    If pubKeyAttr.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Allow the public key to be used for encryption, signature verification, and symmetric key wrapping
    ; These attributes are optional.
    CkJsonObject::ckUpdateBool(pubKeyAttr,"encrypt",1)
    CkJsonObject::ckUpdateBool(pubKeyAttr,"verify",1)
    CkJsonObject::ckUpdateBool(pubKeyAttr,"wrap",1)

    ; Generate a 2048-bit RSA key.
    ; This attribute is required.
    CkJsonObject::ckUpdateInt(pubKeyAttr,"modulus_bits",2048)

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

    ; Generate a session RSA key.
    ; A session key exists only for the duration of the PKS11 session.
    ; To generate an RSA key that resides on the HSM, set the "token" attribute equal to 1
    CkJsonObject::ckUpdateBool(privKeyAttr,"token",0)

    ; Allow the private key to be used for signing and decryption.
    CkJsonObject::ckUpdateBool(privKeyAttr,"sign",1)
    CkJsonObject::ckUpdateBool(privKeyAttr,"decrypt",1)

    ; Do not allow the private key to be extracted.
    CkJsonObject::ckUpdateBool(privKeyAttr,"extractable",0)

    ; Provide a JSON object to receive the public and private key handles.
    jsonHandles.i = CkJsonObject::ckCreate()
    If jsonHandles.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::setCkEmitCompact(jsonHandles, 0)

    ; Provide a Chilkat public key object to receive the public key.
    pubKey.i = CkPublicKey::ckCreate()
    If pubKey.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkPkcs11::ckGenRsaKey(pkcs11,pubKeyAttr,privKeyAttr,jsonHandles,pubKey)
    If success = 0
        Debug CkPkcs11::ckLastErrorText(pkcs11)
        Debug "Failed to generate an RSA key."
    Else
        ; Sample JSON handles:
        ; {
        ;   "public_key_handle": 18415630,
        ;   "private_key_handle": 74842125
        ; }
        Debug CkJsonObject::ckEmit(jsonHandles)
        Debug "public_key_handle: " + Str(CkJsonObject::ckUIntOf(jsonHandles,"public_key_handle"))
        Debug "private_key_handle: " + Str(CkJsonObject::ckUIntOf(jsonHandles,"private_key_handle"))
        Debug "public key JWK:"
        Debug CkPublicKey::ckGetJwk(pubKey)
        ; Sample JWK:
        ; {"kty":"RSA","n":"1sQMSAntY80L .... If9jqfMp4omQ","e":"AQAB"}
        Debug "Success."
    EndIf

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


    CkPkcs11::ckDispose(pkcs11)
    CkJsonObject::ckDispose(pubKeyAttr)
    CkJsonObject::ckDispose(privKeyAttr)
    CkJsonObject::ckDispose(jsonHandles)
    CkPublicKey::ckDispose(pubKey)


    ProcedureReturn
EndProcedure