Xbase++
Xbase++
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 Xbase++ Downloads
LOCAL nSuccess
LOCAL oPkcs11
LOCAL nOnlyTokensPresent
LOCAL oJson
LOCAL nId
LOCAL cSlotDescription
LOCAL nTokenPresent
LOCAL nRemovableDevice
LOCAL nHardwareSlot
LOCAL nHardwareVersionMajor
LOCAL nHardwareVersionMinor
LOCAL nFirmwareVersionMajor
LOCAL nFirmwareVersionMinor
LOCAL cTokenLabel
LOCAL cTokenManufacturerID
LOCAL cTokenModel
LOCAL cTokenSerialNumber
LOCAL nTokenMaxSessionCount
LOCAL nTokenSessionCount
LOCAL nTokenMaxRwSessionCount
LOCAL nTokenRwSessionCount
LOCAL nTokenMaxPinLen
LOCAL nTokenMinPinLen
LOCAL nTokenTotalPublicMemory
LOCAL nTokenFreePublicMemory
LOCAL nTokenTotalPrivateMemory
LOCAL nTokenFreePrivateMemory
LOCAL nTokenHardwareVersionMajor
LOCAL nTokenHardwareVersionMinor
LOCAL nTokenFirmwareVersionMajor
LOCAL nTokenFirmwareVersionMinor
LOCAL cTokenUtcTime
LOCAL nTokenRsaMinKeySize
LOCAL nTokenRsaMaxKeySize
LOCAL j
LOCAL nCount_j
LOCAL cStrVal
LOCAL nCryptokiVersionMajor
LOCAL nCryptokiVersionMinor
LOCAL cManufacturerID
LOCAL cLibraryDescription
LOCAL nLibraryVersionMajor
LOCAL nLibraryVersionMinor
LOCAL i
LOCAL nCount_i
nSuccess := 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.
oPkcs11 := CreateObject("Chilkat.Pkcs11")
// Specify the vendor's Cryptoki module DLL / shared lib.
oPkcs11:SharedLibPath := "aetpkss1.dll"
nSuccess := oPkcs11:Initialize()
IF (nSuccess == 0)
? oPkcs11:LastErrorText
oPkcs11:destroy()
RETURN
ENDIF
// 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.)
nOnlyTokensPresent := 1
oJson := CreateObject("Chilkat.JsonObject")
nSuccess := oPkcs11:Discover(nOnlyTokensPresent, oJson)
IF (nSuccess == 0)
? oPkcs11:LastErrorText
oPkcs11:destroy()
oJson:destroy()
RETURN
ENDIF
oJson:EmitCompact := 0
? oJson: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
nCryptokiVersionMajor := oJson:IntOf("cryptokiVersion.major")
nCryptokiVersionMinor := oJson:IntOf("cryptokiVersion.minor")
cManufacturerID := oJson:StringOf("manufacturerID")
cLibraryDescription := oJson:StringOf("libraryDescription")
nLibraryVersionMajor := oJson:IntOf("libraryVersion.major")
nLibraryVersionMinor := oJson:IntOf("libraryVersion.minor")
i := 0
nCount_i := oJson:SizeOfArray("slot")
DO WHILE i < nCount_i
oJson:I := i
nId := oJson:IntOf("slot[i].id")
cSlotDescription := oJson:StringOf("slot[i].slotDescription")
cManufacturerID := oJson:StringOf("slot[i].manufacturerID")
nTokenPresent := oJson:BoolOf("slot[i].tokenPresent")
nRemovableDevice := oJson:BoolOf("slot[i].removableDevice")
nHardwareSlot := oJson:BoolOf("slot[i].hardwareSlot")
nHardwareVersionMajor := oJson:IntOf("slot[i].hardwareVersion.major")
nHardwareVersionMinor := oJson:IntOf("slot[i].hardwareVersion.minor")
nFirmwareVersionMajor := oJson:IntOf("slot[i].firmwareVersion.major")
nFirmwareVersionMinor := oJson:IntOf("slot[i].firmwareVersion.minor")
cTokenLabel := oJson:StringOf("slot[i].token.label")
cTokenManufacturerID := oJson:StringOf("slot[i].token.manufacturerID")
cTokenModel := oJson:StringOf("slot[i].token.model")
cTokenSerialNumber := oJson:StringOf("slot[i].token.serialNumber")
nTokenMaxSessionCount := oJson:IntOf("slot[i].token.maxSessionCount")
nTokenSessionCount := oJson:IntOf("slot[i].token.sessionCount")
nTokenMaxRwSessionCount := oJson:IntOf("slot[i].token.maxRwSessionCount")
nTokenRwSessionCount := oJson:IntOf("slot[i].token.rwSessionCount")
nTokenMaxPinLen := oJson:IntOf("slot[i].token.maxPinLen")
nTokenMinPinLen := oJson:IntOf("slot[i].token.minPinLen")
nTokenTotalPublicMemory := oJson:IntOf("slot[i].token.totalPublicMemory")
nTokenFreePublicMemory := oJson:IntOf("slot[i].token.freePublicMemory")
nTokenTotalPrivateMemory := oJson:IntOf("slot[i].token.totalPrivateMemory")
nTokenFreePrivateMemory := oJson:IntOf("slot[i].token.freePrivateMemory")
nTokenHardwareVersionMajor := oJson:IntOf("slot[i].token.hardwareVersion.major")
nTokenHardwareVersionMinor := oJson:IntOf("slot[i].token.hardwareVersion.minor")
nTokenFirmwareVersionMajor := oJson:IntOf("slot[i].token.firmwareVersion.major")
nTokenFirmwareVersionMinor := oJson:IntOf("slot[i].token.firmwareVersion.minor")
cTokenUtcTime := oJson:StringOf("slot[i].token.utcTime")
nTokenRsaMinKeySize := oJson:IntOf("slot[i].token.rsa.minKeySize")
nTokenRsaMaxKeySize := oJson:IntOf("slot[i].token.rsa.maxKeySize")
j := 0
nCount_j := oJson:SizeOfArray("slot[i].token.flags")
DO WHILE j < nCount_j
oJson:J := j
cStrVal := oJson:StringOf("slot[i].token.flags[j]")
j := j + 1
ENDDO
j := 0
nCount_j := oJson:SizeOfArray("slot[i].token.mechanism")
DO WHILE j < nCount_j
oJson:J := j
cStrVal := oJson:StringOf("slot[i].token.mechanism[j]")
j := j + 1
ENDDO
i := i + 1
ENDDO
oPkcs11:destroy()
oJson:destroy()