ScMinidriver Chilkat2 PHP Reference Documentation
ScMinidriver
Current Version: 11.7.0
Markdown version of this page for AI tools (v 11.7.0) · all AI docs
Chilkat.ScMinidriver
Use the Windows smart-card minidriver layer to access card capabilities
without working directly at the APDU level.
Enumerate and inspect smart-card certificates, key containers, container
indexes, key types, and related card state.
Authenticate to the card with the required PIN before accessing protected
private-key operations or card objects.
Sign data using private keys that remain on the smart card, including
workflows where the private key is non-exportable.
Generate or import RSA and ECC keys into supported card containers when
the card policy allows it.
Link a smart-card certificate to other Chilkat classes so PDF, XML,
CMS/PKCS7, S/MIME, or other signing operations can use the card-backed
private key.
For an extended overview, see
ScMinidriver Class Overview.
Access smart-card certificates, key containers, PINs, files, and on-card signing.
Chilkat.ScMinidriver is a smart-card integration class for
applications that need card minidriver access to certificates, key
containers, PIN authentication, card files, and on-card signing. It can
retrieve and link smart-card certificates for use in other Chilkat signing
classes, generate or import RSA and ECC keys, sign data directly, inspect
card and container state, and manage selected card files and certificates.
Connect through minidriver
Certificates and containers
PIN authentication
On-card signing
Key generation and import
Use with Chilkat signing
ScMinidriver for Windows card-minidriver certificate
and key-container operations; use Chilkat.SCard for direct
PC/SC APDU-level work, and Chilkat.Pkcs11 for PKCS#11 token or
HSM sessions.
Object Creation
use Chilkat2\ScMinidriver;
try {
$scMinidriver = new ScMinidriver();
// ... use $scMinidriver ...
} catch (\Chilkat2\Exception $e) {
echo $e->getClass(), '::', $e->getMethod(), " failed\n";
echo $e->getMessage(), "\n"; // the LastErrorText of the failed call
}Creates the object. The optional array sets properties in order, as if assigned one by one (new ScMinidriver(['VerboseLogging' => true, 'RaiseError' => false])); an unknown or read-only name throws Error. The class is defined by the chilkat2 extension (extension=chilkat2 in php.ini): there is no PHP file to include. Windows only: the class exists only in the Windows builds of the extension.
There is no close(): PHP frees the object when its last reference goes (unset($scMinidriver), $scMinidriver = null, or the end of the function or request). Objects returned by methods are independent and freed the same way. The class may be extended (class MyScMinidriver extends \Chilkat2\ScMinidriver); objects cannot be cloned or serialized.
When true (the default), a method that fails throws Chilkat2\Exception. When false, it returns false (or null) instead, and the reason is in LastErrorText. Objects returned by a method inherit the value of the object that returned them.
Errors
Chilkat2\Exception extends RuntimeException: getMessage() is the failed call's full LastErrorText, getClass() its class ('Chilkat2\ScMinidriver') and getMethod() the method name. The object remains usable. Methods that look something up and find nothing return null without throwing (each such method says so), methods that answer a question (HasMember, IsUnlocked, ...) return a plain bool, and property reads and writes do not throw for Chilkat reasons.
Misuse always throws, whatever RaiseError is: a wrong argument type is a TypeError (exact types under declare(strict_types=1)), a missing or extra argument an ArgumentCountError, a string containing a NUL byte or an out-of-range integer a ValueError, and an unknown property (properties are case-sensitive) or a write to a read-only one an Error. Named arguments work with the parameter names shown.
Strings are passed and returned as UTF-8; binary data is a PHP string of bytes. Unlocking: call (new \Chilkat2\GlobalSettings())->UnlockBundle('...') once at startup.
Properties
Atr
The ATR of the card in the reader. This property is set by the AquireContext method.
topCardName
The name of the card in the reader. This property is set by the AquireContext method.
topDebugLogFilePath
If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.
Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.
Possible causes of hangs include:
- A timeout property set to 0, indicating an infinite timeout.
- A hang occurring within an event callback in the application code.
- An internal bug in the Chilkat code causing the hang.
LastErrorHtml
Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastErrorText
Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
LastErrorXml
Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.
topLastMethodSuccess
Indicates the success or failure of the most recent method call: true means success, false means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.
MaxContainers
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
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.
RsaPaddingScheme
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.
UncommonOptions
This is a catch-all property to be used for uncommon needs. This property defaults to the empty string and should typically remain empty.
topVerboseLogging
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.
Version
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 on success. On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns false). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.
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 on success. On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns false). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.
DeleteCert
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 on success. On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns false). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.
DeleteContext
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 on success. On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns false). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.
DeleteKeyContainer
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 on success. On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns false). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.
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 on success. On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns false). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.
FindCert
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 on success. On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns false). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.
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 on success. On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns false). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.
GetCardProperties
Gets all card properties and returns them in $json. See the example below.
Returns true on success. On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns false). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.
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 on success. On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns false). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.
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 on success. On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns false). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.
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 on success. On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns false). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.
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 on success. On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns false). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.
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 on success. On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns false). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.
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 on success. On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns false). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.
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.
PinChange
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 on success. On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns false). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.
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 on success. On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns false). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.
SignData
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 on success. On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns false). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.
WriteFile
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 on success. On failure it throws Chilkat2\Exception (or, with RaiseError set to false, returns false). $e->getMessage() (or the object's LastErrorText) explains why, and the object remains usable.