PureBasic

PKCS11 Generate a Session EC Key on the HSM

See more PKCS11 Examples

Generates an EC key on the smart card or token and returns the public and private key handles. The generated EC 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 signature verification
    CkJsonObject::ckUpdateBool(pubKeyAttr,"verify",1)

    ; Specify the kind of EC key to generate by the curve name
    ; Possible curve names are:
    ; secp256r1  (also known as P-256 and prime256v1)
    ; secp384r1  (also known as P-384)
    ; secp521r1  (also known as P-521)
    ; secp256k1 (This is the curve used for Bitcoin)
    ; secp192r1
    ; secp224r1
    ; brainpoolP160r1
    ; brainpoolP192r1
    ; brainpoolP192r1
    ; brainpoolP224r1
    ; brainpoolP256r1
    ; brainpoolP320r1
    ; brainpoolP384r1
    ; brainpoolP512r1
    ; Note: Your smart card or token might not support all of the above EC curves (assuming it supports EC at all).

    ; This attribute is required.
    CkJsonObject::ckUpdateString(pubKeyAttr,"ec_params","secp256r1")

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

    ; Generate a session EC key.
    ; A session key exists only for the duration of the PKS11 session.
    ; To generate an EC 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.
    CkJsonObject::ckUpdateBool(privKeyAttr,"sign",1)

    ; 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::ckGenEcKey(pkcs11,pubKeyAttr,privKeyAttr,jsonHandles,pubKey)
    If success = 0
        Debug CkPkcs11::ckLastErrorText(pkcs11)
        Debug "Failed to generate an EC 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":"EC","crv":"P-256","x":"EDy-Sxl0DZ8tvzy_qnIYl6DYPFjTVnyJ2I9ZTCfKds4","y":"yBZ4HK2yF7F7ZEOn59CgTQp2ApQJ8ZOF736yZxY6LOE"}
        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