C
C
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 C Downloads
#include <C_CkPkcs11.h>
#include <C_CkJsonObject.h>
void ChilkatSample(void)
{
BOOL success;
HCkPkcs11 pkcs11;
BOOL onlyTokensPresent;
HCkJsonObject json;
int id;
const char *slotDescription;
BOOL tokenPresent;
BOOL removableDevice;
BOOL hardwareSlot;
int hardwareVersionMajor;
int hardwareVersionMinor;
int firmwareVersionMajor;
int firmwareVersionMinor;
const char *tokenLabel;
const char *tokenManufacturerID;
const char *tokenModel;
const char *tokenSerialNumber;
int tokenMaxSessionCount;
int tokenSessionCount;
int tokenMaxRwSessionCount;
int tokenRwSessionCount;
int tokenMaxPinLen;
int tokenMinPinLen;
int tokenTotalPublicMemory;
int tokenFreePublicMemory;
int tokenTotalPrivateMemory;
int tokenFreePrivateMemory;
int tokenHardwareVersionMajor;
int tokenHardwareVersionMinor;
int tokenFirmwareVersionMajor;
int tokenFirmwareVersionMinor;
const char *tokenUtcTime;
int tokenRsaMinKeySize;
int tokenRsaMaxKeySize;
int j;
int count_j;
const char *strVal;
int cryptokiVersionMajor;
int cryptokiVersionMinor;
const char *manufacturerID;
const char *libraryDescription;
int libraryVersionMajor;
int libraryVersionMinor;
int i;
int count_i;
success = FALSE;
// 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 = CkPkcs11_Create();
// Specify the vendor's Cryptoki module DLL / shared lib.
CkPkcs11_putSharedLibPath(pkcs11,"aetpkss1.dll");
success = CkPkcs11_Initialize(pkcs11);
if (success == FALSE) {
printf("%s\n",CkPkcs11_lastErrorText(pkcs11));
CkPkcs11_Dispose(pkcs11);
return;
}
// 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.)
onlyTokensPresent = TRUE;
json = CkJsonObject_Create();
success = CkPkcs11_Discover(pkcs11,onlyTokensPresent,json);
if (success == FALSE) {
printf("%s\n",CkPkcs11_lastErrorText(pkcs11));
CkPkcs11_Dispose(pkcs11);
CkJsonObject_Dispose(json);
return;
}
CkJsonObject_putEmitCompact(json,FALSE);
printf("%s\n",CkJsonObject_emit(json));
// 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
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
// See this example explaining how this memory should be used: const char * functions.
// Use this online tool to generate parsing code from sample JSON:
// Generate Parsing Code from JSON
cryptokiVersionMajor = CkJsonObject_IntOf(json,"cryptokiVersion.major");
cryptokiVersionMinor = CkJsonObject_IntOf(json,"cryptokiVersion.minor");
manufacturerID = CkJsonObject_stringOf(json,"manufacturerID");
libraryDescription = CkJsonObject_stringOf(json,"libraryDescription");
libraryVersionMajor = CkJsonObject_IntOf(json,"libraryVersion.major");
libraryVersionMinor = CkJsonObject_IntOf(json,"libraryVersion.minor");
i = 0;
count_i = CkJsonObject_SizeOfArray(json,"slot");
while (i < count_i) {
CkJsonObject_putI(json,i);
id = CkJsonObject_IntOf(json,"slot[i].id");
slotDescription = CkJsonObject_stringOf(json,"slot[i].slotDescription");
manufacturerID = CkJsonObject_stringOf(json,"slot[i].manufacturerID");
tokenPresent = CkJsonObject_BoolOf(json,"slot[i].tokenPresent");
removableDevice = CkJsonObject_BoolOf(json,"slot[i].removableDevice");
hardwareSlot = CkJsonObject_BoolOf(json,"slot[i].hardwareSlot");
hardwareVersionMajor = CkJsonObject_IntOf(json,"slot[i].hardwareVersion.major");
hardwareVersionMinor = CkJsonObject_IntOf(json,"slot[i].hardwareVersion.minor");
firmwareVersionMajor = CkJsonObject_IntOf(json,"slot[i].firmwareVersion.major");
firmwareVersionMinor = CkJsonObject_IntOf(json,"slot[i].firmwareVersion.minor");
tokenLabel = CkJsonObject_stringOf(json,"slot[i].token.label");
tokenManufacturerID = CkJsonObject_stringOf(json,"slot[i].token.manufacturerID");
tokenModel = CkJsonObject_stringOf(json,"slot[i].token.model");
tokenSerialNumber = CkJsonObject_stringOf(json,"slot[i].token.serialNumber");
tokenMaxSessionCount = CkJsonObject_IntOf(json,"slot[i].token.maxSessionCount");
tokenSessionCount = CkJsonObject_IntOf(json,"slot[i].token.sessionCount");
tokenMaxRwSessionCount = CkJsonObject_IntOf(json,"slot[i].token.maxRwSessionCount");
tokenRwSessionCount = CkJsonObject_IntOf(json,"slot[i].token.rwSessionCount");
tokenMaxPinLen = CkJsonObject_IntOf(json,"slot[i].token.maxPinLen");
tokenMinPinLen = CkJsonObject_IntOf(json,"slot[i].token.minPinLen");
tokenTotalPublicMemory = CkJsonObject_IntOf(json,"slot[i].token.totalPublicMemory");
tokenFreePublicMemory = CkJsonObject_IntOf(json,"slot[i].token.freePublicMemory");
tokenTotalPrivateMemory = CkJsonObject_IntOf(json,"slot[i].token.totalPrivateMemory");
tokenFreePrivateMemory = CkJsonObject_IntOf(json,"slot[i].token.freePrivateMemory");
tokenHardwareVersionMajor = CkJsonObject_IntOf(json,"slot[i].token.hardwareVersion.major");
tokenHardwareVersionMinor = CkJsonObject_IntOf(json,"slot[i].token.hardwareVersion.minor");
tokenFirmwareVersionMajor = CkJsonObject_IntOf(json,"slot[i].token.firmwareVersion.major");
tokenFirmwareVersionMinor = CkJsonObject_IntOf(json,"slot[i].token.firmwareVersion.minor");
tokenUtcTime = CkJsonObject_stringOf(json,"slot[i].token.utcTime");
tokenRsaMinKeySize = CkJsonObject_IntOf(json,"slot[i].token.rsa.minKeySize");
tokenRsaMaxKeySize = CkJsonObject_IntOf(json,"slot[i].token.rsa.maxKeySize");
j = 0;
count_j = CkJsonObject_SizeOfArray(json,"slot[i].token.flags");
while (j < count_j) {
CkJsonObject_putJ(json,j);
strVal = CkJsonObject_stringOf(json,"slot[i].token.flags[j]");
j = j + 1;
}
j = 0;
count_j = CkJsonObject_SizeOfArray(json,"slot[i].token.mechanism");
while (j < count_j) {
CkJsonObject_putJ(json,j);
strVal = CkJsonObject_stringOf(json,"slot[i].token.mechanism[j]");
j = j + 1;
}
i = i + 1;
}
CkPkcs11_Dispose(pkcs11);
CkJsonObject_Dispose(json);
}