SecureString Delphi DLL Reference Documentation

SecureString

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

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

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

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.

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".

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).

Methods

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.

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.

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.

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.

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.

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.

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.

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.