Sample code for 30+ languages & platforms
PowerBuilder

PKCS11 Discover Readers and Smart Cards / Tokens

See more PKCS11 Examples

Example showing how to discover the readers (slots) and smart cards and tokens available through a vendor's PKCS11 Cryptoki module.

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

Chilkat PowerBuilder Downloads

PowerBuilder
integer li_rc
long li_Success
oleobject loo_Pkcs11
long li_OnlyTokensPresent
oleobject loo_Json
long li_Id
string ls_SlotDescription
long li_TokenPresent
long li_RemovableDevice
long li_HardwareSlot
long li_HardwareVersionMajor
long li_HardwareVersionMinor
long li_FirmwareVersionMajor
long li_FirmwareVersionMinor
string ls_TokenLabel
string ls_TokenManufacturerID
string ls_TokenModel
string ls_TokenSerialNumber
long li_TokenMaxSessionCount
long li_TokenSessionCount
long li_TokenMaxRwSessionCount
long li_TokenRwSessionCount
long li_TokenMaxPinLen
long li_TokenMinPinLen
long li_TokenTotalPublicMemory
long li_TokenFreePublicMemory
long li_TokenTotalPrivateMemory
long li_TokenFreePrivateMemory
long li_TokenHardwareVersionMajor
long li_TokenHardwareVersionMinor
long li_TokenFirmwareVersionMajor
long li_TokenFirmwareVersionMinor
string ls_TokenUtcTime
long li_TokenRsaMinKeySize
long li_TokenRsaMaxKeySize
long j
long li_Count_j
string ls_StrVal
long li_CryptokiVersionMajor
long li_CryptokiVersionMinor
string ls_ManufacturerID
string ls_LibraryDescription
long li_LibraryVersionMajor
long li_LibraryVersionMinor
long i
long li_Count_i

li_Success = 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.

loo_Pkcs11 = create oleobject
li_rc = loo_Pkcs11.ConnectToNewObject("Chilkat.Pkcs11")
if li_rc < 0 then
    destroy loo_Pkcs11
    MessageBox("Error","Connecting to COM object failed")
    return
end if

//  Specify the vendor's Cryptoki module DLL / shared lib.
loo_Pkcs11.SharedLibPath = "aetpkss1.dll"

li_Success = loo_Pkcs11.Initialize()
if li_Success = 0 then
    Write-Debug loo_Pkcs11.LastErrorText
    destroy loo_Pkcs11
    return
end if

//  Call Discover to discover what's available.
//  Indicate that we only want to return slots (readers) where tokens (smart cards) are present.
//  (If the device is a USB token, such as an ePass300Auto, then by definition it has a "token" present.)
li_OnlyTokensPresent = 1
loo_Json = create oleobject
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")

li_Success = loo_Pkcs11.Discover(li_OnlyTokensPresent,loo_Json)
if li_Success = 0 then
    Write-Debug loo_Pkcs11.LastErrorText
    destroy loo_Pkcs11
    destroy loo_Json
    return
end if

loo_Json.EmitCompact = 0
Write-Debug loo_Json.Emit()

//  Sample JSON output.
//  Code for parsing this JSON is shown below..

