Csp Unicode C 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.

Create/Dispose

HCkCspW CkCspW_Create(void);

Creates an instance of the HCkCspW object and returns a handle (i.e. a "void *" pointer). The handle is passed in the 1st argument for the functions listed on this page.

void CkCspW_Dispose(HCkCspW handle);

Objects created by calling CkCspW_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function. Also, any handle returned by a Chilkat "C" function must also be freed by the application by calling the appropriate Dispose method, such as CkCspW_Dispose.

Properties

void CkCspW_getDebugLogFilePath(HCkCspW cHandle, HCkString retval);

void CkCspW_putDebugLogFilePath(HCkCspW cHandle, const wchar_t *newVal);

const wchar_t *CkCspW_debugLogFilePath(HCkCspW cHandle);

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.

void CkCspW_getEncryptAlgorithm(HCkCspW cHandle, HCkString retval);

const wchar_t *CkCspW_encryptAlgorithm(HCkCspW cHandle);

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

int CkCspW_getEncryptAlgorithmID(HCkCspW cHandle);

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

int CkCspW_getEncryptNumBits(HCkCspW cHandle);

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

void CkCspW_getHashAlgorithm(HCkCspW cHandle, HCkString retval);

const wchar_t *CkCspW_hashAlgorithm(HCkCspW cHandle);

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

int CkCspW_getHashAlgorithmID(HCkCspW cHandle);

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

int CkCspW_getHashNumBits(HCkCspW cHandle);

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

void CkCspW_getKeyContainerName(HCkCspW cHandle, HCkString retval);

void CkCspW_putKeyContainerName(HCkCspW cHandle, const wchar_t *newVal);

const wchar_t *CkCspW_keyContainerName(HCkCspW cHandle);

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.

void CkCspW_getLastErrorHtml(HCkCspW cHandle, HCkString retval);

const wchar_t *CkCspW_lastErrorHtml(HCkCspW cHandle);

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.

void CkCspW_getLastErrorText(HCkCspW cHandle, HCkString retval);

const wchar_t *CkCspW_lastErrorText(HCkCspW cHandle);

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.

void CkCspW_getLastErrorXml(HCkCspW cHandle, HCkString retval);

const wchar_t *CkCspW_lastErrorXml(HCkCspW cHandle);

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.

BOOL CkCspW_getLastMethodSuccess(HCkCspW cHandle);

void CkCspW_putLastMethodSuccess(HCkCspW cHandle, BOOL newVal);

Introduced in version 9.5.0.52

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.

BOOL CkCspW_getMachineKeyset(HCkCspW cHandle);

void CkCspW_putMachineKeyset(HCkCspW cHandle, BOOL newVal);

To be documented soon.

int CkCspW_getNumEncryptAlgorithms(HCkCspW cHandle);

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

int CkCspW_getNumHashAlgorithms(HCkCspW cHandle);

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

int CkCspW_getNumKeyContainers(HCkCspW cHandle);

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

int CkCspW_getNumKeyExchangeAlgorithms(HCkCspW cHandle);

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

int CkCspW_getNumSignatureAlgorithms(HCkCspW cHandle);

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

void CkCspW_getProviderName(HCkCspW cHandle, HCkString retval);

void CkCspW_putProviderName(HCkCspW cHandle, const wchar_t *newVal);

const wchar_t *CkCspW_providerName(HCkCspW cHandle);

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

int CkCspW_getProviderType(HCkCspW cHandle);

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

BOOL CkCspW_getVerboseLogging(HCkCspW cHandle);

void CkCspW_putVerboseLogging(HCkCspW cHandle, BOOL newVal);

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.

void CkCspW_getVersion(HCkCspW cHandle, HCkString retval);

const wchar_t *CkCspW_version(HCkCspW cHandle);

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

Methods

HCkStringArrayW CkCspW_GetKeyContainerNames(HCkCspW cHandle);

To be documented soon...

BOOL CkCspW_HasEncryptAlgorithm(HCkCspW cHandle, const wchar_t *name, int numBits);

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

BOOL CkCspW_HasHashAlgorithm(HCkCspW cHandle, const wchar_t *name, int numBits);

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

BOOL CkCspW_Initialize(HCkCspW cHandle);

Intializes the Csp with the selected ProviderName.

BOOL CkCspW_NthEncryptionAlgorithm(HCkCspW cHandle, int index, HCkString outName);

const wchar_t *CkCspW_nthEncryptionAlgorithm(HCkCspW cHandle, int index);

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

Returns TRUE for success, FALSE for failure.

int CkCspW_NthEncryptionNumBits(HCkCspW cHandle, int index);

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

BOOL CkCspW_NthHashAlgorithmName(HCkCspW cHandle, int index, HCkString outName);

const wchar_t *CkCspW_nthHashAlgorithmName(HCkCspW cHandle, int index);

To be documented soon...

Returns TRUE for success, FALSE for failure.

int CkCspW_NthHashNumBits(HCkCspW cHandle, int index);

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

BOOL CkCspW_NthKeyContainerName(HCkCspW cHandle, int index, HCkString outName);

const wchar_t *CkCspW_nthKeyContainerName(HCkCspW cHandle, int index);

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

Returns TRUE for success, FALSE for failure.

BOOL CkCspW_NthKeyExchangeAlgorithm(HCkCspW cHandle, int index, HCkString outName);

const wchar_t *CkCspW_nthKeyExchangeAlgorithm(HCkCspW cHandle, int index);

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

Returns TRUE for success, FALSE for failure.

int CkCspW_NthKeyExchangeNumBits(HCkCspW cHandle, int index);

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

BOOL CkCspW_NthSignatureAlgorithm(HCkCspW cHandle, int index, HCkString outName);

const wchar_t *CkCspW_nthSignatureAlgorithm(HCkCspW cHandle, int index);

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

Returns TRUE for success, FALSE for failure.

int CkCspW_NthSignatureNumBits(HCkCspW cHandle, int index);

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

BOOL CkCspW_SaveLastError(HCkCspW cHandle, const wchar_t *path);

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

Returns TRUE for success, FALSE for failure.

int CkCspW_SetEncryptAlgorithm(HCkCspW cHandle, const wchar_t *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.)

int CkCspW_SetHashAlgorithm(HCkCspW cHandle, const wchar_t *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.

BOOL CkCspW_SetProviderMicrosoftBase(HCkCspW cHandle);

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

BOOL CkCspW_SetProviderMicrosoftEnhanced(HCkCspW cHandle);

Sets the CSP to the Enhanced Microsoft Cryptographic Provider.

BOOL CkCspW_SetProviderMicrosoftRsaAes(HCkCspW cHandle);

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

BOOL CkCspW_SetProviderMicrosoftStrong(HCkCspW cHandle);

Sets the CSP to the Strong Microsoft Cryptographic Provider.