CkKeyContainerW Unicode C++ Reference Documentation

CkKeyContainerW

Current Version: 10.1.0

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

Object Creation

// Local variable on the stack
CkKeyContainerW obj;

// Dynamically allocate/delete
CkKeyContainerW *pObj = new CkKeyContainerW();
// ...
delete pObj;

Properties

DebugLogFilePath

void get_DebugLogFilePath(CkString &str);
const wchar_t *debugLogFilePath(void);
void put_DebugLogFilePath(const wchar_t *str);

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.

LastErrorHtml

void get_LastErrorHtml(CkString &str);
const wchar_t *lastErrorHtml(void);

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 get_LastErrorText(CkString &str);
const wchar_t *lastErrorText(void);

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 get_LastErrorXml(CkString &str);
const wchar_t *lastErrorXml(void);

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 get_LastMethodSuccess(void);
void put_LastMethodSuccess(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.

LegacyKeySpec

int get_LegacyKeySpec(void);
void put_LegacyKeySpec(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.

MachineKeys

bool get_MachineKeys(void);
void put_MachineKeys(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.

VerboseLogging

bool get_VerboseLogging(void);
void put_VerboseLogging(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 get_Version(CkString &str);
const wchar_t *version(void);

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

More Information and Examples

How to get the Chilkat version at runtime.

Methods

DeleteKey

bool DeleteKey(const wchar_t *keyName, const wchar_t *storageProvider);

Introduced in version 9.5.0.83

Deletes a key from the storageProvider.

Returns true for success, false for failure.

ExportKey

bool ExportKey(const wchar_t *keyName, const wchar_t *storageProvider, bool silentFlag, CkPrivateKeyW &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.

More Information and Examples

Export a Private Key from an MS Storage Provider

GenerateUuid

bool GenerateUuid(CkString &outGuid);
const wchar_t *generateUuid(void);

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.

GetKeys

bool GetKeys(const wchar_t *storageProvider, CkJsonObjectW &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

List Keys in a Microsoft Storage Provider

GetStorageProviders

bool GetStorageProviders(CkJsonObjectW &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

List Microsoft Storage Providers

ImportKey

bool ImportKey(const wchar_t *keyName, const wchar_t *storageProvider, bool allowOverwrite, bool allowExport, CkPrivateKeyW &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.