OMQ::CryptoKeyHelper Class Reference

manages Qorus encryption keys More...

Inheritance diagram for OMQ::CryptoKeyHelper:

Public Member Methods
binary	serializeEncryptSensitiveData (hash< auto > data, binary iv, reference mac, string aad)
	returns a binary object encrypted with AES-256 for a sensitive data hash
hash< auto >	deserializeDecryptSensitiveData (binary data, binary iv, binary mac, string aad)
	returns a decrypted sensitive data hash from the AES-256-encrypted binary object and other encryption arguments
string	encodeEncryptSensitiveValue (string svalue)
	returns a string encrypted with Blowfish and subjected to base64 encoding for a sensitive data key value
string	decodeDecryptSensitiveValue (string svalue)
	returns a decoded and decrypted sensitive data key value from the base64-encoded encrypted value
hash< auto >	encryptOrderData (softint wfiid, string skey, string svalue, hash< auto > info, *hash< auto > meta)
	encrypt the data needed for a row in sensitive_order_data
abstract *string	getKeyOption (string opt)
	returns the value of a system opion as a string

Private Member Methods
	setupEncryption ()
	sets up encryption keys and verifies their state

Detailed Description

manages Qorus encryption keys

Member Function Documentation

decodeDecryptSensitiveValue()

string OMQ::CryptoKeyHelper::decodeDecryptSensitiveValue

(

string

svalue

)

returns a decoded and decrypted sensitive data key value from the base64-encoded encrypted value

Example:

string svalue = decodeDecryptSensitiveValue(get_encrypted_key_value());

Parameters

svalue

the base64-encoded encrypted value

Returns

the decrypted sensitive data key value corresponding to the argument

Exceptions

SENSITIVE-DATA-ERROR

encryption options are not set with valid encryption keys

See also

• Qore::decrypt_to_string() for additional exceptions that can be thrown when encrypting
• deserializeDecryptSensitiveData()
• Qore::CRYPTO_ALG_BLOWFISH

Since

Qorus 3.1.1

deserializeDecryptSensitiveData()

hash< auto > OMQ::CryptoKeyHelper::deserializeDecryptSensitiveData	(	binary	data,
		binary	iv,
		binary	mac,
		string	aad
	)

returns a decrypted sensitive data hash from the AES-256-encrypted binary object and other encryption arguments

Example:

hash data = deserializeDecryptSensitiveData(data, iv, mac, aad);

Parameters

data	the sensitive data to decrypt using the AES-256 algorithm
iv	the 12-byte initialization vector used for encryption
mac	a reference to a binary object that will return the Message Authentication Code
aad	Additional Authenticated Data for the mac

Returns

the decrypted sensitive data hash corresponding to the arguments

Exceptions

SENSITIVE-DATA-ERROR

encryption options are not set with valid encryption keys

See also

• Qore::decrypt_to_string() for additional exceptions that can be thrown when encrypting
• Qore::YAML::parse_yaml() for additional exceptions that can be thrown when deserializing in case of a data error
• serializeEncryptSensitiveData()
• Qore::CRYPTO_ALG_AES_256

Since

Qorus 3.1.1

encodeEncryptSensitiveValue()

string OMQ::CryptoKeyHelper::encodeEncryptSensitiveValue

(

string

svalue

)

returns a string encrypted with Blowfish and subjected to base64 encoding for a sensitive data key value

Example:

string svalue = encodeEncryptSensitiveValue(get_sensitive_key_value());

Parameters

svalue

the sensitive data key value to encrypt

Returns

a string encrypted with Blowfish and subjected to base64 encoding

Exceptions

SENSITIVE-DATA-ERROR

encryption options are not set with valid encryption keys

See also

• Qore::encrypt() for additional exceptions that can be thrown when encrypting
• decodeDecryptSensitiveValue()
• Qore::CRYPTO_ALG_BLOWFISH

Since

Qorus 3.1.1

serializeEncryptSensitiveData()

binary OMQ::CryptoKeyHelper::serializeEncryptSensitiveData	(	hash< auto >	data,
		binary	iv,
		reference	mac,
		string	aad
	)

returns a binary object encrypted with AES-256 for a sensitive data hash

Example:

binary mac;
binary iv = get_random_bytes(12);
binary b = serializeEncryptSensitiveData(h, iv, \mac, aad);

Parameters

data	the sensitive data hash to encrypt
iv	a 12-byte initialization vector for the AES-256 encryption algorithm
mac	a reference to a binary object that will return the Message Authentication Code
aad	Additional Authenticated Data for the mac

Returns

the binary object encrypted with AES-256 for a sensitive data hash

Exceptions

SENSITIVE-DATA-ERROR

encryption options are not set with valid encryption keys

See also

• Qore::encrypt() for additional exceptions that can be thrown when encrypting
• Qore::YAML::make_yaml() for additional exceptions that can be thrown when serializing in case of a data error
• deserializeDecryptSensitiveData()
• Qore::CRYPTO_ALG_AES_256

Since

Qorus 3.1.1

---

The documentation for this class was generated from the following file:

• misc.ql