Namespace scmapi
Classes
Certificate
This class describes a certificate object. Inherits from TokenObject.
Note that the constructor is not intended to be called by user code. Such objects are constructed internally by the API.
Key
Abstract class describes a key object. Inherits from TokenObject.
KeyPair
Pin
Class represents a PIN that protects smart card contents.
PinConstraint
Class describes the format constraints of the PIN (which must be enforced when changing the PIN value).
Note that the constructor is not intended to be called by user code. Such objects are constructed internally by the API.
The constraints are obtained as an list of PinConstraint objects by calling GetConstraints().
The objects PinConstraint describing a constraint all have a type, indicating the type of the constraint, and optionally, the parameters of the constraint. The type can be one of the following (this list may be extended in the future):
minLength: The number of characters in the PIN must be at least the number given in the first parameters.exactLength: The number of characters in the PIN must be exactly the number given in the first parameters.minMaxLength: The number of characters in the PIN must be between the number given in the first parameters and the number given in the second parameters.minDigits: The PIN must contain at least the number of the first parameters digits characters.minUpperCase: The PIN must contain at least the number of uppercase letters given in the first parameters.minSpecial: The PIN must contain at least the number of special characters given in the first parameters.minLowerCase: The PIN must contain at least the number of lowercase letters given in the first parameters.newOldDifferent: The new PIN value must be different from the old PIN value.newOldDissimilar: At least threshold percent of the characters must differ between the new PIN and the old PIN value.maxIncDecSequence: There must be no sequences of the number of increasing/decreasing characters given in the first parameters.maxIncDecSequence: There must be no sequences of the number of increasing/decreasing characters given in the first parameters.
PrivateKey
Class describes a private key object. Inherits from Key.
Note that the constructor is not intended to be called by user code. Such objects are constructed internally by the API.
PublicKey
Class describes a public key object. Inherits from Key.
Note that the constructor is not intended to be called by user code. Such objects are constructed internally by the API.
Reader
Class represents a smart card reader (either a physical, hardware reader, or a virtual smart card).
RSAPrivateKey
Class describes a RSA private key object. Inherits from PrivateKey.
Note that the constructor is not intended to be called by user code. Such objects are constructed internally by the API.
RSAPublicKey
Class describes a RSA public key object. Inherits from PublicKey.
Note that the constructor is not intended to be called by user code. Such objects are constructed internally by the API.
SCMEnvironment
Main class for the Smart Card Middleware API. Provides the initial entry points for connecting to the SCWS, obtaining the readers and listening to events.
SCMException
Token
Class represents connection to a smart card (or more generally, any cryptographic device). Token objects are obtained by calling the Connect() method.
TokenObject
Abstract class describes a cryptographic object located in a smart card.
Interfaces
ExternalAuthenticateHandler
MutualAuthenticateHandler
ReaderEvents
Interface used to received smart card reader events.