SecureString Delphi DLL Reference Documentation

SecureString

Current Version: 11.0.0

A string class that stores the characters in memory in 256-bit AES CBC encrypted form. The encryption key will be a randomly-generated key.

Create/Dispose

var
myObject: HCkSecureString;

begin
myObject := CkSecureString_Create();

// ...

CkSecureString_Dispose(myObject);
end;

function CkSecureString_Create: HCkSecureString; stdcall;

Creates an instance of the HCkSecureString object and returns a handle (i.e. a Pointer). The handle is passed in the 1st argument for the functions listed on this page.

procedure CkSecureString_Dispose(handle: HCkSecureString); stdcall;

Objects created by calling CkSecureString_Create must be freed by calling this method. A memory leak occurs if a handle is not disposed by calling this function.

Properties

DebugLogFilePath

procedure CkSecureString_getDebugLogFilePath(objHandle: HCkSecureString; outPropVal: HCkString); stdcall;
procedure CkSecureString_putDebugLogFilePath(objHandle: HCkSecureString; newPropVal: PWideChar); stdcall;
function CkSecureString__debugLogFilePath(objHandle: HCkSecureString): PWideChar; stdcall;

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

A timeout property set to 0, indicating an infinite timeout.
A hang occurring within an event callback in the application code.
An internal bug in the Chilkat code causing the hang.

See the notes about PWideChar memory ownership and validity.

More Information and Examples

Example showing how to use DebugLogFilePath.

LastErrorHtml

procedure CkSecureString_getLastErrorHtml(objHandle: HCkSecureString; outPropVal: HCkString); stdcall;
function CkSecureString__lastErrorHtml(objHandle: HCkSecureString): PWideChar; stdcall;

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

See the notes about PWideChar memory ownership and validity.

LastErrorText

procedure CkSecureString_getLastErrorText(objHandle: HCkSecureString; outPropVal: HCkString); stdcall;
function CkSecureString__lastErrorText(objHandle: HCkSecureString): PWideChar; stdcall;

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

See the notes about PWideChar memory ownership and validity.

More Information and Examples

Concept of LastErrorText LastErrorText Standard Information

LastErrorXml

procedure CkSecureString_getLastErrorXml(objHandle: HCkSecureString; outPropVal: HCkString); stdcall;
function CkSecureString__lastErrorXml(objHandle: HCkSecureString): PWideChar; stdcall;

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

See the notes about PWideChar memory ownership and validity.

LastMethodSuccess

function CkSecureString_getLastMethodSuccess(objHandle: HCkSecureString): wordbool; stdcall;
procedure CkSecureString_putLastMethodSuccess(objHandle: HCkSecureString; newPropVal: wordbool); stdcall;

Indicates the success or failure of the most recent method call: True means success, False means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages.

MaintainHash

procedure CkSecureString_getMaintainHash(objHandle: HCkSecureString; outPropVal: HCkString); stdcall;
procedure CkSecureString_putMaintainHash(objHandle: HCkSecureString; newPropVal: PWideChar); stdcall;
function CkSecureString__maintainHash(objHandle: HCkSecureString): PWideChar; stdcall;

Introduced in version 9.5.0.71

If set to the name of a hash algorithm, then a hash of the current string value is maintained. This allows for the hash to be verified via the VerifyHash method. Possible hash algorithm names are "sha1", "sha256", "sha384", "sha512", "md5", "md2", "ripemd160", "ripemd128","ripemd256", and "ripemd320".

See the notes about PWideChar memory ownership and validity.

ReadOnly

function CkSecureString_getReadOnly(objHandle: HCkSecureString): wordbool; stdcall;
procedure CkSecureString_putReadOnly(objHandle: HCkSecureString; newPropVal: wordbool); stdcall;

Introduced in version 9.5.0.71

Can be set to True to make this secure string read-only (cannot be modified).

VerboseLogging

function CkSecureString_getVerboseLogging(objHandle: HCkSecureString): wordbool; stdcall;
procedure CkSecureString_putVerboseLogging(objHandle: HCkSecureString; newPropVal: wordbool); stdcall;

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.

Version

procedure CkSecureString_getVersion(objHandle: HCkSecureString; outPropVal: HCkString); stdcall;
function CkSecureString__version(objHandle: HCkSecureString): PWideChar; stdcall;

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

See the notes about PWideChar memory ownership and validity.

More Information and Examples

How to get the Chilkat version at runtime.

Methods

Access

function CkSecureString_Access(objHandle: HCkSecureString;
outStr: HCkString): wordbool; stdcall;
function CkSecureString__access(objHandle: HCkSecureString): PWideChar; stdcall;

Introduced in version 9.5.0.71

Returns the clear-text string value.

Returns True for success, False for failure.

See the notes about PWideChar memory ownership and validity.

Append

function CkSecureString_Append(objHandle: HCkSecureString;
str: PWideChar): wordbool; stdcall;

Introduced in version 9.5.0.71

Appends a clear-text string to this secure string. The in-memory data will be decrypted, the string will be appended, and then it will be re-encrypted. Can return False if the string has been marked as read-only via the ReadOnly property.

Returns True for success, False for failure.

AppendSb

function CkSecureString_AppendSb(objHandle: HCkSecureString;
sb: HCkStringBuilder): wordbool; stdcall;

Introduced in version 9.5.0.71

Appends a clear-text string contained in a StringBuilder to this secure string. The in-memory data will be decrypted, the string will be appended, and then it will be re-encrypted. Can return False if the string has been marked as read-only via the ReadOnly property.

Returns True for success, False for failure.

AppendSecure

function CkSecureString_AppendSecure(objHandle: HCkSecureString;
secStr: HCkSecureString): wordbool; stdcall;

Introduced in version 9.5.0.71

Appends the contents of a secure string to this secure string. The in-memory data will be decrypted, the secure string will be appended, and then it will be re-encrypted. Can return False if this string has been marked as read-only via the ReadOnly property.

HashVal

function CkSecureString_HashVal(objHandle: HCkSecureString;
    encoding: PWideChar;
    outStr: HCkString): wordbool; stdcall;
function CkSecureString__hashVal(objHandle: HCkSecureString;
    encoding: PWideChar): PWideChar; stdcall;

Introduced in version 9.5.0.71

Returns the hash value for the current value of this secure string. The encoding specifies the encoding to be used. It can be any of the binary encoding algorithms, such as "base64", "hex", and many more listed at Chilkat Binary Encodings

Returns True for success, False for failure.

See the notes about PWideChar memory ownership and validity.

LoadFile

function CkSecureString_LoadFile(objHandle: HCkSecureString;
path: PWideChar;
charset: PWideChar): wordbool; stdcall;

Introduced in version 9.5.0.71

Loads the contents of a file into this secure string. The current contents of this object are replaced with the new text from the file.

Returns True for success, False for failure.

SecStrEquals

function CkSecureString_SecStrEquals(objHandle: HCkSecureString;
secStr: HCkSecureString): wordbool; stdcall;

Introduced in version 9.5.0.71

Returns True if the secStr equals the contents of this secure string.

Returns True for success, False for failure.

VerifyHash

function CkSecureString_VerifyHash(objHandle: HCkSecureString;
hashVal: PWideChar;
encoding: PWideChar): wordbool; stdcall;

Introduced in version 9.5.0.71

Verifies the hashVal against the hash value stored for the current value of this secure string. The MaintainHash property must've previously been set for this secure string to maintain an internal hash. The encoding specifies the encoding of the hashVal. It can be any of the binary encoding algorithms, such as "base64", "hex", and many more listed at Chilkat Binary Encodings

Returns True for success, False for failure.