(Excel) 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.

Note: This functionality was introduced in Chilkat v9.5.0.87.

Note: The ScMinidriver functionality is for Windows-only because ScMinidriver DLLs only exist on Windows. In the next version, Chilkat will be releasing a Pkcs11 class to support Linux, MacOSX, and possibly other operating systems.

Download Excel Class Modules Chilkat Excel Class Modules

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

Dim scmd As Chilkat.ScMinidriver
Set scmd = Chilkat.NewScMinidriver

' 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 = False) Then
    Debug.Print scmd.LastErrorText
    Exit Sub
End If

Dim json As Chilkat.JsonObject
Set json = Chilkat.NewJsonObject
json.EmitCompact = False

success = scmd.GetCspContainerMap(json)
If (success = False) Then
    Debug.Print scmd.LastErrorText
    Exit Sub
End If

Debug.Print json.Emit()

' 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")
Do 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
Loop

' Delete the context when finished with the card.
success = scmd.DeleteContext()
If (success = False) Then
    Debug.Print scmd.LastErrorText
End If