CkCsp Perl Reference Documentation

CkCsp

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

$obj = chilkat::CkCsp()->new();

Properties

# $strVal is a string
# $ckStr is a CkString
$csp->get_DebugLogFilePath($ckStr);
$strVal = $csp->debugLogFilePath();
$csp->put_DebugLogFilePath($strVal);

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.

# $strVal is a string
# $ckStr is a CkString
$csp->get_EncryptAlgorithm($ckStr);
$strVal = $csp->encryptAlgorithm();

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

# $intVal is an integer
$intVal = $csp->get_EncryptAlgorithmID();

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

# $intVal is an integer
$intVal = $csp->get_EncryptNumBits();

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

# $strVal is a string
# $ckStr is a CkString
$csp->get_HashAlgorithm($ckStr);
$strVal = $csp->hashAlgorithm();

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

# $intVal is an integer
$intVal = $csp->get_HashAlgorithmID();

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

# $intVal is an integer
$intVal = $csp->get_HashNumBits();

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

# $strVal is a string
# $ckStr is a CkString
$csp->get_KeyContainerName($ckStr);
$strVal = $csp->keyContainerName();
$csp->put_KeyContainerName($strVal);

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.

# $strVal is a string
# $ckStr is a CkString
$csp->get_LastErrorHtml($ckStr);
$strVal = $csp->lastErrorHtml();

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.

# $strVal is a string
# $ckStr is a CkString
$csp->get_LastErrorText($ckStr);
$strVal = $csp->lastErrorText();

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

# $strVal is a string
# $ckStr is a CkString
$csp->get_LastErrorXml($ckStr);
$strVal = $csp->lastErrorXml();

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.

# $boolVal is a boolean
$boolVal = $csp->get_LastMethodSuccess();
$csp->put_LastMethodSuccess($boolVal);

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.

# $boolVal is a boolean
$boolVal = $csp->get_MachineKeyset();
$csp->put_MachineKeyset($boolVal);

To be documented soon.

# $intVal is an integer
$intVal = $csp->get_NumEncryptAlgorithms();

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

# $intVal is an integer
$intVal = $csp->get_NumHashAlgorithms();

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

# $intVal is an integer
$intVal = $csp->get_NumKeyContainers();

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

# $intVal is an integer
$intVal = $csp->get_NumKeyExchangeAlgorithms();

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

# $intVal is an integer
$intVal = $csp->get_NumSignatureAlgorithms();

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

# $strVal is a string
# $ckStr is a CkString
$csp->get_ProviderName($ckStr);
$strVal = $csp->providerName();
$csp->put_ProviderName($strVal);

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".

# $intVal is an integer
$intVal = $csp->get_ProviderType();

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

# $boolVal is a boolean
$boolVal = $csp->get_Utf8();
$csp->put_Utf8($boolVal);

When set to 1, all "const char *" arguments are interpreted as utf-8 strings. If set to 0 (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to 1, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to 0, all "const char *" return values are ANSI strings.

# $boolVal is a boolean
$boolVal = $csp->get_VerboseLogging();
$csp->put_VerboseLogging($boolVal);

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.

# $strVal is a string
# $ckStr is a CkString
$csp->get_Version($ckStr);
$strVal = $csp->version();

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

Methods

# returns a CkStringArray
$ret_stringArray = $csp->GetKeyContainerNames();

To be documented soon...

Returns null on failure

# $name is a string
# $numBits is an integer
$retBool = $csp->HasEncryptAlgorithm($name, $numBits);

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

# $name is a string
# $numBits is an integer
$retBool = $csp->HasHashAlgorithm($name, $numBits);

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

$retBool = $csp->Initialize();

Intializes the Csp with the selected ProviderName.

# $index is an integer
# $outName is a CkString (output)
$status = $csp->NthEncryptionAlgorithm($index, $outStr);
$retStr = $csp->nthEncryptionAlgorithm($index);

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

Returns 1 for success, 0 for failure.

# $index is an integer
$retInt = $csp->NthEncryptionNumBits($index);

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

# $index is an integer
# $outName is a CkString (output)
$status = $csp->NthHashAlgorithmName($index, $outStr);
$retStr = $csp->nthHashAlgorithmName($index);

To be documented soon...

Returns 1 for success, 0 for failure.

# $index is an integer
$retInt = $csp->NthHashNumBits($index);

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

# $index is an integer
# $outName is a CkString (output)
$status = $csp->NthKeyContainerName($index, $outStr);
$retStr = $csp->nthKeyContainerName($index);

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

Returns 1 for success, 0 for failure.

# $index is an integer
# $outName is a CkString (output)
$status = $csp->NthKeyExchangeAlgorithm($index, $outStr);
$retStr = $csp->nthKeyExchangeAlgorithm($index);

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

Returns 1 for success, 0 for failure.

# $index is an integer
$retInt = $csp->NthKeyExchangeNumBits($index);

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

# $index is an integer
# $outName is a CkString (output)
$status = $csp->NthSignatureAlgorithm($index, $outStr);
$retStr = $csp->nthSignatureAlgorithm($index);

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

Returns 1 for success, 0 for failure.

# $index is an integer
$retInt = $csp->NthSignatureNumBits($index);

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

# $path is a string
$status = $csp->SaveLastError($path);

Saves the last-error information (the contents of LastErrorXml) to an XML formatted file.

Returns 1 for success, 0 for failure.

# $name is a string
$retInt = $csp->SetEncryptAlgorithm($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.)

# $name is a string
$retInt = $csp->SetHashAlgorithm($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.

$retBool = $csp->SetProviderMicrosoftBase();

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

$retBool = $csp->SetProviderMicrosoftEnhanced();

Sets the CSP to the Enhanced Microsoft Cryptographic Provider.

$retBool = $csp->SetProviderMicrosoftRsaAes();

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

$retBool = $csp->SetProviderMicrosoftStrong();

Sets the CSP to the Strong Microsoft Cryptographic Provider.