KeyContainer C Reference Documentation

KeyContainer

Current Version: 9.5.0.75

Represents a key container on a Windows operating system. Each Windows system has a "machine keyset" where named key containers are potentially accessible to all processes. The "machine keyset" is a machine-wide container for key containers. Each user account also has it's own set of key containers. Therefore, when you open or create a key container by name, you must also indicate whether it's the "machine keyset" or the user account's keyset.

The KeyContainer object provides methods opening, creating, and deleting key containers by name. It also provides the ability to import public/private keys into a key container, or to export public/private keys from a key container. It can generate new key pairs. It can also enumerate the names of existing key containers.

This class is specific to the Windows operating system, and therefore is only available on Windows systems.

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

ContainerName
void CkKeyContainer_getContainerName(HCkKeyContainer cHandle, HCkString retval);
const char *CkKeyContainer_containerName(HCkKeyContainer cHandle);

The name of the currently open key container.

top
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
IsMachineKeyset
BOOL CkKeyContainer_getIsMachineKeyset(HCkKeyContainer cHandle);

TRUE if the currently open key container is from the machine keyset, otherwise FALSE.

top
IsOpen
BOOL CkKeyContainer_getIsOpen(HCkKeyContainer cHandle);

TRUE if the object currently has a key container open, otherwise FALSE.

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

CloseContainer
void CkKeyContainer_CloseContainer(HCkKeyContainer cHandle);

Closes the currently opened key container (if this object has one opened).

top
CreateContainer
BOOL CkKeyContainer_CreateContainer(HCkKeyContainer cHandle, const char *name, BOOL machineKeyset);

Creates a new key container with a given name in the machine or user keyset. If a key container having the same name already exists, it is opened.

Returns TRUE for success, FALSE for failure.

top
DeleteContainer
BOOL CkKeyContainer_DeleteContainer(HCkKeyContainer cHandle);

Deletes a key container with a given name in the machine or user keyset.

Returns TRUE for success, FALSE for failure.

top
FetchContainerNames
BOOL CkKeyContainer_FetchContainerNames(HCkKeyContainer cHandle, BOOL bMachineKeyset);

Fetches the container names for the machine or user keyset. After this method has been called successfully, the GetNumContainers method can be called to get the number of key containers in the given keyset, and the GetContainerName method can be called to retrieve each key container's name by index.

Returns TRUE for success, FALSE for failure.

top
GenerateKeyPair
BOOL CkKeyContainer_GenerateKeyPair(HCkKeyContainer cHandle, BOOL bKeyExchangePair, int keyLengthInBits);

Generates a new key pair in the currently open key container. Each key container can contain two public/private key pairs: one for key exchange, and one for signature creation. The 1st argument determines which key pair is generated. A value of TRUE causes a new key-exchange key pair to be generated, a value of FALSE causes a new signature key pair to be generated. The size of the key (in bits) can range from 384 to 16384, with a typical value being 1024 or 2048 bits.

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
GetNthContainerName
BOOL CkKeyContainer_GetNthContainerName(HCkKeyContainer cHandle, BOOL bMachineKeyset, int index, HCkString outName);
const char *CkKeyContainer_getNthContainerName(HCkKeyContainer cHandle, BOOL bMachineKeyset, int index);

Returns the Nth key container name. The FetchContainerNames method must have been previously called with the same keyset (machine or user). The index ranges from 0 to GetNumContainers() - 1.

Returns TRUE for success, FALSE for failure.

top
GetNumContainers
int CkKeyContainer_GetNumContainers(HCkKeyContainer cHandle, BOOL bMachineKeyset);

Returns the number of key containers in existence for the given keyset (machine or user). The FetchContainerNames method must have been previously called with the same keyset (machine or user).

top
GetPrivateKey
HCkPrivateKey CkKeyContainer_GetPrivateKey(HCkKeyContainer cHandle, BOOL bKeyExchangePair);

A key container can hold two public/private key pairs -- a key-exchange pair and a signature pair. This method returns the private key for one of the key pairs. Passing a TRUE returns the key-exchange pair, passing FALSE returns the signature pair. A null reference is returned on failure.

Returns NULL on failure

top
GetPublicKey
HCkPublicKey CkKeyContainer_GetPublicKey(HCkKeyContainer cHandle, BOOL bKeyExchangePair);

A key container can hold two public/private key pairs -- a key-exchange pair and a signature pair. This method returns the public key for one of the key pairs. Passing a TRUE returns the key-exchange pair, passing FALSE returns the signature pair. A null reference is returned on failure.

Returns NULL on failure

top
ImportPrivateKey
BOOL CkKeyContainer_ImportPrivateKey(HCkKeyContainer cHandle, HCkPrivateKey key, BOOL bKeyExchangePair);

Imports a private key into the key container. The 1st argument is the private key to be imported, and the 2nd argument determines if the key-exchange private key (TRUE) or signature private key (FALSE) is replaced. Note: A private key actually contains the key material for both the public and private key. When you have a private key, you effectively have both the public and private key of a key pair.

Returns TRUE for success, FALSE for failure.

top
ImportPublicKey
BOOL CkKeyContainer_ImportPublicKey(HCkKeyContainer cHandle, HCkPublicKey key, BOOL bKeyExchangePair);

Imports a public key into the key container. The 1st argument is the public key to be imported, and the 2nd argument determines if the key-exchange public key (TRUE) or signature public key (FALSE) is replaced.

Returns TRUE for success, FALSE for failure.

top
OpenContainer
BOOL CkKeyContainer_OpenContainer(HCkKeyContainer cHandle, const char *name, BOOL needPrivateKeyAccess, BOOL machineKeyset);

Opens an existing key container in either the machine or user keyset.

Returns TRUE for success, FALSE for failure.

top
SaveLastError
BOOL CkKeyContainer_SaveLastError(HCkKeyContainer cHandle, const char *path);

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

Returns TRUE for success, FALSE for failure.

top