Crypto
Use the Crypto commands to encode and decode ASCII text strings to and from Base64, as well as obtain CRC16, HMAC, and MD5 values for specified strings.
Crypto.Base64EncodeCompute the Base64 of a specified string.
Syntax
Crypto.Base64Encode('value', [pad])
Arguments
value : The value, enclosed within quotes, to encode to Base64.
pad : (Optional) Replace with true | false. If true, output is padded with '=' signs. The default is true.
Examples
Example 1: Encode with padding enabled
print (Crypto.Base64Encode('Hello there'))
Debug Output
SGVsbG8gdGhlcmU=
Example 2: Encode with padding disabled
print (Crypto.Base64Encode('Hello there',false))
Debug Output
SGVsbG8gdGhlcmU
Crypto.Base64DecodeConvert the Base64 of a specified value to a string.
Syntax
Crypto.Base64Decode('value')
Arguments
value : The value, enclosed within quotes, to decode from Base64.
Example
print (Crypto.Base64Decode('SGVsbG8gdGhlcmU='))
Debug Output
Hello there
Crypto.CRC16ComputeCompute the CRC16 of a specified value.
Syntax
Crypto.CRC16Compute( 'value' )
Arguments
value : The value, enclosed within quotes, used to generate the CRC16.
Example
Crypto.CRC16Compute('Hello there')
Crypto.CipherTable with values for supported ciphers.
Syntax
Crypto.Cipher.cipher
Arguments
AES_128_CBC : aes_128_cbc
AES_128_ECB : aes_128_ecb
Note: While there are many available ciphers in OpenSSL, these are specifically supported in Q-SYS.
Example
Crypto.Cipher.AES_128_CBC
Crypto.DecryptBlock-based decryption. Will raise error on failure.
Syntax
Crypto.Decrypt ( cipher, key, iv, cipher_text )
Arguments
cipher : <string> - "aes-256-ebc", "aes-256-cbc"
key : <string>
iv : <string> (can be empty)
cipher_text : <string>
Example
decrypted_iv = Crypto.Decrypt(Crypto.Cipher.AES_128_ECB,key,nil,encrypted_iv)
Crypto.DigestCompute the message digest of specified data using a specified hashing algorithm.
Syntax
Crypto.Digest('algorithm', 'data')
Arguments
algorithm : Replace with md5 | sha1 | sha256 | sha512 , enclosed within quotes.
data : The data for which to compute the message authentication code, enclosed within quotes.
Example
Crypto.Digest('md5','Hello there')
Crypto.EncryptBlock-based encryption. Will raise error on failure.
Syntax
Crypto.Encrypt ( cipher, key, iv, message, padding )
Arguments
cipher : <string> - "aes-256-ebc", "aes-256-cbc"
key : <string>
iv : <string> (can be empty)
message : <string>
padding : <bool> default = true, if false then message must be multiple of block size
Example
Crypto.Encrypt( Crypto.Cipher.AES_128_ECB, key, nil, iv, false )
Crypto.GetRandomBytesCreate a series of random bytes.
Syntax
Crypto.GetRandomBytes(count)
Arguments
count : <number>
Example
Crypto.GetRandomBytes(13)
Crypto.HashTable with values for supported hash functions. Not all hashes are necessarily supported in every function.
Syntax
Crypto.Hash.(hash_function)
Arguments
hash_function : Replace with md5 | sha1 | sha256 | sha512.
Example
Crypto.Hash.MD5
Crypto.HMACCompute the message authentication code of specified data using a specified hashing algorithm and key.
Syntax
Crypto.HMAC('algorithm', 'key', 'data')
Arguments
algorithm : Replace with md5 | sha1 | sha256 | sha512 , enclosed within quotes.
key : The secret key to use for computing the message authentication code, enclosed within quotes.
data : The data for which to compute the message authentication code, enclosed within quotes.
Example
Crypto.HMAC('md5','123456789','Hello there')
Crypto.MD5ComputeCompute the MD5 hash of a specified value.
Syntax
Crypto.MD5Compute( 'value' )
Arguments
value : The value for which to compute the MD5 hash.
Example
print (Crypto.MD5Compute('Hello there'))
Debug Output
e8ea7a8d1e93e8764a84a0f3df4644de
Crypto.PBKDF2Implementation of Password-Based Key Derivation Function 2. Will raise error on fialure.
Syntax
Crypto.MD5Compute( 'value' )
Arguments
password : <string>
salt : <string>
iterations : <number>
keylen : <number>
digest : <string> - "sha1", "sha256", "sha512"
Example
Crypto.PBKDF2( pass, salt, iter_count, 16, Crypto.Digest.SHA256 )
