(PHP ActiveX) ScMinidriver - Get CSP Container Map for Smart Card or USB Token

See more ScMinidriver Examples

Returns the contents of the CSP container map file (cmapfile). This gives an overview of what key containers and certificates exist in the smart card from a CSP's point of view.

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows Note: The php_com_dotnet.dll may need to be enabled inside of php.ini.

<?php

// This example requires the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.ScMinidriver')
$scmd = new COM("Chilkat.ScMinidriver");

// Reader names (smart card readers or USB tokens) can be discovered
// via PCSC List Readers or PCSC Find Smart Cards
$readerName = 'SCM Microsystems Inc. SCR33x USB Smart Card Reader 0';
$success = $scmd->AcquireContext($readerName);
if ($success == 0) {
    print $scmd->LastErrorText . "\n";
    exit;
}

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$json = new COM("Chilkat.JsonObject");
$json->EmitCompact = 0;

$success = $scmd->GetCspContainerMap($json);
if ($success == 0) {
    print $scmd->LastErrorText . "\n";
    exit;
}

print $json->emit() . "\n";

// Here is sample output:
// See below for sample code to parse the JSON.

// --------------------------------------------------------------
// Some notes:
// 
// 1) Empty containers are not listed.
// 2) The "index" is the index of the key container on the card.
//    Note that in the example output below, the card has 4 occupied containers
//    at indexes 0, 1, 2, and 5.
// 3) If you see a key size (in bits) equal to 0, it means that key does not exist.
// 4) A container can potentially contain 2 keys + certificates -- a key for signing (also known as 
//    the "signature" key), and a key for authentication/authorization (also known as the 
//    "key exchange" key).
// 5) It is possible for a key to exist without the certificate.  For example, in the results
//    below there is a 2048-bit key-exchange key at index 1, but no certificate.
// 6) A certificate belonging to the key-exchange key is contained in the "kexCert" JSON member,
//    a certificate belonging to the signature key is contained in the "sigCert" JSON member (not shown below).
// --------------------------------------------------------------

// {
//   "containers": [
//     {
//       "index": 0,
//       "guid": "CertReq-PIVKeyC910-205fc3c2-19fe--42448",
//       "default": true,
//       "sigKeySizeBits": 0,
//       "kexKeySizeBits": 2048,
//       "kexCert": {
//         "serialNum": "15FBFBCF00010000313D",
//         "issuerCN": "PIVKey Device Certificate Authority",
//         "subjectCN": "PIVKey Device Certificate Authority"
//       }
//     },
//     {
//       "index": 1,
//       "guid": "{7b3c32dd-e992-c58f-0822-67d72fd52d43}",
//       "default": false,
//       "sigKeySizeBits": 0,
//       "kexKeySizeBits": 2048
//     },
//     {
//       "index": 2,
//       "guid": "{57547a77-18e7-7516-f5da-6aee13b46bbc}",
//       "default": false,
//       "sigKeySizeBits": 0,
//       "kexKeySizeBits": 2048
//     },
//     {
//       "index": 5,
//       "guid": "{306fd6da-9954-4f75-95c0-178f607a41fb}",
//       "default": false,
//       "sigKeySizeBits": 0,
//       "kexKeySizeBits": 2048,
//       "kexCert": {
//         "serialNum": "17C1B793A24D1A81490F5F768E6D23A5",
//         "issuerCN": "Matt",
//         "subjectCN": "Matt"
//       }
//     }
//   ]
// }

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

$i = 0;
$count_i = $json->SizeOfArray('containers');
while ($i < $count_i) {
    $json->I = $i;
    $index = $json->IntOf('containers[i].index');
    $guid = $json->stringOf('containers[i].guid');
    $default = $json->BoolOf('containers[i].default');
    $sigKeySizeBits = $json->IntOf('containers[i].sigKeySizeBits');
    $kexKeySizeBits = $json->IntOf('containers[i].kexKeySizeBits');
    $kexCertSerialNum = $json->stringOf('containers[i].kexCert.serialNum');
    $kexCertIssuerCN = $json->stringOf('containers[i].kexCert.issuerCN');
    $kexCertSubjectCN = $json->stringOf('containers[i].kexCert.subjectCN');
    $sigCertSerialNum = $json->stringOf('containers[i].sigCert.serialNum');
    $sigCertIssuerCN = $json->stringOf('containers[i].sigCert.issuerCN');
    $sigCertSubjectCN = $json->stringOf('containers[i].sigCert.subjectCN');
    $i = $i + 1;
}

// Delete the context when finished with the card.
$success = $scmd->DeleteContext();
if ($success == 0) {
    print $scmd->LastErrorText . "\n";
}


?>