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

(Visual Basic 6.0)
Dim obj As New KeyContainer

(ASP)
set obj = Server.CreateObject("Chilkat_9_5_0.KeyContainer")

(VBScript)
set obj = CreateObject("Chilkat_9_5_0.KeyContainer")

(Delphi)
obj := TKeyContainer.Create(Self);

(FoxPro)
loObject = CreateObject('Chilkat_9_5_0.KeyContainer')

(PowerBuilder)
lole_object = create oleobject
li_rc = lole_object.ConnectToNewObject("Chilkat_9_5_0.KeyContainer")

(SQL Server)
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.KeyContainer', @obj OUT

(Javascript)
var obj = new ActiveXObject("Chilkat_9_5_0.KeyContainer");

Properties

ContainerName
ContainerName As String (read-only)

The name of the currently open key container.

top
DebugLogFilePath
DebugLogFilePath As String

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
IsMachineKeyset As Long (read-only)

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

top
IsOpen
IsOpen As Long (read-only)

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

top
LastBinaryResult
LastBinaryResult As Variant (read-only)
Introduced in version 9.5.0.52

The binary data returned by the last (binary data returning) method called. Only available if Chilkat.Global.KeepBinaryResult is set to 1. This provides a means for obtaining large varbinary results in the SQL Server environment (where limitations exist in getting large amounts of data returned by method calls, but where temp tables can be used for binary properties).

top
LastErrorHtml
LastErrorHtml As String (read-only)

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
LastErrorText As String (read-only)

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
LastErrorXml As String (read-only)

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
LastMethodSuccess As Long
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
LastStringResult
LastStringResult As String (read-only)
Introduced in version 9.5.0.52

The string return value of the last (string returning) method called. Only available if Chilkat.Global.KeepStringResult is set to 1. This provides a means for obtaining large string results in the SQL Server environment (where limitations exist in getting long strings returned by method calls, but where temp tables can be used for string properties).

top
LastStringResultLen
LastStringResultLen As Long (read-only)
Introduced in version 9.5.0.53

The length, in characters, of the string contained in the LastStringResult property.

top
VerboseLogging
VerboseLogging As Long

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
Version As String (read-only)

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

top

Methods

CloseContainer
CloseContainer()

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

top
CreateContainer
CreateContainer(name As String, ByVal machineKeyset As Long) As Long

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
DeleteContainer() As Long

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

Returns 1 for success, 0 for failure.

top
FetchContainerNames
FetchContainerNames(ByVal bMachineKeyset As Long) As Long

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
GenerateKeyPair(ByVal bKeyExchangePair As Long, ByVal keyLengthInBits As Long) As Long

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
GenerateUuid() As String

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 Nothing on failure

top
GetNthContainerName
GetNthContainerName(ByVal bMachineKeyset As Long, ByVal index As Long) As String

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 Nothing on failure

top
GetNumContainers
GetNumContainers(ByVal bMachineKeyset As Long) As Long

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
GetPrivateKey(ByVal bKeyExchangePair As Long) As PrivateKey

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 Nothing on failure

top
GetPublicKey
GetPublicKey(ByVal bKeyExchangePair As Long) As PublicKey

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 Nothing on failure

top
ImportPrivateKey
ImportPrivateKey(key As PrivateKey, ByVal bKeyExchangePair As Long) As Long

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
ImportPublicKey(key As PublicKey, ByVal bKeyExchangePair As Long) As Long

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
OpenContainer(name As String, ByVal needPrivateKeyAccess As Long, ByVal machineKeyset As Long) As Long

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

Returns 1 for success, 0 for failure.

top