Csp PHP ActiveX Reference Documentation

Csp

Current Version: 10.1.0

Note: This class is deprecated and should no longer be used.

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

Chilkat v10.0.0 or greater:
$obj = new COM("Chilkat.Csp");
Chilkat v9.5.0.*:
$obj = new COM("Chilkat_9_5_0.Csp");

Properties

DebugLogFilePath

string DebugLogFilePath

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.

More Information and Examples

Example showing how to use DebugLogFilePath.

EncryptAlgorithm

string EncryptAlgorithm (read-only)

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

EncryptAlgorithmID

int EncryptAlgorithmID (read-only)

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

EncryptNumBits

int EncryptNumBits (read-only)

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

HashAlgorithm

string HashAlgorithm (read-only)

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

HashAlgorithmID

int HashAlgorithmID (read-only)

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

HashNumBits

int HashNumBits (read-only)

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

LastBinaryResult

VARIANT LastBinaryResult (read-only)

The binary data returned by the last (binary data returning) method called. Only available if Chilkat.Global.KeepBinaryResult is set to true. 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

string LastErrorHtml (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

string LastErrorText (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.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

string LastErrorXml (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

bool LastMethodSuccess

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.

LastStringResult

string LastStringResult (read-only)

The string return value of the last (string returning) method called. Only available if Chilkat.Global.KeepStringResult is set to true. 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).

More Information and Examples

Long Strings Returned by ActiveX Methods in SQL Server

LastStringResultLen

int LastStringResultLen (read-only)

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

NumEncryptAlgorithms

int NumEncryptAlgorithms (read-only)

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

NumHashAlgorithms

int NumHashAlgorithms (read-only)

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

NumKeyContainers

int NumKeyContainers (read-only)

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

NumKeyExchangeAlgorithms

int NumKeyExchangeAlgorithms (read-only)

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

NumSignatureAlgorithms

int NumSignatureAlgorithms (read-only)

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

ProviderName

string ProviderName

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

int ProviderType (read-only)

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

UncommonOptions

string UncommonOptions

Introduced in version 9.5.0.83

This is a catch-all property to be used for uncommon needs. This property defaults to the empty string and should typically remain empty.

VerboseLogging

bool VerboseLogging

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

string Version (read-only)

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

More Information and Examples

How to get the Chilkat version at runtime.

Methods

HasEncryptAlgorithm

bool HasEncryptAlgorithm(string name, int numBits)

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

HasHashAlgorithm

bool HasHashAlgorithm(string name, int numBits)

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

Initialize

bool Initialize()

Intializes the Csp with the selected ProviderName.

NthEncryptionAlgorithm

string NthEncryptionAlgorithm(int index)

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

Returns null on failure

NthEncryptionNumBits

int NthEncryptionNumBits(int index)

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

NthHashAlgorithmName

string NthHashAlgorithmName(int index)

To be documented soon...

Returns null on failure

NthHashNumBits

int NthHashNumBits(int index)

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

NthKeyContainerName

string NthKeyContainerName(int index)

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

Returns null on failure

More Information and Examples

Find Certificate on Smartcard Currenty in Reader

NthKeyExchangeAlgorithm

string NthKeyExchangeAlgorithm(int index)

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

Returns null on failure

NthKeyExchangeNumBits

int NthKeyExchangeNumBits(int index)

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

NthSignatureAlgorithm

string NthSignatureAlgorithm(int index)

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

Returns null on failure

NthSignatureNumBits

int NthSignatureNumBits(int index)

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

SetEncryptAlgorithm

int SetEncryptAlgorithm(string name)

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

int SetHashAlgorithm(string name)

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.