SecureString PureBasic Reference Documentation

SecureString

Current Version: 9.5.0.98

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.

Object Creation

obj.i = CkSecureString::ckCreate()

; Make sure to dispose of the object when finished like this:
CkSecureString::ckDispose(obj);

Properties

LastMethodSuccess

Declare.i ckLastMethodSuccess(obj.i)
Declare setCkLastMethodSuccess(obj.i, value.i)

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.

MaintainHash

Declare.s ckMaintainHash(obj.i)
Declare setCkMaintainHash(obj.i, value.s)

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

ReadOnly

Declare.i ckReadOnly(obj.i)
Declare setCkReadOnly(obj.i, value.i)

Introduced in version 9.5.0.71

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

Methods

Access

Declare.s ckAccess(obj.i)

Introduced in version 9.5.0.71

Returns the clear-text string value.

Returns an empty string on failure. Use the LastMethodSuccess property to check for success.

Append

Declare.i ckAppend(obj.i, str.s)

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 0 if the string has been marked as read-only via the ReadOnly property.

Returns 1 for success, 0 for failure.

AppendSb

Declare.i ckAppendSb(obj.i, sb.i)

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 0 if the string has been marked as read-only via the ReadOnly property.

Returns 1 for success, 0 for failure.

AppendSecure

Declare.i ckAppendSecure(obj.i, secStr.i)

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 0 if this string has been marked as read-only via the ReadOnly property.

HashVal

Declare.s ckHashVal(obj.i, encoding.s)

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 an empty string on failure. Use the LastMethodSuccess property to check for success.

LoadFile

Declare.i ckLoadFile(obj.i, path.s, charset.s)

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 1 for success, 0 for failure.

SecStrEquals

Declare.i ckSecStrEquals(obj.i, secStr.i)

Introduced in version 9.5.0.71

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

Returns 1 for success, 0 for failure.

VerifyHash

Declare.i ckVerifyHash(obj.i, hashVal.s, encoding.s)

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 1 for success, 0 for failure.