CkSecureString Python Reference Documentation

CkSecureString

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 = chilkat.CkSecureString()

Properties

# boolVal is a boolean
boolVal = secureString.get_LastMethodSuccess();
secureString.put_LastMethodSuccess(boolVal);

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.

# strVal is a string
# ckStr is a CkString
secureString.get_MaintainHash(ckStr);
strVal = secureString.maintainHash();
secureString.put_MaintainHash(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".

# boolVal is a boolean
boolVal = secureString.get_ReadOnly();
secureString.put_ReadOnly(boolVal);

Introduced in version 9.5.0.71

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

# boolVal is a boolean
boolVal = secureString.get_Utf8();
secureString.put_Utf8(boolVal);

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

Methods

# outStr is a CkString (output)
status = secureString.Access(outStr);
retStr = secureString.access();

Introduced in version 9.5.0.71

Returns the clear-text string value.

Returns True for success, False for failure.

# str is a string
status = secureString.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 False if the string has been marked as read-only via the ReadOnly property.

Returns True for success, False for failure.

# sb is a CkStringBuilder
status = secureString.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 False if the string has been marked as read-only via the ReadOnly property.

Returns True for success, False for failure.

# secStr is a CkSecureString
retBool = secureString.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 False if this string has been marked as read-only via the ReadOnly property.

# encoding is a string
# outStr is a CkString (output)
status = secureString.HashVal(encoding, outStr);
retStr = secureString.hashVal(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 True for success, False for failure.

# path is a string
# charset is a string
status = secureString.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 True for success, False for failure.

# secStr is a CkSecureString
status = secureString.SecStrEquals(secStr);

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.

# hashVal is a string
# encoding is a string
status = secureString.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 True for success, False for failure.