_CERT_KEY_CONTEXT Type Definition
- cbSize As ULong
- hCryptProv As ULong
- dwKeySpec As ULong
|
_CRYPT_KEY_PROV_INFO Type Definition
- pwszContainerName As String
- pwszProvName As String
- dwProvType As ULong
- dwFlags As ULong
- cProvParam As ULong
- rgProvParam As _CRYPT_KEY_PROV_PARAM
- dwKeySpec As ULong
|
_CRYPT_KEY_PROV_PARAM Type Definition
- dwParam As ULong
- pbData As Byte
- cbData As ULong
- dwFlags As ULong
|
CAPICOM.Algorithm
- .Name() As CAPICOM_ENCRYPTION_ALGORITHM
- Default property to get encryption algorithm.
- .Name(RHS As CAPICOM_ENCRYPTION_ALGORITHM)
- Overloaded property to get encryption algorithm.
- .KeyLength() As CAPICOM_ENCRYPTION_KEY_LENGTH
- Default property to get encryption key length. This property is ignored for DES or 3DES.
- .KeyLength(RHS As CAPICOM_ENCRYPTION_KEY_LENGTH)
- Overloaded property to get encryption key length. This property is ignored for DES or 3DES.
|
CAPICOM.Attribute
- .Name() As CAPICOM_ATTRIBUTE
- Default property to get attribute name.
- .Name(RHS As CAPICOM_ATTRIBUTE)
- Overloaded property to get attribute name.
- .Value() As Variant.
- Default property to get attribute value.
- .Value(RHS As Variant)
- Overloaded property to get attribute value.
|
CAPICOM.Attributes A collection of type 'attribute'
- .Item(ByVal Index As Long) As Variant
- Indexed property 'Item' of type 'attribute'
- .Count() As Long
- Property -- a count of items in the collection.
- .Add(ByRef pVal As IAttribute)
- Subroutine to Add items to the collection.
- .Remove(ByVal Index As Long)
- Subroutine to remove an item from the collection by it's index.
- .Clear
- Subroutine to clear all items from the collection.
|
CAPICOM.BasicConstraints
- .IsPresent() As Boolean
- Property to check if the BasicConstraints extension is present.
- .IsCritical() As Boolean
- Property to check if the BasicConstraints extension is marked critical.
- .IsCertificateAuthority() As Boolean
- Property to check if it is a certificate authority.
- .IsPathLenConstraintPresent() As Boolean
- Property to check if the path length constraint value is present.
- .PathLenConstraint() As Long
- Property to get the path length constraint value.
|
CAPICOM.Certificate
- .Version() As Long
- Property to get the version number.
- .SerialNumber() As String
- Property to get the serial number.
- .SubjectName() As String
- Property to get the subject's name.
- .IssuerName() As String
- Property to get the issuer's name.
- .ValidFromDate() As Date
- Property to get the valid notBefore date.
- .ValidToDate() As Date
- Property to get the valid notAfter date.
- .Thumbprint() As String
- Property to get the SHA1 hash.
- .HasPrivateKey() As Boolean
- Function to check if private key is available.
- .GetInfo(ByVal InfoType As CAPICOM_CERT_INFO_TYPE) As String
- Function to get other simple information of the certificate.
- .IsValid() As ICertificateStatus
- Function to return the ICertificateStatus object for checking if the certificate is valid.
Function KeyUsage() As IKeyUsage
Method to return the KeyUsage object.
Function ExtendedKeyUsage() As IExtendedKeyUsage
Method to return the ExtendedKeyUsage object.
Function Basicraints As IBasicConstraints
Method to return the BasicConstraints object.
Function Export(ByVal EncodingType As CAPICOM_ENCODING_TYPE) As String
Method to export the certificate.
Sub Import(ByVal EncodedCertificate As String)
Method to import a certificate.
Sub Display
Method to display the certificate.
Property Get Archived() As Boolean
Property to get archived status.
Property Let Archived(RHS As Boolean)
Property to get archived status.
Function Template() As ITemplate
Method to return the Template object.
Function PublicKey() As IPublicKey
Method to return the PublicKey object.
Property Get PrivateKey() As IPrivateKey
Property to get the PrivateKey object.
Property Let PrivateKey(RHS As IPrivateKey)
Property to get the PrivateKey object.
Function Extensions() As IExtensions
Method to return the Extensions object.
Function ExtendedProperties() As IExtendedProperties
Method to return the ExtendedProperties object.
Sub Load(ByVal FileName As String, ByVal Password As String, ByVal KeyStorageFlag As CAPICOM_KEY_STORAGE_FLAG, ByVal KeyLocation As CAPICOM_KEY_LOCATION)
Method to load a certificate from file.
Sub Save(ByVal FileName As String, ByVal Password As String, ByVal SaveAs As CAPICOM_CERTIFICATE_SAVE_AS_TYPE, ByVal IncludeOption As CAPICOM_CERTIFICATE_INCLUDE_OPTION)
Method to save a certificate to file, with option to include the chain for PFX file.
|
CAPICOM.CertificatePolicies
Property Get Item(ByVal Index As Long) As Variant
Property Item.
Property Get Count() As Long
Property Count.
|
CAPICOM.Certificates
Property Get Item(ByVal Index As Long) As Variant
Property Item.
Property Get Count() As Long
Property Count.
Function Find(ByVal FindType As CAPICOM_CERTIFICATE_FIND_TYPE, ByVal varCriteria As Variant, ByVal bFindValidOnly As Boolean) As ICertificates2
Method to find certificates in the collection.
Function Select(ByVal Title As String, ByVal DisplayString As String, ByVal bMultiSelect As Boolean) As ICertificates2
Method to display the certificate selection dialog box.
Sub Add(ByRef pVal As ICertificate2)
Method to add a certificate to the collection.
Sub Remove(ByVal Index As Variant)
Method to remove a certificate in the collection.
Sub Clear
Method to remove all certificates in the collection.
Sub Save(ByVal FileName As String, ByVal Password As String, ByVal SaveAs As CAPICOM_CERTIFICATES_SAVE_AS_TYPE, ByVal ExportFlag As CAPICOM_EXPORT_FLAG)
Method to save certificate collection to file.
|
CAPICOM.CertificateStatus
Property Get Result() As Boolean
Default property to get the certificate validity result.
Property Get CheckFlag() As CAPICOM_CHECK_FLAG
Property to get validity check flag.
Property Let CheckFlag(RHS As CAPICOM_CHECK_FLAG)
Property to get validity check flag.
Function EKU() As IEKU
Method to return an IEKU object for setting extended key usage to check (default is no EKU check).
Property Get VerificationTime() As Date
Property to get verification time.
Property Let VerificationTime(RHS As Date)
Property to get verification time.
Property Get UrlRetrievalTimeout() As Long
Property to get the URL retrieval timeout value (in seconds).
Property Let UrlRetrievalTimeout(RHS As Long)
Property to get the URL retrieval timeout value (in seconds).
Function CertificatePolicies() As IOIDs
Method to get the certificate policies OIDs collection.
Function ApplicationPolicies() As IOIDs
Method to get the application policies OIDs collection.
Property Get ValidationCertificates() As ICertificates
Property to get useful validation certificates.
|
CAPICOM.Chain
Property Get Certificates() As ICertificates
Default property to get an ordered certificates collection object representing the chain, where Item(1) represents the end certificate and Item(Count()) represents the root certificate.
Property Get Status(ByVal Index As Long) As Long
Property to get validity status of the chain or a particular certficate. For overall chain status, specify Index of 0, otherwise specify the 1 for the end certificate, and Certificates.Count() for the root certificate.
Function Build(ByRef pICertificate As ICertificate) As Boolean
Method to build the certificate chain and get the overall result of the chain validity.
Function CertificatePolicies() As IOIDs
Method to get the certificate policies OIDs collection.
Function ApplicationPolicies() As IOIDs
Method to get the application policies OIDs collection.
Function ExtendedErrorInfo(ByVal Index As Long) As String
Method to get the extended error information description string.
|
CAPICOM.EKU Extended Key Usage object
Property Get Name() As CAPICOM_EKU
Default property to get EKU name.
Property Let Name(RHS As CAPICOM_EKU)
Default property to get EKU name.
Property Get OID() As String
Property to get the actual EKU OID string as defined in WinCrypt.h.
Property Let OID(RHS As String)
Property to get the actual EKU OID string as defined in WinCrypt.h.
|
EKUs
Property Get Item(ByVal Index As Long) As Variant
Property Item.
Property Get Count() As Long
Property Count.
|
EncodedData
Property Get Value(ByVal EncodingType As CAPICOM_ENCODING_TYPE) As String
Default property to get the encoded data.
Function Format(ByVal bMultiLines As Boolean) As String
Method to format the encoded data for display purpose.
Function Decoder() As Object
Method to return the decoder object (IDispatch), which can be NULL.
|
EncryptedData
Property Let Content(RHS As String)
Default property to set the content to be encrypted.
Property Get Content() As String
Default property to set the content to be encrypted.
Property Get Algorithm() As IAlgorithm
Property to get/set the encryption algorithm.
Sub SetSecret(ByVal newVal As String, ByVal SecretType As CAPICOM_SECRET_TYPE)
Method to set the secret used to generate the symmetric key.
Function Encrypt(ByVal EncodingType As CAPICOM_ENCODING_TYPE) As String
Method to encrypt the content.
Sub Decrypt(ByVal EncryptedMessage As String)
Method to decrypt the encrypted content.
|
EnvelopedData
Property Let Content(RHS As String)
Default property to set the content to be enveloped.
Property Get Content() As String
Default property to set the content to be enveloped.
Property Get Algorithm() As IAlgorithm
Property to get/set the encryption algorithm.
Property Get Recipients() As IRecipients
Property to add/remove recipients.
Function Encrypt(ByVal EncodingType As CAPICOM_ENCODING_TYPE) As String
Method to envelop the content.
Sub Decrypt(ByVal EnvelopedMessage As String)
Method to decrypt the enveloped content.
|
CAPICOM.ExtendedKeyUsage
Property Get IsPresent() As Boolean
Property to check if the EKU extension is present.
Property Get IsCritical() As Boolean
Property to check if the EKU extension is marked critical.
Property Get EKUs() As IEKUs
Property to return an EKUs collection object.
|
CAPICOM.ExtendedProperties
Property Get Item(ByVal Index As Long) As Variant
Property Item.
Property Get Count() As Long
Property Count.
Sub Add(ByRef pVal As IExtendedProperty)
Method Add.
Sub Remove(ByVal PropID As CAPICOM_PROPID)
Method Remove.
|
CAPICOM.ExtendedProperty
Property Get PropID() As CAPICOM_PROPID
Default property to get PropID.
Property Let PropID(RHS As CAPICOM_PROPID)
Default property to get PropID.
Property Get Value(ByVal EncodingType As CAPICOM_ENCODING_TYPE) As String
Property to get the extended property data.
Property Let Value(ByVal EncodingType As CAPICOM_ENCODING_TYPE, RHS As String)
Property to get the extended property data.
|
CAPICOM.Extension
Property Get OID() As IOID
Default property to get the IOID object.
Property Get IsCritical() As Boolean
Property to get IsCritical setting.
Property Get EncodedData() As IEncodedData
Property to get the EncodedData object.
|
CAPICOM.Extensions
Property Get Item(ByVal Index As Variant) As Variant
Property Item.
Property Get Count() As Long
Property Count.
|
CAPICOM.HashedData
Property Get Value() As String
Default property to get hashed value in hex format. Once the hashed value is obtained, future call to the Hash method starts a new hash.
Property Get Algorithm() As CAPICOM_HASH_ALGORITHM
Property to get hashing algorithm.
Property Let Algorithm(RHS As CAPICOM_HASH_ALGORITHM)
Property to get hashing algorithm.
Sub Hash(ByVal newVal As String)
Method to hash data. Must repeatedly call this method until all data are hashed, then the hashed value can be obtained through the Value property.
|
CAPICOM.ICCertificates
|
CAPICOM.ICertContext
Property Get CertContext() As Long
Poperty to get PCCERT_CONTEXT of the certificate which is represented as a long. Note that you MUST call either the FreeContext method or CAPI's CertFreeCertificateContext() function, to free the context.
Property Let CertContext(RHS As Long)
Poperty to get PCCERT_CONTEXT of the certificate which is represented as a long. Note that you MUST call either the FreeContext method or CAPI's CertFreeCertificateContext() function, to free the context.
Sub FreeContext(ByVal pCertContext As Long)
Method to free a PCCERT_CONTEXT. Note that this method does not free the PCCERT_CONTEXT contained within the Certificate object. It is intended for freeing context acquired through the CertContext property.
|
CAPICOM.ICertificate
Property Get Version() As Long
Property to get the version number.
Property Get SerialNumber() As String
Property to get the serial number.
Property Get SubjectName() As String
Property to get the subject's name.
Property Get IssuerName() As String
Property to get the issuer's name.
Property Get ValidFromDate() As Date
Property to get the valid notBefore date.
Property Get ValidToDate() As Date
Property to get the valid notAfter date.
Property Get Thumbprint() As String
Property to get the SHA1 hash.
Function HasPrivateKey() As Boolean
Method to check if private key is available.
Function GetInfo(ByVal InfoType As CAPICOM_CERT_INFO_TYPE) As String
Method to get other simple information of the certificate.
Function IsValid() As ICertificateStatus
Method to return the ICertificateStatus object for checking if the certificate is valid.
Function KeyUsage() As IKeyUsage
Method to return the KeyUsage object.
Function ExtendedKeyUsage() As IExtendedKeyUsage
Method to return the ExtendedKeyUsage object.
Function Basicraints As IBasicConstraints
Method to return the BasicConstraints object.
Function Export(ByVal EncodingType As CAPICOM_ENCODING_TYPE) As String
Method to export the certificate.
Sub Import(ByVal EncodedCertificate As String)
Method to import a certificate.
Sub Display
Method to display the certificate.
|
CAPICOM.ICertificates
Property Get Item(ByVal Index As Long) As Variant
Property Item.
Property Get Count() As Long
Property Count.
|
CAPICOM.ICertificateStatus
Property Get Result() As Boolean
Default property to get the certificate validity result.
Property Get CheckFlag() As CAPICOM_CHECK_FLAG
Property to get validity check flag.
Property Let CheckFlag(RHS As CAPICOM_CHECK_FLAG)
Property to get validity check flag.
Function EKU() As IEKU
Method to return an IEKU object for setting extended key usage to check (default is no EKU check).
|
CAPICOM.ICertificateStatus2
Property Get Result() As Boolean
Default property to get the certificate validity result.
Property Get CheckFlag() As CAPICOM_CHECK_FLAG
Property to get validity check flag.
Property Let CheckFlag(RHS As CAPICOM_CHECK_FLAG)
Property to get validity check flag.
Function EKU() As IEKU
Method to return an IEKU object for setting extended key usage to check (default is no EKU check).
Property Get VerificationTime() As Date
Property to get verification time.
Property Let VerificationTime(RHS As Date)
Property to get verification time.
Property Get UrlRetrievalTimeout() As Long
Property to get the URL retrieval timeout value (in seconds).
Property Let UrlRetrievalTimeout(RHS As Long)
Property to get the URL retrieval timeout value (in seconds).
Function CertificatePolicies() As IOIDs
Method to get the certificate policies OIDs collection.
Function ApplicationPolicies() As IOIDs
Method to get the application policies OIDs collection.
|
CAPICOM.ICertStore
Property Get StoreHandle() As Long
Property to get HCERTSTORE of the certificate store which is represented as a long. Note that you MUST call either the CloseHandle method or CAPI's CertCloseStore() function to close the handle.
Property Let StoreHandle(RHS As Long)
Property to get HCERTSTORE of the certificate store which is represented as a long. Note that you MUST call either the CloseHandle method or CAPI's CertCloseStore() function to close the handle.
Property Get StoreLocation() As CAPICOM_STORE_LOCATION
Property to get CAPICOM_STORE_LOCATION of the certificate store.
Property Let StoreLocation(RHS As CAPICOM_STORE_LOCATION)
Property to get CAPICOM_STORE_LOCATION of the certificate store.
Sub CloseHandle(ByVal hCertStore As Long)
Method to close a HCERTSTORE. Note that this method does not close the HCERTSTORE contained within the Store object. It is intended for closing handle acquired through the StoreHandle property.
|
CAPICOM.IChain
Property Get Certificates() As ICertificates
Default property to get an ordered certificates collection object representing the chain, where Item(1) represents the end certificate and Item(Count()) represents the root certificate.
Property Get Status(ByVal Index As Long) As Long
Property to get validity status of the chain or a particular certficate. For overall chain status, specify Index of 0, otherwise specify the 1 for the end certificate, and Certificates.Count() for the root certificate.
Function Build(ByRef pICertificate As ICertificate) As Boolean
Method to build the certificate chain and get the overall result of the chain validity.
|
CAPICOM.IChainContext
Property Get ChainContext() As Long
Property to get PCCERT_CHAIN_CONTEXT of the certificate chain which is represented as a long. Note that you MUST call either the FreeContext method or CAPI's CertFreeCertificateChain() function to free the context.
Property Let ChainContext(RHS As Long)
Property to get PCCERT_CHAIN_CONTEXT of the certificate chain which is represented as a long. Note that you MUST call either the FreeContext method or CAPI's CertFreeCertificateChain() function to free the context.
Sub FreeContext(ByVal pChainContext As Long)
Method to free a PCCERT_CHAIN_CONTEXT. Note that this method does not free the PCCERT_CHAIN_CONTEXT contained within the Chain object. It is intended for freeing context acquired through the ChainContext property.
|
CAPICOM.ICPrivateKey
|
CAPICOM.ICSigner
Property Get AdditionalStore() As Long
Property to get HCERSTORE of the additional certificate store which is represented as a long.
Property Let AdditionalStore(RHS As Long)
Property to get HCERSTORE of the additional certificate store which is represented as a long.
|
CAPICOM.ISigner
Property Get Certificate() As ICertificate
Default property to get signer's certificate.
Property Let Certificate(RHS As ICertificate)
Default property to get signer's certificate.
Property Get AuthenticatedAttributes() As IAttributes
Property to add/remove authenticated attributes.
|
CAPICOM.IStore
Property Get Certificates() As ICertificates
Default property to get a Certificates collection object.
Sub Open(ByVal StoreLocation As CAPICOM_STORE_LOCATION, ByVal StoreName As String, ByVal OpenMode As CAPICOM_STORE_OPEN_MODE)
Method to open a store.
Sub Add(ByRef
pVal As ICertificate) Method
to add a certificate
to the store. Sub Remove(ByRef
pVal As ICertificate) Method to remove a certificate from the store.
Function Export(ByVal SaveAs As
CAPICOM_STORE_SAVE_AS_TYPE, ByVal EncodingType As
CAPICOM_ENCODING_TYPE) As String Method
to export the store.
Sub Import(ByVal EncodedStore As
String) Method to import
a store.
|
CAPICOM.IStore2
Property Get Certificates() As
ICertificates Default property to
get a Certificates collection
object. Sub Open(ByVal StoreLocation
As CAPICOM_STORE_LOCATION, ByVal StoreName
As String, ByVal OpenMode
As CAPICOM_STORE_OPEN_MODE) Method to
open a store. Sub
Add(ByRef pVal As ICertificate)
Method to add a
certificate to the store.
Sub Remove(ByRef pVal As
ICertificate) Method to remove
a certificate from the
store. Function Export(ByVal SaveAs
As CAPICOM_STORE_SAVE_AS_TYPE, ByVal EncodingType
As CAPICOM_ENCODING_TYPE) As String
Method to export the
store. Sub Import(ByVal EncodedStore
As String) Method to
import a store. Sub
Load(ByVal FileName As String,
ByVal Password As String,
ByVal KeyStorageFlag As CAPICOM_KEY_STORAGE_FLAG)
Method to load certificate(s)
from file.
|
CAPICOM.KeyUsage
Property Get IsPresent() As
Boolean Property to check
if the KeyUsage extension
is present. Property Get
IsCritical() As Boolean Property
to check if the
KeyUsage extension is marked
critical. Property Get IsDigitalSignatureEnabled()
As Boolean Property to
check if the digitalSignature
bit is set. Property
Get IsNonRepudiationEnabled() As Boolean
Property to check if
the nonRepudiation bit is
set. Property Get IsKeyEnciphermentEnabled()
As Boolean Property to
check if the keyEncipherment
bit is set. Property
Get IsDataEnciphermentEnabled() As Boolean
Property to check if
the dataEncipherment bit is
set. Property Get IsKeyAgreementEnabled()
As Boolean Property to
check if the keyAgreement
bit is set. Property
Get IsKeyCertSignEnabled() As Boolean
Property to check if
the keyCertSign bit is
set. Property Get IsCRLSignEnabled()
As Boolean Property to
check if the cRLSign
bit is set. Property
Get IsEncipherOnlyEnabled() As Boolean
Property to check if
the encipherOnly bit is
set. Property Get IsDecipherOnlyEnabled()
As Boolean Property to
check if the decipherOnly
bit is set.
|
CAPICOM.NoticeNumbers A collection of notice numbers.
- .Item(ByVal Index As Long) As Variant
- Getter method to retreive item by its index
- .Count() As Long
- Property -- a count of items in the collection.
|
CAPICOM.OID Object ID class
- .Name() As CAPICOM_OID
- Getter method to retrieve name.
- .Name(RHS As CAPICOM_OID)
- Setter method to recieve name.
- .FriendlyName() As String
- Getter method to retrieve the friendly name.
- .FriendlyName(RHS As String)
- Setter method to receive the friendly name.
- .Value() As String
- Getter method to retreive the OID string value as defined in WinCrypt.h.
- .Value(RHS As String)
- Setter method to receive the OID string value as defined in WinCrypt.h.
|
CAPICOM.OIDs Object ID Collection
- .Item(ByVal Index As Variant) As Variant
- Getter method to retreive an OID item contained in the collection by its index.
- .Count() As Long
- Getter method to retreive a count of OID items in the collection.
- .Add(ByRef pVal As IOID)
- Subroutine to add an OID item to the collection.
- .Remove(ByVal Index As Variant)
- Subroutine to remove an OID item from the collection by index.
- .Clear
- Subroutine to remove all OID items from the collection.
|
CAPICOM.PolicyInformation
- .OID() As IOID
- Default property to get the Object ID.
- .Qualifiers() As IQualifiers
- Property to get the qualifiers collection object.
|
CAPICOM.PrivateKey
- .ContainerName() As String
- Default property to get the key container name.
- .UniqueContainerName() As String
- Property to get the unique key container name.
- .ProviderName() As String
- Property to get the provider name.
- .ProviderType() As CAPICOM_PROV_TYPE
- Property to get the provider type.
- .KeySpec() As CAPICOM_KEY_SPEC
- Property to get the key spec value.
- .IsAccessible() As Boolean
- Function to check if the key is accessible.
- .IsProtected() As Boolean
- Function to check if the key is protected.
- .IsExportable() As Boolean
- Function to check if the key is marked exportable.
- .IsRemovable() As Boolean
- Function to check if the key is in removable storage.
- .IsMachineKeyset() As Boolean
- Function to check if the key is a machine keyset.
- .IsHardwareDevice() As Boolean
- Function to check if the key is stored in hardware device.
- .Open(ContainerName As String, ProviderName As String, ProviderType As CAPICOM_PROV_TYPE, KeySpec As CAPICOM_KEY_SPEC, StoreLocation As CAPICOM_STORE_LOCATION, bCheckExistence As Boolean)
- Subroutine to open an existing key container.
- .Delete
- Subroutine to delete the existing key container.
|
CAPICOM.PublicKey
- .Algorithm() As IOID
- Getter method to retreive the algorithm Object ID object.
- .Length() As Long
- Property to get key length.
- .EncodedKey() As IEncodedData
- Property to get the EncodedData object for the key.
- .EncodedParameters() As IEncodedData
- Property to get the EncodedData object for the parameters.
|
CAPICOM.Events.Qualifier
- .OID() As IOID
- Default property to get the Object ID.
- .CPSPointer() As String
- Property to get the URI for the Certificate Practice Statement (CPS).
- .OrganizationName() As String
- Property to get the organization name.
- .NoticeNumbers() As INoticeNumbers
- Property to get the notice numbers.
- .ExplicitText() As String
- Property to get the explicit text.
|
CAPICOM.Qualifiers
- .Item(ByVal Index As Long) As Variant
- Property -- an item in the qualifiers collection
- .Count() As Long
- Property -- a count of items in the qualifier collection
|
CAPICOM.Events.Recipients
- .Item(Index As Long) As Variant
- Property -- an item in the collection
- .Count() As Long
- Property -- count of items in the collection.
- .Add(pVal As ICertificate)
- Subroutine to add items to collection.
- .Remove(Index As Long)
- Subroutine to remove an item from collection by its index.
- .Clear
- Subroutine to remove all items from the collection.
|
CAPICOM.Events.Settings
- .EnablePromptForCertificateUI() As Boolean
- Getter method to retreive the current setting to enable/disable dialog box to prompt for certificate used to sign/decrypt a message.
- .EnablePromptForCertificateUI(RHS As Boolean)
- Setter method to receive the current setting to enable/disable dialog box to prompt for certificate used to sign/decrypt a message.
- .ActiveDirectorySearchLocation() As CAPICOM_ACTIVE_DIRECTORY_SEARCH_LOCATION
- Getter method to retreive the current Active Directory search location.
- .ActiveDirectorySearchLocation(RHS As CAPICOM_ACTIVE_DIRECTORY_SEARCH_LOCATION)
- Setter method to receive the current Active Directory search location.
|
CAPICOM.SignedCode
- .FileName
- RW 'string' property to get or set the filename of code to be signed.
- .Description
- RW 'string' property to get or set the description text.
- .DescriptionURL
- RW 'string' property to get or set the description URL.
- .Signer As ISigner2
- RO 'ISigner2' property to get the signer.
- .TimeStamper
- RO 'ISigner2' property to get the time stamper.
- .Certificates
- RO 'ICertificates2' property to get the 'certificates' collection.
- .Sign(signer as ISigner2)
- Subroutine to sign the code.
- .Timestamp(url As String)
- Subroutine to timestamp the signed code.
- .Verify(allowed As Boolean)
- Subroutine to verify the signed code.
|
CAPICOM.SignedData
- .Content
- RW 'string' property to get or set content to be signed.
- .Signers
- RO 'ISigners' property to get all the content signers as an 'ISigners' collection object.
- .Certificates
- RO "ICertificates' property to get all certificates in the signed message.
- .Sign(signer As ISigner, detached As Boolean, encodingType As CAPICOM_ENCODING_TYPE) As String
- Function to sign the message.
- .CoSign(signer As ISigner, encodingType As CAPICOM_ENCODING_TYPE) As String
- Function to CoSign the message.
- .Verify(signedMessage As String, detached As Boolean, verifyFlag As CAPICOM_SIGNED_DATA_VERIFY_FLAG) As Boolean
- Subroutine to verify if signature(s) in the signed message is cryptographically valid.
|
CAPICOM.Signer - .Certificate
- RW 'ICertificate' property to get or set signer's certificate.
- .AuthenticatedAttributes
- RO 'IAttributes' collection to add/remove authenticated attributes.
- .Chain() As IChain
- RO 'IChain' property to get signer's chain.
- .Options
- RW 'CAPICOM_CERTIFICATE_INCLUDE_OPTION' property to get or set signer options.
- .Load(fileName As String, password As String)
- Subroutine to load signing certificate from a PFX file.
|
CAPICOM.SignersA collection of type "Signer".
- .Item(Index As Long) As Variant
- Property -- an item in the signers collection.
- .Count() As Long
- Property -- a count of items in the signers collection
|
CAPICOM.Store A class representing the Windows certificate store.
- .Certificates
- RO 'ICertificates' property to get a Certificates collection object.
- .Open(storeLocation As CAPICOM_STORE_LOCATION, storeName As String, openMode As CAPICOM_STORE_OPEN_MODE)
- Subroutine to open a store.
- .Add(value As ICertificate)
- Subroutine to add a certificate to the store.
- .Remove(value As ICertificate)
- Subroutine to remove a certificate from the store.
- .Export(SaveAs As CAPICOM_STORE_SAVE_AS_TYPE, EncodingType As CAPICOM_ENCODING_TYPE) As String
- Function to export the store.
- .Import(encodedStore As String)
- Subroutine to import a store.
- .Load(fileName As String, password As String, keyStorageFlag As CAPICOM_KEY_STORAGE_FLAG)
- Subroutine to load certificate(s) from file.
- .Name
- RO 'string' property to get the name of the store.
- .Location
- Property to get the location of the store from CAPICOM_STORE_LOCATION.
- .Delete()
- Function to delete the store. Returns Boolean value.
- .Close()
- Subroutine to close the store.
|
CAPICOM.Template A data template structure. - .IsPresent
- RO 'Boolean' property to check if the CertificateTemplate extension is present.
- .IsCritical
- RO 'Boolean' property to check if the CertificateTemplate extension is marked critical.
- .Name
- RO 'string' property to get the name of the CertificateTemplate extension.
- .OID
- RO 'IOID' property to get an OI object.
- .MajorVersion
- RO 'Long Integer' property to get the major version number.
- .MinorVersion
-
RO 'Long Integer' property to get the minor version number.
|
CAPICOM.Utilities A class of useful conversion methods.
- .GetRandom(length As Long, encodingType As CAPICOM_ENCODING_TYPE) As String
- Function to get a secure random number.
- .Base64Encode(sourceString As String) As String
- Function to Base64 encode an unencoded text string.
- .Base64Decode(encodedString As String) As String
- Function to Base64 decode an encoded text string.
- .BinaryToHex(binaryString As String) As String
- Function to convert a binary packed string to hex string.
- .HexToBinary(hexString As String) As String
- Function to convert a hex string to binary packed string.
- .BinaryStringToByteArray(binaryString As String) As Variant
- Function to convert binary packed string to an array of bytes (VT_ARRAY | VT_UI1).
- .ByteArrayToBinaryString(varByteArray As Variant) As String
- Function to convert an array of bytes (VT_ARRAY | VT_UI1) to binary packed string.
- .LocalTimeToUTCTime(localTime As Date) As Date
- Function to convert local time to UTC time.
- .UTCTimeToLocalTime(UTCTime As Date) As Date
- Function to convert UTC time to local time.
|