//  {
//    "cryptokiVersion": {
//      "major": 2,
//      "minor": 20
//    },
//    "manufacturerID": "A.E.T. Europe B.V.",
//    "libraryDescription": "Cryptographic Token Interface",
//    "libraryVersion": {
//      "major": 3,
//      "minor": 0
//    },
//    "slot": [
//      {
//        "id": 52482,
//        "slotDescription": "SCM Microsystems Inc. SCR33x USB Smart Card Reader 0",
//        "manufacturerID": "SCM Microsystems Inc. SCR33x USB",
//        "tokenPresent": true,
//        "removableDevice": true,
//        "hardwareSlot": true,
//        "hardwareVersion": {
//          "major": 0,
//          "minor": 0
//        },
//        "firmwareVersion": {
//          "major": 0,
//          "minor": 0
//        },
//        "token": {
//          "label": "chilkat",
//          "manufacturerID": "A.E.T. Europe B.V.",
//          "model": "19C40406010D00C0",
//          "serialNumber": "21619600583C4505",
//          "flags": [
//            "CKF_RNG",
//            "CKF_LOGIN_REQUIRED",
//            "CKF_USER_PIN_INITIALIZED",
//            "CKF_TOKEN_INITIALIZED"
//          ],
//          "maxSessionCount": 126,
//          "sessionCount": 0,
//          "maxRwSessionCount": 126,
//          "rwSessionCount": 0,
//          "maxPinLen": 15,
//          "minPinLen": 4,
//          "totalPublicMemory": 32767,
//          "freePublicMemory": 32767,
//          "totalPrivateMemory": 32767,
//          "freePrivateMemory": 32767,
//          "hardwareVersion": {
//            "major": 0,
//            "minor": 0
//          },
//          "firmwareVersion": {
//            "major": 0,
//            "minor": 0
//          },
//          "utcTime": "",
//          "rsa": {
//            "minKeySize": 768,
//            "maxKeySize": 2048
//          },
//          "mechanism": [
//            "CKM_RSA_PKCS",
//            "CKM_RSA_X_509",
//            "CKM_RSA_PKCS_OAEP",
//            "CKM_MD5_RSA_PKCS",
//            "CKM_SHA1_RSA_PKCS",
//            "CKM_SHA224_RSA_PKCS",
//            "CKM_SHA256_RSA_PKCS",
//            "CKM_SHA384_RSA_PKCS",
//            "CKM_SHA512_RSA_PKCS",
//            "CKM_RIPEMD160_RSA_PKCS",
//            "CKM_CPK_ECDSA",
//            "CKM_CPK_ECDSA_SHA1",
//            "CKM_CPK_ECIES",
//            "CKM_CPK_ECIES_STDDH_SHA1KDF_DES3CBC_PAD_SHA1HMAC",
//            "CKM_CPK_ECIES_STDDH_SHA1KDF_AES128CBC_PAD_SHA1HMAC",
//            "CKM_CPK_PKCS7_SIGNED",
//            "CKM_CPK_PKCS7_ENVELOPE_DES3CBC_PAD",
//            "CKM_RSA_PKCS_PSS",
//            "CKM_RSA_PKCS_KEY_PAIR_GEN",
//            "CKM_RC2_KEY_GEN",
//            "CKM_RC2_ECB",
//            "CKM_RC2_CBC",
//            "CKM_RC2_CBC_PAD",
//            "CKM_RC4_KEY_GEN",
//            "CKM_RC4",
//            "CKM_DES_KEY_GEN",
//            "CKM_DES2_KEY_GEN",
//            "CKM_DES3_KEY_GEN",
//            "CKM_DES_ECB",
//            "CKM_DES_CBC",
//            "CKM_DES3_ECB",
//            "CKM_DES3_CBC",
//            "CKM_DES_CBC_PAD",
//            "CKM_DES3_CBC_PAD",
//            "CKM_MD5",
//            "CKM_SHA_1",
//            "CKM_SHA224",
//            "CKM_SHA256",
//            "CKM_SHA384",
//            "CKM_SHA512",
//            "CKM_RIPEMD160"
//          ]
//        }
//      }
//    ]
//  }

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

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

