SecureString Tcl 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.
Object Creation
set mySecureString [new CkSecureString]
Properties
DebugLogFilePath
# ckStr is a CkString
CkSecureString_get_DebugLogFilePath $mySecureString $ckStr
set strVal [CkSecureString_get_debugLogFilePath $mySecureString]
CkSecureString_put_DebugLogFilePath $mySecureString $strVal
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.
LastErrorHtml
# ckStr is a CkString
CkSecureString_get_LastErrorHtml $mySecureString $ckStr
set strVal [CkSecureString_get_lastErrorHtml $mySecureString]
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.
topLastErrorText
# ckStr is a CkString
CkSecureString_get_LastErrorText $mySecureString $ckStr
set strVal [CkSecureString_get_lastErrorText $mySecureString]
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.
LastErrorXml
# ckStr is a CkString
CkSecureString_get_LastErrorXml $mySecureString $ckStr
set strVal [CkSecureString_get_lastErrorXml $mySecureString]
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.
topLastMethodSuccess
set boolVal [CkSecureString_get_LastMethodSuccess $mySecureString]
CkSecureString_put_LastMethodSuccess $mySecureString $boolVal
Indicates the success or failure of the most recent method call: 1 means success, 0 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
# ckStr is a CkString
CkSecureString_get_MaintainHash $mySecureString $ckStr
set strVal [CkSecureString_get_maintainHash $mySecureString]
CkSecureString_put_MaintainHash $mySecureString $strVal
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".
topReadOnly
set boolVal [CkSecureString_get_ReadOnly $mySecureString]
CkSecureString_put_ReadOnly $mySecureString $boolVal
Can be set to 1 to make this secure string read-only (cannot be modified).
VerboseLogging
set boolVal [CkSecureString_get_VerboseLogging $mySecureString]
CkSecureString_put_VerboseLogging $mySecureString $boolVal
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.
Version
# ckStr is a CkString
CkSecureString_get_Version $mySecureString $ckStr
set strVal [CkSecureString_get_version $mySecureString]
Methods
Access
set status [CkSecureString_Access $outStr]
set retStr [CkSecureString_access $mySecureString]
Append
set status [CkSecureString_Append $str]
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.
topAppendSb
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.
topAppendSecure
set retBool [CkSecureString_AppendSecure $secStr]
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
# outStr is a CkString (output)
set status [CkSecureString_HashVal $encoding $outStr]
set retStr [CkSecureString_hashVal $mySecureString $encoding]
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 1 for success, 0 for failure.
topLoadFile
# charset is a string
set status [CkSecureString_LoadFile $path $charset]
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.
topSecStrEquals
set status [CkSecureString_SecStrEquals $secStr]
Returns 1 if the secStr equals the contents of this secure string.
Returns 1 for success, 0 for failure.
topVerifyHash
# encoding is a string
set status [CkSecureString_VerifyHash $hashVal $encoding]
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.
top