use_hex Property

Whether binary values are hex encoded.

Syntax

def get_use_hex() -> bool: ...
def set_use_hex(value: bool) -> None: ...

use_hex = property(get_use_hex, set_use_hex)

Default Value

FALSE

Remarks

This setting specifies whether various calculated values are hex encoded. If set to False (Default) all data is provided as-is with no encoding.

If set to True certain properties are hex encoded when populated for ease of display, transport, and storage.

Compute Secret Notes

This property specifies whether shared_secret is hex encoded when compute_secret is called.

Sign and Verify Notes

This property specifies whether hash_value and hash_signature are hex encoded.

If set to True, when sign is called the class will compute the hash for the specified file and populate hash_value with the hex encoded hash value. It will then create the hash signature and populate hash_signature with the hex encoded hash signature value. If hash_value is specified directly it must be a hex encoded value.

If set to True, when verify_signature is called the class will compute the hash value for the specified file and populate hash_value with the hex encoded hash value. It will then hex decode hash_signature and verify the signature. hash_signature must hold a hex encoded value. If hash_value is specified directly it must be a hex encoded value.

Encrypt and Decrypt Notes

If set to True, when encrypt is called the class will perform the encryption as normal and then hex encode the output. output_message or output_file will hold hex encoded data.

If set to True, when decrypt is called the class will expect input_message or input_file to hold hex encoded data. The class will then hex decode the data and perform decryption as normal.