li_CryptokiVersionMajor = loo_Json.IntOf("cryptokiVersion.major")
li_CryptokiVersionMinor = loo_Json.IntOf("cryptokiVersion.minor")
ls_ManufacturerID = loo_Json.StringOf("manufacturerID")
ls_LibraryDescription = loo_Json.StringOf("libraryDescription")
li_LibraryVersionMajor = loo_Json.IntOf("libraryVersion.major")
li_LibraryVersionMinor = loo_Json.IntOf("libraryVersion.minor")
i = 0
li_Count_i = loo_Json.SizeOfArray("slot")
do while i < li_Count_i
    loo_Json.I = i
    li_Id = loo_Json.IntOf("slot[i].id")
    ls_SlotDescription = loo_Json.StringOf("slot[i].slotDescription")
    ls_ManufacturerID = loo_Json.StringOf("slot[i].manufacturerID")
    li_TokenPresent = loo_Json.BoolOf("slot[i].tokenPresent")
    li_RemovableDevice = loo_Json.BoolOf("slot[i].removableDevice")
    li_HardwareSlot = loo_Json.BoolOf("slot[i].hardwareSlot")
    li_HardwareVersionMajor = loo_Json.IntOf("slot[i].hardwareVersion.major")
    li_HardwareVersionMinor = loo_Json.IntOf("slot[i].hardwareVersion.minor")
    li_FirmwareVersionMajor = loo_Json.IntOf("slot[i].firmwareVersion.major")
    li_FirmwareVersionMinor = loo_Json.IntOf("slot[i].firmwareVersion.minor")
    ls_TokenLabel = loo_Json.StringOf("slot[i].token.label")
    ls_TokenManufacturerID = loo_Json.StringOf("slot[i].token.manufacturerID")
    ls_TokenModel = loo_Json.StringOf("slot[i].token.model")
    ls_TokenSerialNumber = loo_Json.StringOf("slot[i].token.serialNumber")
    li_TokenMaxSessionCount = loo_Json.IntOf("slot[i].token.maxSessionCount")
    li_TokenSessionCount = loo_Json.IntOf("slot[i].token.sessionCount")
    li_TokenMaxRwSessionCount = loo_Json.IntOf("slot[i].token.maxRwSessionCount")
    li_TokenRwSessionCount = loo_Json.IntOf("slot[i].token.rwSessionCount")
    li_TokenMaxPinLen = loo_Json.IntOf("slot[i].token.maxPinLen")
    li_TokenMinPinLen = loo_Json.IntOf("slot[i].token.minPinLen")
    li_TokenTotalPublicMemory = loo_Json.IntOf("slot[i].token.totalPublicMemory")
    li_TokenFreePublicMemory = loo_Json.IntOf("slot[i].token.freePublicMemory")
    li_TokenTotalPrivateMemory = loo_Json.IntOf("slot[i].token.totalPrivateMemory")
    li_TokenFreePrivateMemory = loo_Json.IntOf("slot[i].token.freePrivateMemory")
    li_TokenHardwareVersionMajor = loo_Json.IntOf("slot[i].token.hardwareVersion.major")
    li_TokenHardwareVersionMinor = loo_Json.IntOf("slot[i].token.hardwareVersion.minor")
    li_TokenFirmwareVersionMajor = loo_Json.IntOf("slot[i].token.firmwareVersion.major")
    li_TokenFirmwareVersionMinor = loo_Json.IntOf("slot[i].token.firmwareVersion.minor")
    ls_TokenUtcTime = loo_Json.StringOf("slot[i].token.utcTime")
    li_TokenRsaMinKeySize = loo_Json.IntOf("slot[i].token.rsa.minKeySize")
    li_TokenRsaMaxKeySize = loo_Json.IntOf("slot[i].token.rsa.maxKeySize")
    j = 0
    li_Count_j = loo_Json.SizeOfArray("slot[i].token.flags")
    do while j < li_Count_j
        loo_Json.J = j
        ls_StrVal = loo_Json.StringOf("slot[i].token.flags[j]")
        j = j + 1
    loop
    j = 0
    li_Count_j = loo_Json.SizeOfArray("slot[i].token.mechanism")
    do while j < li_Count_j
        loo_Json.J = j
        ls_StrVal = loo_Json.StringOf("slot[i].token.mechanism[j]")
        j = j + 1
    loop
    i = i + 1
loop


destroy loo_Pkcs11
destroy loo_Json