Csp ActiveX Reference Documentation

Csp

Represents a cryptographic service provider for selecting encryption, hashing, and digital signing algorithms.

This class is specific to the Windows operating system, and therefore is only available on Windows systems.

Object Creation

(Visual Basic 6.0)
Dim obj As New ChilkatCsp

(ASP)
set obj = Server.CreateObject("Chilkat_9_5_0.Csp")

(VBScript)
set obj = CreateObject("Chilkat_9_5_0.Csp")

(Delphi)
obj := TChilkatCsp.Create(Self);

(FoxPro)
loObject = CreateObject('Chilkat_9_5_0.Csp')

(PowerBuilder)
lole_object = create oleobject
li_rc = lole_object.ConnectToNewObject("Chilkat_9_5_0.Csp")

(SQL Server)
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Csp', @obj OUT

(Javascript)
var obj = new ActiveXObject("Chilkat_9_5_0.Csp");

Properties

DebugLogFilePath As String

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:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

EncryptAlgorithm As String (read-only)

Returns the name of the currently selected encryption algorithm in the currently selected CSP.

EncryptAlgorithmID As Long (read-only)

Returns the ID of the currently selected encryption algorithm in the currently selected CSP.

EncryptNumBits As Long (read-only)

Returns the key-length of the currently selected encryption algorithm in the currently selected CSP.

HashAlgorithm As String (read-only)

Returns the name of the currently selected hash algorithm in the currently selected CSP.

HashAlgorithmID As Long (read-only)

Returns the ID of the currently selected hash algorithm in the currently selected CSP.

HashNumBits As Long (read-only)

Returns the bit length of the currently selected hash algorithm in the currently selected CSP.

KeyContainerName As String

The name of the currently selected key container within the currently selected CSP. The default is typically the name of the current logged-in user.

LastBinaryResult As Variant (read-only)

Introduced in version 9.5.0.52

The binary data returned by the last (binary data returning) method called. Only available if Chilkat.Global.KeepBinaryResult is set to 1. This provides a means for obtaining large varbinary results in the SQL Server environment (where limitations exist in getting large amounts of data returned by method calls, but where temp tables can be used for binary properties).

LastErrorHtml As String (read-only)

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.

LastErrorText As String (read-only)

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.

Concept of LastErrorText

LastErrorText Standard Information

LastErrorXml As String (read-only)

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.

LastMethodSuccess As Long

Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 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 = 1 and failure = 0.
  • 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 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

LastStringResult As String (read-only)

Introduced in version 9.5.0.52

The string return value of the last (string returning) method called. Only available if Chilkat.Global.KeepStringResult is set to 1. This provides a means for obtaining large string results in the SQL Server environment (where limitations exist in getting long strings returned by method calls, but where temp tables can be used for string properties).

Long Strings Returned by ActiveX Methods in SQL Server

LastStringResultLen As Long (read-only)

Introduced in version 9.5.0.53

The length, in characters, of the string contained in the LastStringResult property.

MachineKeyset As Long

To be documented soon.

NumEncryptAlgorithms As Long (read-only)

The number of encryption algorithms provided by the currently selected CSP.

NumHashAlgorithms As Long (read-only)

The number of hash algorithms provided by the currently selected CSP.

NumKeyContainers As Long (read-only)

The number of key containers provided by the currently selected CSP.

NumKeyExchangeAlgorithms As Long (read-only)

The number of key exchange algorithms provided by the currently selected CSP.

NumSignatureAlgorithms As Long (read-only)

The number of signature algorithms provided by the currently selected CSP.

ProviderName As String

The currently selected CSP. To select another CSP, simply set this property to the name of the CSP, such as "Microsoft Enhanced Cryptographic Provider v1.0". If the CSP is not available on your machine, the property value will not change. The initial and default value for this property is "Microsoft Base Cryptographic Provider v1.0".

ProviderType As Long (read-only)

This is an integer representing the type of CSP. (Chilkat uses it for internal use.)

VerboseLogging As Long

If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

Version As String (read-only)

Version of the component/library, such as "9.5.0.63"

Methods

GetKeyContainerNames() As CkStringArray

To be documented soon...

Returns Nothing on failure

HasEncryptAlgorithm(name As String, ByVal numBits As Long) As Long

Returns true if the currently selected CSP contains an encryption algorithm matching the name and key length. Otherwise returns false.

HasHashAlgorithm(name As String, ByVal numBits As Long) As Long

Returns true if the currently selected CSP contains a hash algorithm matching the name and bit length. Otherwise returns false.

Initialize() As Long

Intializes the Csp with the selected ProviderName.

NthEncryptionAlgorithm(ByVal index As Long) As String

Returns the name of the Nth encryption algorithm provided by the currently selected CSP. Indexing begins at 0.

Returns Nothing on failure

NthEncryptionNumBits(ByVal index As Long) As Long

Returns the key-length of the currently selected encryption algorithm in the currently selected CSP.

NthHashAlgorithmName(ByVal index As Long) As String

To be documented soon...

Returns Nothing on failure

NthHashNumBits(ByVal index As Long) As Long

Returns the bit length of the Nth hash algorithm provided by the currently selected CSP. Indexing begins at 0.

NthKeyContainerName(ByVal index As Long) As String

Returns the Nth key container name in the currently selected CSP. Indexing begins at 0.

Returns Nothing on failure

NthKeyExchangeAlgorithm(ByVal index As Long) As String

Returns the Nth key exchange algorithm provided by the currently selected CSP. Indexing begins at 0.

Returns Nothing on failure

NthKeyExchangeNumBits(ByVal index As Long) As Long

Returns the bit length of the Nth key exchange algorithm provided by the currently selected CSP. Indexing begins at 0.

NthSignatureAlgorithm(ByVal index As Long) As String

Returns the name of the Nth signature algorithm provided by the currently selected CSP. Indexing begins at 0.

Returns Nothing on failure

NthSignatureNumBits(ByVal index As Long) As Long

Returns the bit length of the Nth signature algorithm provided by the currently selected CSP. Indexing begins at 0.

SetEncryptAlgorithm(name As String) As Long

Selects an encryption algorithm. The return value is the key-length of the algorithm. If the algorithm is not available, the return value is 0. (There usually is not a need to explicitly select the key length, because the key length can be part of the name, such as "AES 128", or it is determined by the CSP. For example, the Microsoft Enhanced CSP will return a 128-bit key length for RC2, whereas the Base CSP will return a 40-bit key length.)

SetHashAlgorithm(name As String) As Long

Selects a hash algorithm. The return value is the bit-length of the algorithm. If the algorithm is not available, the return value is 0.

SetProviderMicrosoftBase() As Long

Sets the CSP to the Base Microsoft Cryptographic Provider, which is the default.

SetProviderMicrosoftEnhanced() As Long

Sets the CSP to the Enhanced Microsoft Cryptographic Provider.

SetProviderMicrosoftRsaAes() As Long

Sets the CSP to the Microsoft Cryptographic RSA/AES Prototype Provider.

SetProviderMicrosoftStrong() As Long

Sets the CSP to the Strong Microsoft Cryptographic Provider.