ScMinidriver C Reference Documentation
ScMinidriver
Current Version: 10.0.0
A wrapper around the Microsoft Smart Card Minidriver API.
This class is introduced in Chilkat v9.5.0.87.
Create/Dispose
HCkScMinidriver instance = CkScMinidriver_Create(); // ... CkScMinidriver_Dispose(instance);
Creates an instance of the HCkScMinidriver object and returns a handle ("void *" pointer). The handle is passed in the 1st argument for the functions listed on this page.
Objects created by calling CkScMinidriver_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function. Also, any handle returned by a Chilkat "C" function must also be freed by the application by calling the appropriate Dispose method, such as CkScMinidriver_Dispose.
Properties
Atr
const char *CkScMinidriver_atr(HCkScMinidriver cHandle);
The ATR of the card in the reader. This property is set by the AquireContext method.
topCardName
const char *CkScMinidriver_cardName(HCkScMinidriver cHandle);
The name of the card in the reader. This property is set by the AquireContext method.
topDebugLogFilePath
void CkScMinidriver_putDebugLogFilePath(HCkScMinidriver cHandle, const char *newVal);
const char *CkScMinidriver_debugLogFilePath(HCkScMinidriver cHandle);
If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.
This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:
- a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
- the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
- there is an internal problem (bug) in the Chilkat code that causes the hang.
LastErrorHtml
const char *CkScMinidriver_lastErrorHtml(HCkScMinidriver cHandle);
Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.
topLastErrorText
const char *CkScMinidriver_lastErrorText(HCkScMinidriver cHandle);
Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.
LastErrorXml
const char *CkScMinidriver_lastErrorXml(HCkScMinidriver cHandle);
Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.
topLastMethodSuccess
void CkScMinidriver_putLastMethodSuccess(HCkScMinidriver cHandle, BOOL newVal);
Indicate whether the last method call succeeded or failed. A value of TRUE indicates success, a value of FALSE indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:
- Any method that returns a string.
- Any method returning a Chilkat object, binary bytes, or a date/time.
- Any method returning a standard boolean status value where success = TRUE and failure = FALSE.
- Any method returning an integer where failure is defined by a return value less than zero.
Note: Methods that do not fit the above requirements will always set this property equal to TRUE. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.
topMaxContainers
The maximum number of key containers available. The 1st key container is at index 0. Each key container can potentially contain one signature key, and one key exchange key.
topRsaPaddingHash
void CkScMinidriver_putRsaPaddingHash(HCkScMinidriver cHandle, const char *newVal);
const char *CkScMinidriver_rsaPaddingHash(HCkScMinidriver cHandle);
If an RSA key is used for signing, this is the hash algorithm to used in conjunction with the padding scheme. It can be "SHA1", "SHA256", "SHA384", or "SHA512". The default is "SHA256".
topRsaPaddingScheme
void CkScMinidriver_putRsaPaddingScheme(HCkScMinidriver cHandle, const char *newVal);
const char *CkScMinidriver_rsaPaddingScheme(HCkScMinidriver cHandle);
If an RSA key is used for signing, this is the padding scheme to use. It can be "PKCS" or "PSS". The default is "PSS".
topUncommonOptions
void CkScMinidriver_putUncommonOptions(HCkScMinidriver cHandle, const char *newVal);
const char *CkScMinidriver_uncommonOptions(HCkScMinidriver cHandle);
This is a catch-all property to be used for uncommon needs. This property defaults to the empty string and should typically remain empty.
topUtf8
void CkScMinidriver_putUtf8(HCkScMinidriver cHandle, BOOL newVal);
When set to TRUE, all "const char *" arguments are interpreted as utf-8 strings. If set to FALSE (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to TRUE, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to FALSE, all "const char *" return values are ANSI strings.
topVerboseLogging
void CkScMinidriver_putVerboseLogging(HCkScMinidriver cHandle, BOOL newVal);
If set to TRUE, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is FALSE. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.
topVersion
const char *CkScMinidriver_version(HCkScMinidriver cHandle);
Methods
AcquireContext
Initializes communication with the card inserted in the given reader. Reader names can be discovered via the SCard.ListReaders or SCard.FindSmartcards methods. If successful, the Atr and CardName properties will be set.
Returns TRUE for success, FALSE for failure.
CardDeleteFile
Deletes the file specified by dirName and fileName. dirName is the name of the directory that contains the file, or the empty string for root.
Returns TRUE for success, FALSE for failure.
topDeleteCert
Deletes a certificate and optionally its associated private key from the smart card. If delPrivKey is TRUE, then the associated private key, if it exists, is also deleted.
Returns TRUE for success, FALSE for failure.
topDeleteContext
This function reverses the effect of AcquireContext and severs the communication between the Base CSP/KSP and the card minidriver. The Atr and CardName properties are cleared.
Returns TRUE for success, FALSE for failure.
topDeleteKeyContainer
Deletes the key container at the given containerIndex. This deletes both the "signature" and "key exchange" keys that may be contained in the specified key container.
Returns TRUE for success, FALSE for failure.
EnumFiles
Get the list of files in the directory specified by dirName. Pass the empty string for the root directory. The filenames are returned in st.
Returns TRUE for success, FALSE for failure.
topFindCert
Finds the certificate where the given certPart equals the partValue. Possible values for certPart are: "subjectDN", "subjectDN_withTags", "subjectCN", "serial", or "serial:issuerCN".
The cert is loaded with the certificate if successful.
Note: If successful, the cert will be linked internally with this ScMinidriver session such that certificate can be used for signing on the smart card when used in other Chilkat classes such as XmlDSigGen, Pdf, Crypt2, Mime, MailMan, etc.
Returns TRUE for success, FALSE for failure.
GenerateKey
Generates a key to be stored in either the "signature" or "key exchange" location within a key container. Creates the key container if it does not already exist. Otherwise replaces the key in the key container.
The keySpec can be "sig" or "kex" to specify either the "signature" or "key exchange" location.
The keyType can be "ecc" or "rsa".
For RSA keys, the keySize is the size of the key in bits, such as 1024, 2048, 4096, etc. (2048 is a typical value.) For ECC keys, the size can be 256, 384, or 521.
The pinId can be "user", or "3" through "7". (It is typically "user".)
Returns TRUE for success, FALSE for failure.
topGetCardProperties
Gets all card properties and returns them in json. See the example below.
Returns TRUE for success, FALSE for failure.
GetCert
Get the certificate at the specified containerIndex and keySpec. The keySpec can be "sig" or "kex" to specify either the "signature" or "key exchange" location within the container. The containerIndex can be -1 to choose the first key container with a certificate. The keySpec can also be "any" to choose either "sig" or "kex" based on which is present, with preference given to "sig" if both are present.
The cert is loaded with the certificate if successful.
Note: If successful, the cert will be linked internally with this ScMinidriver session such that certificate can be used for signing on the smart card when used in other Chilkat classes such as XmlDSigGen, Pdf, Crypt2, Mime, MailMan, etc.
Returns TRUE for success, FALSE for failure.
GetContainerKeys
Queries a key container to get the keys that are present. If the signature public key is present, it is returned in sigKey. If the key exchange key is present, it is returned in kexKey.
Returns TRUE for success, FALSE for failure.
GetCspContainerMap
Returns the contents of the CSP container map file (cmapfile). The information is returned in the json. This gives an overview of what key containers and certificates exist in the smart card from a CSP's point of view. See the example linked below.
Returns TRUE for success, FALSE for failure.
ImportCert
Imports a certificate with its private key onto the smart card. The cert must have an accessible private key, such as will be the case if the cert was loaded from a .pfx/.p12, or if the cert was loaded from a Windows certificate store where the private key exists (and can be exported from the Windows certificate store).
The containerIndex is the container index. It can range from 0 to the MaxContainers-1.
The keySpec can be "sig" or "kex" to specify either the "signature" or "key exchange" location within the container.
The pinId can be "user", or "3" through "7". (It is typically "user".)
Returns TRUE for success, FALSE for failure.
ImportKey
Imports a key to be stored in either the "signature" or "key exchange" location within a key container. Creates the key container if it does not already exist. Otherwise replaces the specified key in the key container.
The keySpec can be "sig" or "kex" to specify either the "signature" or "key exchange" location.
The privKey is the private key to import.
The ARG5 can be "user", or "3" through "7". (It is typically "user".)
Returns TRUE for success, FALSE for failure.
ListCerts
Lists the certs found on the smart card. The certPart indicates the information to be returned from each certificate. Possible values are: "subjectDN", "subjectDN_withTags", "subjectCN", "serial", or "serial:issuerCN". The information is returned in st.
Returns TRUE for success, FALSE for failure.
PinAuthenticate
Performs regular PIN authentication. The pinId can be "user", "admin", or "3" through "7". (It is typically "user".) The pin is the alphanumeric PIN.
Returns 0 for success. If not successful, the return value indicates the number of attempts remaining before the PIN is locked. (The number of times an incorrect PIN may be presented to the card before the PIN is blocked, and requires the admin to unblock it.) If the PIN is already blocked, the return value is -1. If the method fails for some other reason, such as if a context has not yet been acquired, the return value is -2.
PinAuthenticateHex
The same as PinAutheneticate, but the PIN is passed as a hex string. For example, to pass a PIN of 0x01, 0x02, 0x03, 0x04, pass "01020304".
topPinChange
Changes a PIN. The pinId can be "user", "admin", or "3" through "7". (It is typically "user".) The currentPin is the current alphanumeric PIN. The newPin is the new PIN.
Returns 0 for success. If not successful, the return value indicates the number of attempts remaining before the PIN is locked. (The number of times an incorrect PIN may be presented to the card before the PIN is blocked, and requires the admin to unblock it.) If the PIN is already blocked, the return value is -1. If the method fails for some other reason, such as if a context has not yet been acquired, the return value is -2.
PinDeauthenticate
Reverses a previous PIN authentication without resetting the card. The pinId can be "user", "admin", or "3" through "7". (It is typically "user".)
Returns TRUE for success, FALSE for failure.
ReadFile
Reads the entire file specified by dirName and fileName into bd. dirName is the name of the directory that contains the file, or the empty string for root.
Returns TRUE for success, FALSE for failure.
topSignData
Signs the data passed in bdData. The hashDataAlg can be "sha1", "sha256", "sha384", "sha512", or "none". If not equal to "none", then the hash of the data passed in bdData is signed.
The containerIndex specifies the key container. By specifying the key container, you are almost specifying the key. A key container can contain two keys: A signature key, and a key-exchange key. The keySpec indicates which of these two keys to use. keySpec should be set to "sig" or "kex".
Note: The type of signature created, such as RSA or ECC, is determined by the type of key that exists in the key container (specified by containerIndex and keySpec). If it is an RSA key, additional options can be specified via the RsaPaddingScheme and RsaPaddingHash properties.
If successful, the signature is written to bdSignedData.
Returns TRUE for success, FALSE for failure.
topWriteFile
Writes the entire file specified by dirName and fileName. dirName is the name of the directory that contains the file, or the empty string for root. The entire contents of bd are written to the file on the smart card.
Returns TRUE for success, FALSE for failure.
top