KeyContainer C Reference Documentation

KeyContainer

Current Version: 9.5.0.83

A class for listing, importing, exporting, and deleting private keys installed on a Windows system.

Create/Dispose

HCkKeyContainer instance = CkKeyContainer_Create();
// ...
CkKeyContainer_Dispose(instance);
HCkKeyContainer CkKeyContainer_Create(void);

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

void CkKeyContainer_Dispose(HCkKeyContainer handle);

Objects created by calling CkKeyContainer_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 CkKeyContainer_Dispose.

Properties

DebugLogFilePath
void CkKeyContainer_getDebugLogFilePath(HCkKeyContainer cHandle, HCkString retval);
void CkKeyContainer_putDebugLogFilePath(HCkKeyContainer cHandle, const char *newVal);
const char *CkKeyContainer_debugLogFilePath(HCkKeyContainer 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.

top
LastErrorHtml
void CkKeyContainer_getLastErrorHtml(HCkKeyContainer cHandle, HCkString retval);
const char *CkKeyContainer_lastErrorHtml(HCkKeyContainer 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.

top
LastErrorText
void CkKeyContainer_getLastErrorText(HCkKeyContainer cHandle, HCkString retval);
const char *CkKeyContainer_lastErrorText(HCkKeyContainer 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.

top
LastErrorXml
void CkKeyContainer_getLastErrorXml(HCkKeyContainer cHandle, HCkString retval);
const char *CkKeyContainer_lastErrorXml(HCkKeyContainer 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.

top
LastMethodSuccess
BOOL CkKeyContainer_getLastMethodSuccess(HCkKeyContainer cHandle);
void CkKeyContainer_putLastMethodSuccess(HCkKeyContainer 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.

top
LegacyKeySpec
int CkKeyContainer_getLegacyKeySpec(HCkKeyContainer cHandle);
void CkKeyContainer_putLegacyKeySpec(HCkKeyContainer cHandle, int newVal);
Introduced in version 9.5.0.83

If the storage provider is one for the legacy CryptoAPI, then this property indicate whether to work with AT_KEYEXCHANGE or AT_SIGNATURE. Possible values for this property are:

  • 1 - AT_KEYEXCHANGE
  • 2 - AT_SIGNATURE

The default value of this property is 1.

top
MachineKeys
BOOL CkKeyContainer_getMachineKeys(HCkKeyContainer cHandle);
void CkKeyContainer_putMachineKeys(HCkKeyContainer cHandle, BOOL newVal);
Introduced in version 9.5.0.83

If TRUE, work with keys for the local computer. If FALSE, work with keys for the current user. The default value is FALSE.

top
Utf8
BOOL CkKeyContainer_getUtf8(HCkKeyContainer cHandle);
void CkKeyContainer_putUtf8(HCkKeyContainer 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.

top
VerboseLogging
BOOL CkKeyContainer_getVerboseLogging(HCkKeyContainer cHandle);
void CkKeyContainer_putVerboseLogging(HCkKeyContainer 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.

top
Version
void CkKeyContainer_getVersion(HCkKeyContainer cHandle, HCkString retval);
const char *CkKeyContainer_version(HCkKeyContainer cHandle);

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

top

Methods

DeleteKey
BOOL CkKeyContainer_DeleteKey(HCkKeyContainer cHandle, const char *keyName, const char *storageProvider);
Introduced in version 9.5.0.83

Deletes a key from the storageProvider.

Returns TRUE for success, FALSE for failure.

top
ExportKey
BOOL CkKeyContainer_ExportKey(HCkKeyContainer cHandle, const char *keyName, const char *storageProvider, BOOL silentFlag, HCkPrivateKey key);
Introduced in version 9.5.0.83

Exports a key into key. If silentFlag is TRUE, requests that the key service provider (KSP) not display any user interface. If the provider must display the UI to operate, the call fails

Returns TRUE for success, FALSE for failure.

top
GenerateUuid
BOOL CkKeyContainer_GenerateUuid(HCkKeyContainer cHandle, HCkString outGuid);
const char *CkKeyContainer_generateUuid(HCkKeyContainer cHandle);

This method is provided as a convenient way of generating unique key container names. There are no set rules for naming key containers. However, if your application is to generate a large number of keys, using a UUID for the key container name is wise to ensure uniqueness.

Returns TRUE for success, FALSE for failure.

top
GetKeys
BOOL CkKeyContainer_GetKeys(HCkKeyContainer cHandle, const char *storageProvider, HCkJsonObject json);
Introduced in version 9.5.0.83

Loads json with a list of keys found in the given storageProvider.

Returns TRUE for success, FALSE for failure.

More Information and Examples
top
GetStorageProviders
BOOL CkKeyContainer_GetStorageProviders(HCkKeyContainer cHandle, HCkJsonObject json);
Introduced in version 9.5.0.83

Loads json with a list of storage providers on the Windows system.

The json will contain JSON such as this:

{
  "cng": [
    "Microsoft Software Key Storage Provider",
    "Microsoft Passport Key Storage Provider",
    "Microsoft Platform Crypto Provider",
    "Microsoft Smart Card Key Storage Provider"
  ],
  "legacy": [
    "Microsoft Base Cryptographic Provider v1.0",
    "Microsoft Base DSS and Diffie-Hellman Cryptographic Provider",
    "Microsoft Base DSS Cryptographic Provider",
    "Microsoft Base Smart Card Crypto Provider",
    "Microsoft DH SChannel Cryptographic Provider",
    "Microsoft Enhanced Cryptographic Provider v1.0",
    "Microsoft Enhanced DSS and Diffie-Hellman Cryptographic Provider",
    "Microsoft Enhanced RSA and AES Cryptographic Provider",
    "Microsoft RSA SChannel Cryptographic Provider",
    "Microsoft Strong Cryptographic Provider"
  ]
}

Returns TRUE for success, FALSE for failure.

More Information and Examples
top
ImportKey
BOOL CkKeyContainer_ImportKey(HCkKeyContainer cHandle, const char *keyName, const char *storageProvider, BOOL allowOverwrite, BOOL allowExport, HCkPrivateKey key);
Introduced in version 9.5.0.83

Imports a new key into the storageProvider. If allowOverwrite is TRUE, if a key already exists in the container with the specified name, the existing key will be overwritten. If allowOverwrite is FALSE and the key already exists, then the method fails. If allowExport is TRUE, then the key is marked as exportable, which allows for it to be re-exported to a PFX.

Returns TRUE for success, FALSE for failure.

top