Java
Chilkat2 Java
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 Java Downloads
import com.chilkatsoft.chilkat2.ChilkatException;
import com.chilkatsoft.chilkat2.JsonObject;
import com.chilkatsoft.chilkat2.Pkcs11;
public class ChilkatExample {
public static void main(String[] args) {
// 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 pkcs11 = new Pkcs11();
// Specify the vendor's Cryptoki module DLL / shared lib.
pkcs11.setSharedLibPath("aetpkss1.dll");
try {
pkcs11.initialize();
} catch (ChilkatException e) {
System.out.println(e.getLastErrorText());
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.)
boolean onlyTokensPresent = true;
JsonObject json = new JsonObject();
try {
pkcs11.discover(onlyTokensPresent, json);
} catch (ChilkatException e) {
System.out.println(e.getLastErrorText());
return;
}
json.setEmitCompact(false);
System.out.println(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
int id = 0;
String slotDescription = "";
boolean tokenPresent = false;
boolean removableDevice = false;
boolean hardwareSlot = false;
int hardwareVersionMajor = 0;
int hardwareVersionMinor = 0;
int firmwareVersionMajor = 0;
int firmwareVersionMinor = 0;
String tokenLabel = "";
String tokenManufacturerID = "";
String tokenModel = "";
String tokenSerialNumber = "";
int tokenMaxSessionCount = 0;
int tokenSessionCount = 0;
int tokenMaxRwSessionCount = 0;
int tokenRwSessionCount = 0;
int tokenMaxPinLen = 0;
int tokenMinPinLen = 0;
int tokenTotalPublicMemory = 0;
int tokenFreePublicMemory = 0;
int tokenTotalPrivateMemory = 0;
int tokenFreePrivateMemory = 0;
int tokenHardwareVersionMajor = 0;
int tokenHardwareVersionMinor = 0;
int tokenFirmwareVersionMajor = 0;
int tokenFirmwareVersionMinor = 0;
String tokenUtcTime = "";
int tokenRsaMinKeySize = 0;
int tokenRsaMaxKeySize = 0;
int j = 0;
int count_j = 0;
String strVal = "";
// Use this online tool to generate parsing code from sample JSON:
// Generate Parsing Code from JSON
int cryptokiVersionMajor = json.intOf("cryptokiVersion.major");
int cryptokiVersionMinor = json.intOf("cryptokiVersion.minor");
String manufacturerID = json.stringOf("manufacturerID");
String libraryDescription = json.stringOf("libraryDescription");
int libraryVersionMajor = json.intOf("libraryVersion.major");
int libraryVersionMinor = json.intOf("libraryVersion.minor");
int i = 0;
int count_i = json.sizeOfArray("slot");
while (i < count_i) {
json.setI(i);
id = json.intOf("slot[i].id");
slotDescription = json.stringOf("slot[i].slotDescription");
manufacturerID = json.stringOf("slot[i].manufacturerID");
tokenPresent = json.boolOf("slot[i].tokenPresent");
removableDevice = json.boolOf("slot[i].removableDevice");
hardwareSlot = json.boolOf("slot[i].hardwareSlot");
hardwareVersionMajor = json.intOf("slot[i].hardwareVersion.major");
hardwareVersionMinor = json.intOf("slot[i].hardwareVersion.minor");
firmwareVersionMajor = json.intOf("slot[i].firmwareVersion.major");
firmwareVersionMinor = json.intOf("slot[i].firmwareVersion.minor");
tokenLabel = json.stringOf("slot[i].token.label");
tokenManufacturerID = json.stringOf("slot[i].token.manufacturerID");
tokenModel = json.stringOf("slot[i].token.model");
tokenSerialNumber = json.stringOf("slot[i].token.serialNumber");
tokenMaxSessionCount = json.intOf("slot[i].token.maxSessionCount");
tokenSessionCount = json.intOf("slot[i].token.sessionCount");
tokenMaxRwSessionCount = json.intOf("slot[i].token.maxRwSessionCount");
tokenRwSessionCount = json.intOf("slot[i].token.rwSessionCount");
tokenMaxPinLen = json.intOf("slot[i].token.maxPinLen");
tokenMinPinLen = json.intOf("slot[i].token.minPinLen");
tokenTotalPublicMemory = json.intOf("slot[i].token.totalPublicMemory");
tokenFreePublicMemory = json.intOf("slot[i].token.freePublicMemory");
tokenTotalPrivateMemory = json.intOf("slot[i].token.totalPrivateMemory");
tokenFreePrivateMemory = json.intOf("slot[i].token.freePrivateMemory");
tokenHardwareVersionMajor = json.intOf("slot[i].token.hardwareVersion.major");
tokenHardwareVersionMinor = json.intOf("slot[i].token.hardwareVersion.minor");
tokenFirmwareVersionMajor = json.intOf("slot[i].token.firmwareVersion.major");
tokenFirmwareVersionMinor = json.intOf("slot[i].token.firmwareVersion.minor");
tokenUtcTime = json.stringOf("slot[i].token.utcTime");
tokenRsaMinKeySize = json.intOf("slot[i].token.rsa.minKeySize");
tokenRsaMaxKeySize = json.intOf("slot[i].token.rsa.maxKeySize");
j = 0;
count_j = json.sizeOfArray("slot[i].token.flags");
while (j < count_j) {
json.setJ(j);
strVal = json.stringOf("slot[i].token.flags[j]");
j = j + 1;
}
j = 0;
count_j = json.sizeOfArray("slot[i].token.mechanism");
while (j < count_j) {
json.setJ(j);
strVal = json.stringOf("slot[i].token.mechanism[j]");
j = j + 1;
}
i = i + 1;
}
}
}