Qorus Integration Engine® Enterprise Edition 6.0.15_prod
Loading...
Searching...
No Matches
OMQ::CryptoKeyHelper Class Referenceabstract

manages Qorus encryption keys More...

Inheritance diagram for OMQ::CryptoKeyHelper:
[legend]

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 More...
 
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 More...
 
string encodeEncryptSensitiveValue (string svalue)
 returns a string encrypted with Blowfish and subjected to base64 encoding for a sensitive data key value More...
 
string decodeDecryptSensitiveValue (string svalue)
 returns a decoded and decrypted sensitive data key value from the base64-encoded encrypted value More...
 
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
svaluethe base64-encoded encrypted value
Returns
the decrypted sensitive data key value corresponding to the argument
Exceptions
SENSITIVE-DATA-ERRORencryption options are not set with valid encryption keys
See also
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
datathe sensitive data to decrypt using the AES-256 algorithm
ivthe 12-byte initialization vector used for encryption
maca reference to a binary object that will return the Message Authentication Code
aadAdditional Authenticated Data for the mac
Returns
the decrypted sensitive data hash corresponding to the arguments
Exceptions
SENSITIVE-DATA-ERRORencryption options are not set with valid encryption keys
See also
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
svaluethe sensitive data key value to encrypt
Returns
a string encrypted with Blowfish and subjected to base64 encoding
Exceptions
SENSITIVE-DATA-ERRORencryption options are not set with valid encryption keys
See also
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
datathe sensitive data hash to encrypt
iva 12-byte initialization vector for the AES-256 encryption algorithm
maca reference to a binary object that will return the Message Authentication Code
aadAdditional Authenticated Data for the mac
Returns
the binary object encrypted with AES-256 for a sensitive data hash
Exceptions
SENSITIVE-DATA-ERRORencryption options are not set with valid encryption keys
See also
Since
Qorus 3.1.1

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