KeyContainer Tcl Reference Documentation

KeyContainer

Current Version: 9.5.0.73

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.

Object Creation

set myKeyContainer [new CkKeyContainer]

Properties

ContainerName
string
# ckStr is a CkString
CkKeyContainer_get_ContainerName $myKeyContainer $ckStr
set strVal [CkKeyContainer_get_containerName $myKeyContainer]

The name of the currently open key container.

top
DebugLogFilePath
string
# ckStr is a CkString
CkKeyContainer_get_DebugLogFilePath $myKeyContainer $ckStr
set strVal [CkKeyContainer_get_debugLogFilePath $myKeyContainer]
CkKeyContainer_put_DebugLogFilePath $myKeyContainer $strVal

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
boolean 1/0
set boolVal [CkKeyContainer_get_IsMachineKeyset $myKeyContainer]

1 if the currently open key container is from the machine keyset, otherwise 0.

top
IsOpen
boolean 1/0
set boolVal [CkKeyContainer_get_IsOpen $myKeyContainer]

1 if the object currently has a key container open, otherwise 0.

top
LastErrorHtml
string
# ckStr is a CkString
CkKeyContainer_get_LastErrorHtml $myKeyContainer $ckStr
set strVal [CkKeyContainer_get_lastErrorHtml $myKeyContainer]

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
string
# ckStr is a CkString
CkKeyContainer_get_LastErrorText $myKeyContainer $ckStr
set strVal [CkKeyContainer_get_lastErrorText $myKeyContainer]

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
string
# ckStr is a CkString
CkKeyContainer_get_LastErrorXml $myKeyContainer $ckStr
set strVal [CkKeyContainer_get_lastErrorXml $myKeyContainer]

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
boolean 1/0
set boolVal [CkKeyContainer_get_LastMethodSuccess $myKeyContainer]
CkKeyContainer_put_LastMethodSuccess $myKeyContainer $boolVal
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 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 = 1 and failure = 0.
  • 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 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
Utf8
boolean 1/0
set boolVal [CkKeyContainer_get_Utf8 $myKeyContainer]
CkKeyContainer_put_Utf8 $myKeyContainer $boolVal

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

top
VerboseLogging
boolean 1/0
set boolVal [CkKeyContainer_get_VerboseLogging $myKeyContainer]
CkKeyContainer_put_VerboseLogging $myKeyContainer $boolVal

If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
string
# ckStr is a CkString
CkKeyContainer_get_Version $myKeyContainer $ckStr
set strVal [CkKeyContainer_get_version $myKeyContainer]

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

top

Methods

CloseContainer
CkKeyContainer_CloseContainer

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

top
CreateContainer
# name is a string
# machineKeyset is a boolean
set status [CkKeyContainer_CreateContainer $name $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 1 for success, 0 for failure.

top
DeleteContainer
set status [CkKeyContainer_DeleteContainer]

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

Returns 1 for success, 0 for failure.

top
FetchContainerNames
# bMachineKeyset is a boolean
set status [CkKeyContainer_FetchContainerNames $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 1 for success, 0 for failure.

top
GenerateKeyPair
# bKeyExchangePair is a boolean
# keyLengthInBits is an integer
set status [CkKeyContainer_GenerateKeyPair $bKeyExchangePair $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 1 causes a new key-exchange key pair to be generated, a value of 0 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 1 for success, 0 for failure.

top
GenerateUuid
# outGuid is a CkString (output)
set status [CkKeyContainer_GenerateUuid $outStr]
set retStr [CkKeyContainer_generateUuid $myKeyContainer]

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 1 for success, 0 for failure.

top
GetNthContainerName
# bMachineKeyset is a boolean
# index is an integer
# outName is a CkString (output)
set status [CkKeyContainer_GetNthContainerName $bMachineKeyset $index $outStr]
set retStr [CkKeyContainer_getNthContainerName $myKeyContainer $bMachineKeyset $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 1 for success, 0 for failure.

top
GetNumContainers
# bMachineKeyset is a boolean
set retInt [CkKeyContainer_GetNumContainers $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
# returns a CkPrivateKey
# bKeyExchangePair is a boolean
set ret_privateKey [CkKeyContainer_GetPrivateKey $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 1 returns the key-exchange pair, passing 0 returns the signature pair. A null reference is returned on failure.

Returns NULL on failure

top
GetPublicKey
# returns a CkPublicKey
# bKeyExchangePair is a boolean
set ret_publicKey [CkKeyContainer_GetPublicKey $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 1 returns the key-exchange pair, passing 0 returns the signature pair. A null reference is returned on failure.

Returns NULL on failure

top
ImportPrivateKey
# key is a CkPrivateKey
# bKeyExchangePair is a boolean
set status [CkKeyContainer_ImportPrivateKey $key $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 (1) or signature private key (0) 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 1 for success, 0 for failure.

top
ImportPublicKey
# key is a CkPublicKey
# bKeyExchangePair is a boolean
set status [CkKeyContainer_ImportPublicKey $key $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 (1) or signature public key (0) is replaced.

Returns 1 for success, 0 for failure.

top
OpenContainer
# name is a string
# needPrivateKeyAccess is a boolean
# machineKeyset is a boolean
set status [CkKeyContainer_OpenContainer $name $needPrivateKeyAccess $machineKeyset]

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

Returns 1 for success, 0 for failure.

top
SaveLastError
# path is a string
set status [CkKeyContainer_SaveLastError $path]

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

Returns 1 for success, 0 for failure.

top