CkKeyContainer Ruby Reference Documentation

CkKeyContainer

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

obj = Chilkat::CkKeyContainer.new()

Properties

ContainerName
# strVal is a string
# ckStr is a CkString
keyContainer.get_ContainerName(ckStr);
strVal = keyContainer.containerName();

The name of the currently open key container.

top
DebugLogFilePath
# strVal is a string
# ckStr is a CkString
keyContainer.get_DebugLogFilePath(ckStr);
strVal = keyContainer.debugLogFilePath();
keyContainer.put_DebugLogFilePath(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
# boolVal is a boolean
boolVal = keyContainer.get_IsMachineKeyset();

true if the currently open key container is from the machine keyset, otherwise false.

top
IsOpen
# boolVal is a boolean
boolVal = keyContainer.get_IsOpen();

true if the object currently has a key container open, otherwise false.

top
LastErrorHtml
# strVal is a string
# ckStr is a CkString
keyContainer.get_LastErrorHtml(ckStr);
strVal = keyContainer.lastErrorHtml();

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
# strVal is a string
# ckStr is a CkString
keyContainer.get_LastErrorText(ckStr);
strVal = keyContainer.lastErrorText();

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
# strVal is a string
# ckStr is a CkString
keyContainer.get_LastErrorXml(ckStr);
strVal = keyContainer.lastErrorXml();

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
# boolVal is a boolean
boolVal = keyContainer.get_LastMethodSuccess();
keyContainer.put_LastMethodSuccess(boolVal);
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
# boolVal is a boolean
boolVal = keyContainer.get_Utf8();
keyContainer.put_Utf8(boolVal);

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
# boolVal is a boolean
boolVal = keyContainer.get_VerboseLogging();
keyContainer.put_VerboseLogging(boolVal);

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
# strVal is a string
# ckStr is a CkString
keyContainer.get_Version(ckStr);
strVal = keyContainer.version();

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

top

Methods

CloseContainer
keyContainer.CloseContainer();

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

top
CreateContainer
# name is a string
# machineKeyset is a boolean
status = keyContainer.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 true for success, false for failure.

top
DeleteContainer
status = keyContainer.DeleteContainer();

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

Returns true for success, false for failure.

top
FetchContainerNames
# bMachineKeyset is a boolean
status = keyContainer.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 true for success, false for failure.

top
GenerateKeyPair
# bKeyExchangePair is a boolean
# keyLengthInBits is an integer
status = keyContainer.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 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
# outGuid is a CkString (output)
status = keyContainer.GenerateUuid(outStr);
retStr = keyContainer.generateUuid();

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
# bMachineKeyset is a boolean
# index is an integer
# outName is a CkString (output)
status = keyContainer.GetNthContainerName(bMachineKeyset, index, outStr);
retStr = keyContainer.getNthContainerName(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 true for success, false for failure.

top
GetNumContainers
# bMachineKeyset is a boolean
retInt = keyContainer.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
ret_privateKey = keyContainer.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 true returns the key-exchange pair, passing false returns the signature pair. A null reference is returned on failure.

Returns nil on failure

top
GetPublicKey
# returns a CkPublicKey
# bKeyExchangePair is a boolean
ret_publicKey = keyContainer.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 true returns the key-exchange pair, passing false returns the signature pair. A null reference is returned on failure.

Returns nil on failure

top
ImportPrivateKey
# key is a CkPrivateKey
# bKeyExchangePair is a boolean
status = keyContainer.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 (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
# key is a CkPublicKey
# bKeyExchangePair is a boolean
status = keyContainer.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 (true) or signature public key (false) is replaced.

Returns true for success, false for failure.

top
OpenContainer
# name is a string
# needPrivateKeyAccess is a boolean
# machineKeyset is a boolean
status = keyContainer.OpenContainer(name, needPrivateKeyAccess, machineKeyset);

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

Returns true for success, false for failure.

top
SaveLastError
# path is a string
status = keyContainer.SaveLastError(path);

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

Returns true for success, false for failure.

top