PureBasic

PKCS11 Find all Private Keys

See more PKCS11 Examples

Demonstrates how to list all private keys on an HSM.

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

PureBasic

IncludeFile "CkPkcs11.pb"
IncludeFile "CkJsonObject.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.
    ; Use your actual PIN here.
    pin.s = "0000"
    userType.i = 1
    success = CkPkcs11::ckQuickSession(pkcs11,userType,pin)
    If success = 0
        Debug CkPkcs11::ckLastErrorText(pkcs11)
        CkPkcs11::ckDispose(pkcs11)
        ProcedureReturn
    EndIf

    ; Note: A logged-on session is required to list private keys.

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

    CkJsonObject::setCkEmitCompact(json, 0)

    success = CkPkcs11::ckFindAllKeys(pkcs11,"private",json)
    If success = 0
        Debug CkPkcs11::ckLastErrorText(pkcs11)
        CkPkcs11::ckDispose(pkcs11)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    Debug CkJsonObject::ckEmit(json)

    ; Sample output, with parsing code below..

    ; {
    ;   "keys": [
    ;     {
    ;       "handle": 74842125,
    ;       "id": "0001020304",
    ;       "key_type": "RSA",
    ;       "label": "Chilkat Software, Inc.",
    ;       "modulus": "twVRf6O ... Rwa1ebFY0=",
    ;       "exponent": "AAEAAQ=="
    ;     },
    ;     {
    ;       "handle": 18415630,
    ;       "id": "010203040A0B0C0D0E0F",
    ;       "key_type": "RSA",
    ;       "label": "ehealth private key",
    ;       "modulus": "qdKjhOwA1 ... A4MtX8BYgHmLw==",
    ;       "exponent": "AAEAAQ=="
    ;     },
    ;     {
    ;       "handle": 3735567,
    ;       "id": "D531B4B8F308489DA58350596178845973A4562E",
    ;       "key_type": "RSA",
    ;       "label": "d531b4b8-f308-489d-a583-505961788459",
    ;       "modulus": "r0MmXRKBP ... HAd1kUPsNyzcQ==",
    ;       "exponent": "AAEAAQ=="
    ;     },
    ;     {
    ;       "handle": 238092304,
    ;       "id": "0A0B0C0D01020304",
    ;       "key_type": "RSA",
    ;       "label": "MySshKey",
    ;       "modulus": "ykFHcfBFOq ... rfXBK/6g9t+S6UjJ1kUQ==",
    ;       "exponent": "AAEAAQ=="
    ;     },
    ;     {
    ;       "handle": 49348625,
    ;       "id": "48656C6C6F",
    ;       "key_type": "RSA",
    ;       "label": "2048-bit RSA key for testing",
    ;       "modulus": "vReVaJzXZYIOB ... kamD/8iNvhAKlKbQ==",
    ;       "exponent": "AAEAAQ=="
    ;     }
    ;   ]
    ; }

    ; Use this online tool to generate parsing code from sample JSON: 
    ; Generate Parsing Code from JSON

    handle.i
    id.s
    key_type.s
    label.s
    modulus.s
    exponent.s

    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(json,"keys")
    While i < count_i
        CkJsonObject::setCkI(json, i)
        handle = CkJsonObject::ckIntOf(json,"keys[i].handle")
        id = CkJsonObject::ckStringOf(json,"keys[i].id")
        key_type = CkJsonObject::ckStringOf(json,"keys[i].key_type")
        label = CkJsonObject::ckStringOf(json,"keys[i].label")
        modulus = CkJsonObject::ckStringOf(json,"keys[i].modulus")
        exponent = CkJsonObject::ckStringOf(json,"keys[i].exponent")
        i = i + 1
    Wend

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


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


    ProcedureReturn
EndProcedure