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

Create/Dispose

HCkCsp instance = CkCsp_Create();
// ...
CkCsp_Dispose(instance);

HCkCsp CkCsp_Create(void);

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

void CkCsp_Dispose(HCkCsp handle);

Objects created by calling CkCsp_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 CkCsp_Dispose.

Properties

DebugLogFilePath

void CkCsp_getDebugLogFilePath(HCkCsp cHandle, HCkString retval);
void CkCsp_putDebugLogFilePath(HCkCsp cHandle, const char *newVal);
const char *CkCsp_debugLogFilePath(HCkCsp 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:

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

void CkCsp_getEncryptAlgorithm(HCkCsp cHandle, HCkString retval);
const char *CkCsp_encryptAlgorithm(HCkCsp cHandle);

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

EncryptAlgorithmID

int CkCsp_getEncryptAlgorithmID(HCkCsp cHandle);

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

EncryptNumBits

int CkCsp_getEncryptNumBits(HCkCsp cHandle);

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

HashAlgorithm

void CkCsp_getHashAlgorithm(HCkCsp cHandle, HCkString retval);
const char *CkCsp_hashAlgorithm(HCkCsp cHandle);

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

HashAlgorithmID

int CkCsp_getHashAlgorithmID(HCkCsp cHandle);

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

HashNumBits

int CkCsp_getHashNumBits(HCkCsp cHandle);

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

LastErrorHtml

void CkCsp_getLastErrorHtml(HCkCsp cHandle, HCkString retval);
const char *CkCsp_lastErrorHtml(HCkCsp 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.

LastErrorText

void CkCsp_getLastErrorText(HCkCsp cHandle, HCkString retval);
const char *CkCsp_lastErrorText(HCkCsp 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.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

void CkCsp_getLastErrorXml(HCkCsp cHandle, HCkString retval);
const char *CkCsp_lastErrorXml(HCkCsp 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.

LastMethodSuccess

BOOL CkCsp_getLastMethodSuccess(HCkCsp cHandle);
void CkCsp_putLastMethodSuccess(HCkCsp cHandle, BOOL newVal);

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.

NumEncryptAlgorithms

int CkCsp_getNumEncryptAlgorithms(HCkCsp cHandle);

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

NumHashAlgorithms

int CkCsp_getNumHashAlgorithms(HCkCsp cHandle);

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

NumKeyContainers

int CkCsp_getNumKeyContainers(HCkCsp cHandle);

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

NumKeyExchangeAlgorithms

int CkCsp_getNumKeyExchangeAlgorithms(HCkCsp cHandle);

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

NumSignatureAlgorithms

int CkCsp_getNumSignatureAlgorithms(HCkCsp cHandle);

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

ProviderName

void CkCsp_getProviderName(HCkCsp cHandle, HCkString retval);
void CkCsp_putProviderName(HCkCsp cHandle, const char *newVal);
const char *CkCsp_providerName(HCkCsp 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".

ProviderType

int CkCsp_getProviderType(HCkCsp cHandle);

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

UncommonOptions

void CkCsp_getUncommonOptions(HCkCsp cHandle, HCkString retval);
void CkCsp_putUncommonOptions(HCkCsp cHandle, const char *newVal);
const char *CkCsp_uncommonOptions(HCkCsp cHandle);

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.

Utf8

BOOL CkCsp_getUtf8(HCkCsp cHandle);
void CkCsp_putUtf8(HCkCsp cHandle, BOOL newVal);

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

VerboseLogging

BOOL CkCsp_getVerboseLogging(HCkCsp cHandle);
void CkCsp_putVerboseLogging(HCkCsp 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.

Version

void CkCsp_getVersion(HCkCsp cHandle, HCkString retval);
const char *CkCsp_version(HCkCsp cHandle);

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 CkCsp_HasEncryptAlgorithm(HCkCsp cHandle, const char *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 CkCsp_HasHashAlgorithm(HCkCsp cHandle, const char *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 CkCsp_Initialize(HCkCsp cHandle);

Intializes the Csp with the selected ProviderName.

NthEncryptionAlgorithm

BOOL CkCsp_NthEncryptionAlgorithm(HCkCsp cHandle, int index, HCkString outName);
const char *CkCsp_nthEncryptionAlgorithm(HCkCsp 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.

NthEncryptionNumBits

int CkCsp_NthEncryptionNumBits(HCkCsp cHandle, int index);

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

NthHashAlgorithmName

BOOL CkCsp_NthHashAlgorithmName(HCkCsp cHandle, int index, HCkString outName);
const char *CkCsp_nthHashAlgorithmName(HCkCsp cHandle, int index);

To be documented soon...

Returns TRUE for success, FALSE for failure.

NthHashNumBits

int CkCsp_NthHashNumBits(HCkCsp cHandle, int index);

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

NthKeyContainerName

BOOL CkCsp_NthKeyContainerName(HCkCsp cHandle, int index, HCkString outName);
const char *CkCsp_nthKeyContainerName(HCkCsp 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.

More Information and Examples

Find Certificate on Smartcard Currenty in Reader

NthKeyExchangeAlgorithm

BOOL CkCsp_NthKeyExchangeAlgorithm(HCkCsp cHandle, int index, HCkString outName);
const char *CkCsp_nthKeyExchangeAlgorithm(HCkCsp 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.

NthKeyExchangeNumBits

int CkCsp_NthKeyExchangeNumBits(HCkCsp cHandle, int index);

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

NthSignatureAlgorithm

BOOL CkCsp_NthSignatureAlgorithm(HCkCsp cHandle, int index, HCkString outName);
const char *CkCsp_nthSignatureAlgorithm(HCkCsp 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.

NthSignatureNumBits

int CkCsp_NthSignatureNumBits(HCkCsp cHandle, int index);

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

SetEncryptAlgorithm

int CkCsp_SetEncryptAlgorithm(HCkCsp cHandle, const char *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 CkCsp_SetHashAlgorithm(HCkCsp cHandle, const char *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.