SecureString Tcl Reference Documentation

SecureString

Current Version: 9.5.0.75

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

LastMethodSuccess
boolean 1/0
set boolVal [CkSecureString_get_LastMethodSuccess $mySecureString]
CkSecureString_put_LastMethodSuccess $mySecureString $boolVal

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.

top
MaintainHash
string
# ckStr is a CkString
CkSecureString_get_MaintainHash $mySecureString $ckStr
set strVal [CkSecureString_get_maintainHash $mySecureString]
CkSecureString_put_MaintainHash $mySecureString $strVal
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".

top
ReadOnly
boolean 1/0
set boolVal [CkSecureString_get_ReadOnly $mySecureString]
CkSecureString_put_ReadOnly $mySecureString $boolVal
Introduced in version 9.5.0.71

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

top
Utf8
boolean 1/0
set boolVal [CkSecureString_get_Utf8 $mySecureString]
CkSecureString_put_Utf8 $mySecureString $boolVal

When set to 1, all "const char *" arguments are interpreted as utf-8 strings. If set to 0 (the default), then "const char *" arguments are interpreted as ANSI strings. Also, when set to 1, and Chilkat method returning a "const char *" is returning the utf-8 representation. If set to 0, all "const char *" return values are ANSI strings.

top

Methods

Access
# outStr is a CkString (output)
set status [CkSecureString_Access $outStr]
set retStr [CkSecureString_access $mySecureString]
Introduced in version 9.5.0.71

Returns the clear-text string value.

Returns 1 for success, 0 for failure.

top
Append
# str is a string
set status [CkSecureString_Append $str]
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.

top
AppendSb
# sb is a CkStringBuilder
set status [CkSecureString_AppendSb $sb]
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.

top
AppendSecure
# secStr is a CkSecureString
set retBool [CkSecureString_AppendSecure $secStr]
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.

top
HashVal
# encoding is a string
# outStr is a CkString (output)
set status [CkSecureString_HashVal $encoding $outStr]
set retStr [CkSecureString_hashVal $mySecureString $encoding]
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 1 for success, 0 for failure.

top
LoadFile
# path is a string
# charset is a string
set status [CkSecureString_LoadFile $path $charset]
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.

top
SecStrEquals
# secStr is a CkSecureString
set status [CkSecureString_SecStrEquals $secStr]
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.

top
VerifyHash
# hashVal is a string
# encoding is a string
set status [CkSecureString_VerifyHash $hashVal $encoding]
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.

top