KeyContainer Tcl Reference Documentation

KeyContainer

Current Version: 9.5.0.87

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

Object Creation

set myKeyContainer [new CkKeyContainer]

Properties

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
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
LegacyKeySpec
integer
set intVal [CkKeyContainer_get_LegacyKeySpec $myKeyContainer]
CkKeyContainer_put_LegacyKeySpec $myKeyContainer $intVal
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
boolean 1/0
set boolVal [CkKeyContainer_get_MachineKeys $myKeyContainer]
CkKeyContainer_put_MachineKeys $myKeyContainer $boolVal
Introduced in version 9.5.0.83

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

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

DeleteKey
# keyName is a string
# storageProvider is a string
set status [CkKeyContainer_DeleteKey $keyName $storageProvider]
Introduced in version 9.5.0.83

Deletes a key from the storageProvider.

Returns 1 for success, 0 for failure.

top
ExportKey
# keyName is a string
# storageProvider is a string
# silentFlag is a boolean
# key is a CkPrivateKey
set status [CkKeyContainer_ExportKey $keyName $storageProvider $silentFlag $key]
Introduced in version 9.5.0.83

Exports a key into key. If silentFlag is 1, 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 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
GetKeys
# storageProvider is a string
# json is a CkJsonObject
set status [CkKeyContainer_GetKeys $storageProvider $json]
Introduced in version 9.5.0.83

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

Returns 1 for success, 0 for failure.

More Information and Examples
top
GetStorageProviders
# json is a CkJsonObject
set status [CkKeyContainer_GetStorageProviders $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 1 for success, 0 for failure.

More Information and Examples
top
ImportKey
# keyName is a string
# storageProvider is a string
# allowOverwrite is a boolean
# allowExport is a boolean
# key is a CkPrivateKey
set status [CkKeyContainer_ImportKey $keyName $storageProvider $allowOverwrite $allowExport $key]
Introduced in version 9.5.0.83

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

Returns 1 for success, 0 for failure.

top