Crytographic Functions

Functions
binary	Qore::blowfish_decrypt_cbc (binary data, data key, data iv=Qore::DefaultIV)
	Decrypts data using the Cipher Block Chaining function for the blowfish algorithm and returns a binary object of the decrypted data. More...
string	Qore::blowfish_decrypt_cbc_to_string (binary data, data key, data iv=Qore::DefaultIV, *string encoding)
	Decrypts data using the Cipher Block Chaining function for the blowfish algorithm and returns a string of the decrypted data. More...
binary	Qore::blowfish_encrypt_cbc (data data, data key, data iv=Qore::DefaultIV)
	Encrypts data using the Cipher Block Chaining function for the blowfish algorithm More...
binary	Qore::cast5_decrypt_cbc (binary data, data key, data iv=Qore::DefaultIV)
	Decrypts data using the Cipher Block Chaining function for the CAST5 algorithm using a variable-length key and an optional 8-byte initialization vector. More...
string	Qore::cast5_decrypt_cbc_to_string (binary data, data key, data iv=Qore::DefaultIV, *string encoding)
	Decrypts data using the Cipher Block Chaining function for the CAST5 algorithm using a variable-length key and an optional 8-byte initialization vector. More...
binary	Qore::cast5_encrypt_cbc (data data, data key, data iv=Qore::DefaultIV)
	Encrypts data using the Cipher Block Chaining function for the CAST5 algorithm using a variable-length key and an optional 8-byte initialization vector. More...
binary	Qore::des_decrypt_cbc (binary data, data key, data iv=Qore::DefaultIV)
	Decrypts data using the Cipher Block Chaining function for the DES algorithm using an 8-byte key. More...
string	Qore::des_decrypt_cbc_to_string (binary data, data key, data iv=Qore::DefaultIV, *string encoding)
	Decrypts data using the Cipher Block Chaining function for the DES algorithm using an 8-byte key. More...
binary	Qore::des_ede3_decrypt_cbc (data data, data key, data iv=Qore::DefaultIV)
	Decrypts data using the Cipher Block Chaining function for the three-key triple DES algorithm using three 8-byte keys (set by a single 24-byte key argument) and an optional 8-byte initialization vector. More...
string	Qore::des_ede3_decrypt_cbc_to_string (binary data, data key, data iv=Qore::DefaultIV, *string encoding)
	Decrypts data using the Cipher Block Chaining function for the three-key triple DES algorithm using three 8-byte keys (set by a single 24-byte key argument) and an optional 8-byte initialization vector. More...
binary	Qore::des_ede3_encrypt_cbc (data data, data key, data iv=Qore::DefaultIV)
	Encrypts data using the Cipher Block Chaining function for the three-key triple DES algorithm using three 8-byte keys (set by a single 24-byte key argument) and an optional 8-byte initialization vector. More...
binary	Qore::des_ede_decrypt_cbc (binary data, data key, data iv=Qore::DefaultIV)
	Decrypts data using the Cipher Block Chaining function for the two-key triple DES algorithm using two eight-byte keys (set by a single 16-byte key argument) More...
string	Qore::des_ede_decrypt_cbc_to_string (binary data, data key, data iv=Qore::DefaultIV, *string encoding)
	Decrypts data using the Cipher Block Chaining function for the two-key triple DES algorithm using two eight-byte keys (set by a single 16-byte key argument) More...
binary	Qore::des_ede_encrypt_cbc (data data, data key, data iv=Qore::DefaultIV)
	Encrypts data using the Cipher Block Chaining function for the two-key triple DES algorithm using two eight-byte keys (set by a single 16-byte key argument) More...
binary	Qore::des_encrypt_cbc (data data, data key, data iv=Qore::DefaultIV)
	Encrypts data using the Cipher Block Chaining function for the DES algorithm using an 8-byte key. More...
binary	Qore::des_random_key ()
	Returns a binary object of a random key for the DES algorithm More...
binary	Qore::desx_decrypt_cbc (binary data, data key, data iv=Qore::DefaultIV)
	Decrypts data using the Cipher Block Chaining function for RSA's DESX algorithm using a 24-byte key and an optional 8-byte initialization vector. More...
string	Qore::desx_decrypt_cbc_to_string (binary data, data key, data iv=Qore::DefaultIV, *string encoding)
	Decrypts data using the Cipher Block Chaining function for RSA's DESX algorithm using a 24-byte key and an optional 8-byte initialization vector. More...
binary	Qore::desx_encrypt_cbc (data data, data key, data iv=Qore::DefaultIV)
	Encrypts data using the Cipher Block Chaining function for RSA's DESX algorithm using a 24-byte key and an optional 8-byte initialization vector. More...
binary	Qore::rc2_decrypt_cbc (binary data, data key, data iv=Qore::DefaultIV)
	Decrypts data using the Cipher Block Chaining function for RSA's RC2(tm) algorithm using a variable-length key and an optional 8-byte initialization vector. More...
string	Qore::rc2_decrypt_cbc_to_string (binary data, data key, data iv=Qore::DefaultIV, *string encoding)
	Decrypts data using the Cipher Block Chaining function for RSA's RC2(tm) algorithm using a variable-length key and an optional 8-byte initialization vector. More...
binary	Qore::rc2_encrypt_cbc (data data, data key, data iv=Qore::DefaultIV)
	Encrypts data using the Cipher Block Chaining function for RSA's RC2(tm) algorithm using a variable-length key and an optional 8-byte initialization vector. More...
binary	Qore::rc4_decrypt (binary data, data key, data iv=Qore::DefaultIV)
	Decrypts data using the Alleged RC4 cipher algorithm, which should be compatible with RSA's RC4(tm) algorithm using a variable-length key and an optional 8-byte initialization vector. More...
string	Qore::rc4_decrypt_to_string (binary data, data key, data iv=Qore::DefaultIV, *string encoding)
	Decrypts data using the Alleged RC4 cipher algorithm, which should be compatible with RSA's RC4(tm) algorithm using a variable-length key and an optional 8-byte initialization vector. More...
binary	Qore::rc4_encrypt (data data, data key, data iv=Qore::DefaultIV)
	Encrypts data using the Alleged RC4 cipher algorithm, which should be compatible with RSA's RC4(tm) algorithm using a variable-length key and an optional 8-byte initialization vector. More...
binary	Qore::rc5_decrypt_cbc (binary data, data key, data iv=Qore::DefaultIV)
	Decrypts data using the Cipher Block Chaining function for RSA's RC2(tm) algorithm using a variable-length key and an optional 8-byte initialization vector. More...
string	Qore::rc5_decrypt_cbc_to_string (binary data, data key, data iv=Qore::DefaultIV, *string encoding)
	Decrypts data using the Cipher Block Chaining function for RSA's RC2(tm) algorithm using a variable-length key and an optional 8-byte initialization vector. More...
binary	Qore::rc5_encrypt_cbc (data data, data key, data iv=Qore::DefaultIV)
	Encrypts data using the Cipher Block Chaining function for RSA's RC2(tm) algorithm using a variable-length key and an optional 8-byte initialization vector. More...

Detailed Description

Qore's cryptography support is provided by the OpenSSL library. Each of the encryption and decryption functions in this section accept an optional initialization vector, which is data used as initial input for the first block in chained encryption algorithms. Subsequent blocks take input from the last block encrypted/decrypted. If an initialization vector is not supplied, a default value of 8 zero bytes will be used (see Qore::DefaultIV).

See also:

• Digest (Hash) Functions
• HMAC Functions
• Crytographic Contants

Some functions require fixed-length keys, and some allow the use of variable-length keys. For functions requiring fixed-length keys any excess bytes are ignored. The same applies to initialization vector arguments.

The following is an example of a function that uses /dev/random on UNIX to read in a random key for use with encryption functions:

# read a key from /dev/random and return the key
binary sub get_key(int $size) {
    # throw an exception if an invalid key size was passed
    if (!$size || $size < 0)
        throw "GET-KEY-ERROR", sprintf("invalid size = %n", $size);
    my File $f();
    # File::open2() will throw an exception if /dev/random cannot be opened for reading
    $f.open2("/dev/random");
    return $f.readBinary($size);
}

Function Documentation

binary Qore::blowfish_decrypt_cbc	(	binary	data,
		data	key,
		data	iv = Qore::DefaultIV
	)

Decrypts data using the Cipher Block Chaining function for the blowfish algorithm and returns a binary object of the decrypted data.

Code Flags:

RET_VALUE_ONLY

Parameters

data	the data to be decrypted
key	a variable-length key (recommended 16 bytes or more)
iv	the initialization vector must be at least 8 bytes long if present

Returns

a binary object of the decrypted data

Example:

my binary $bin = blowfish_decrypt_cbc($data, $key);

Exceptions

BLOWFISH-DECRYPT-PARAM-ERROR	invalid initialization vector (less than 8 bytes)
DECRYPT-ERROR	processing error decrypting the data (for example invalid data)

string Qore::blowfish_decrypt_cbc_to_string	(	binary	data,
		data	key,
		data	iv = Qore::DefaultIV,
		*string	encoding
	)

Decrypts data using the Cipher Block Chaining function for the blowfish algorithm and returns a string of the decrypted data.

Code Flags:

RET_VALUE_ONLY

Parameters

data	the data to be decrypted
key	a variable-length key (recommended 16 bytes or more)
iv	the initialization vector must be at least 8 bytes long if present
encoding	the character encoding tag for the string return value; if not present, the default character encoding is assumed

Returns

a string of the decrypted data

Example:

my string $str = blowfish_decrypt_cbc_to_string($data, $key, NOTHING, "iso-8859-1");

Exceptions

BLOWFISH-DECRYPT-PARAM-ERROR	invalid initialization vector (less than 8 bytes)
DECRYPT-ERROR	processing error decrypting the data (for example invalid data)

Since

Qore 0.8.4 added the encoding parameter to specify the output encoding of the string

binary Qore::blowfish_encrypt_cbc	(	data	data,
		data	key,
		data	iv = Qore::DefaultIV
	)

Encrypts data using the Cipher Block Chaining function for the blowfish algorithm

Code Flags:

RET_VALUE_ONLY

Parameters

data	the data to be encrypted
key	a variable-length key (recommended 16 bytes or more)
iv	the initialization vector must be at least 8 bytes long if present

Returns

a binary object of the encrypted data

Example:

my binary $bin = blowfish_encrypt_cbc($data, $key);

Exceptions

BLOWFISH-ENCRYPT-PARAM-ERROR	invalid initialization vector (less than 8 bytes)
ENCRYPT-ERROR	processing error encrypting the data (should not normally happen)

binary Qore::cast5_decrypt_cbc	(	binary	data,
		data	key,
		data	iv = Qore::DefaultIV
	)

Decrypts data using the Cipher Block Chaining function for the CAST5 algorithm using a variable-length key and an optional 8-byte initialization vector.

Code Flags:

RET_VALUE_ONLY

Parameters

data	the data to be decrypted
key	a variable-width decryption key
iv	the initialization vector must be at least 8 bytes long if present

Returns

a binary object of the decrypted data

Example:

my binary $bin = cast5_decrypt_cbc($data, $key);

Exceptions

CAST5-DECRYPT-PARAM-ERROR	invalid initialization vector (less than 8 bytes)
DECRYPT-ERROR	processing error decrypting the data (for example invalid data)

string Qore::cast5_decrypt_cbc_to_string	(	binary	data,
		data	key,
		data	iv = Qore::DefaultIV,
		*string	encoding
	)

Decrypts data using the Cipher Block Chaining function for the CAST5 algorithm using a variable-length key and an optional 8-byte initialization vector.

Code Flags:

RET_VALUE_ONLY

Parameters

data	the data to be decrypted
key	a variable-width decryption key
iv	the initialization vector must be at least 8 bytes long if present
encoding	the character encoding tag for the string return value; if not present, the default character encoding is assumed

Returns

a string of the decrypted data

Example:

my string $bin = cast5_decrypt_cbc_to_string($data, $key, NOTHING, "iso-8859-1");

Exceptions

CAST5-DECRYPT-PARAM-ERROR	invalid initialization vector (less than 8 bytes)
DECRYPT-ERROR	processing error decrypting the data (for example invalid data)

Since

Qore 0.8.4 added the encoding parameter to specify the output encoding of the string

binary Qore::cast5_encrypt_cbc	(	data	data,
		data	key,
		data	iv = Qore::DefaultIV
	)

Encrypts data using the Cipher Block Chaining function for the CAST5 algorithm using a variable-length key and an optional 8-byte initialization vector.

Code Flags:

RET_VALUE_ONLY

Parameters

data	the data to be encrypted
key	a variable-width encryption key
iv	the initialization vector must be at least 8 bytes long if present

Returns

a binary object of the encrypted data

Example:

my binary $bin = cast5_encrypt_cbc($data, $key);

Exceptions

CAST5-ENCRYPT-PARAM-ERROR	invalid initialization vector (less than 8 bytes)
ENCRYPT-ERROR	processing error encrypting the data (should not normally happen)

binary Qore::des_decrypt_cbc	(	binary	data,
		data	key,
		data	iv = Qore::DefaultIV
	)

Decrypts data using the Cipher Block Chaining function for the DES algorithm using an 8-byte key.

Code Flags:

RET_VALUE_ONLY

Parameters

data	the data to be decrypted
key	the decryption key must be at least 8 bytes long (only the first 8 bytes will be used)
iv	the initialization vector must be at least 8 bytes long if present

Returns

a binary object of the decrypted data

Example:

my binary $bin = des_decrypt_cbc($data, $key);

Exceptions

DES-DECRYPT-PARAM-ERROR	invalid initialization vector (less than 8 bytes)
DES-KEY-ERROR	invalid key (too short)
DECRYPT-ERROR	processing error decrypting the data (for example invalid data)

string Qore::des_decrypt_cbc_to_string	(	binary	data,
		data	key,
		data	iv = Qore::DefaultIV,
		*string	encoding
	)

Decrypts data using the Cipher Block Chaining function for the DES algorithm using an 8-byte key.

Code Flags:

RET_VALUE_ONLY

Parameters

data	the data to be decrypted
key	the decryption key must be at least 8 bytes long (only the first 8 bytes will be used)
iv	the initialization vector must be at least 8 bytes long if present
encoding	the character encoding tag for the string return value; if not present, the default character encoding is assumed

Returns

a string of the decrypted data

Example:

my string $bin = des_decrypt_cbc_to_string($data, $key, NOTHING, "iso-8859-1");

Exceptions

DES-DECRYPT-PARAM-ERROR	invalid initialization vector (less than 8 bytes)
DES-KEY-ERROR	invalid key (too short)
DECRYPT-ERROR	processing error decrypting the data (for example invalid data)

Since

Qore 0.8.4 added the encoding parameter to specify the output encoding of the string

binary Qore::des_ede3_decrypt_cbc	(	data	data,
		data	key,
		data	iv = Qore::DefaultIV
	)

Decrypts data using the Cipher Block Chaining function for the three-key triple DES algorithm using three 8-byte keys (set by a single 24-byte key argument) and an optional 8-byte initialization vector.

Code Flags:

RET_VALUE_ONLY

Parameters

data	the data to be decrypted
key	the decryption key must be at least 24 bytes long (only the first 24 bytes will be used for the three 8-byte keys)
iv	the initialization vector must be at least 8 bytes long if present

Returns

a binary object of the decrypted data

Example:

my binary $bin = des_ede3_decrypt_cbc($data, $key);

Exceptions

DES-DECRYPT-PARAM-ERROR	invalid initialization vector (less than 8 bytes)
DES-KEY-ERROR	invalid key (too short)
DECRYPT-ERROR	processing error decrypting the data (for example invalid data)

string Qore::des_ede3_decrypt_cbc_to_string	(	binary	data,
		data	key,
		data	iv = Qore::DefaultIV,
		*string	encoding
	)

Decrypts data using the Cipher Block Chaining function for the three-key triple DES algorithm using three 8-byte keys (set by a single 24-byte key argument) and an optional 8-byte initialization vector.

Code Flags:

RET_VALUE_ONLY

Parameters

data	the data to be decrypted
key	the decryption key must be at least 24 bytes long (only the first 24 bytes will be used for the three 8-byte keys)
iv	the initialization vector must be at least 8 bytes long if present
encoding	the character encoding tag for the string return value; if not present, the default character encoding is assumed

Returns

a string of the decrypted data

Example:

my string $bin = des_ede3_decrypt_cbc_to_string($data, $key, NOTHING, "iso-8859-1");

Exceptions

DES-DECRYPT-PARAM-ERROR	invalid initialization vector (less than 8 bytes)
DES-KEY-ERROR	invalid key (too short)
DECRYPT-ERROR	processing error decrypting the data (for example invalid data)

Since

Qore 0.8.4 added the encoding parameter to specify the output encoding of the string

binary Qore::des_ede3_encrypt_cbc	(	data	data,
		data	key,
		data	iv = Qore::DefaultIV
	)

Encrypts data using the Cipher Block Chaining function for the three-key triple DES algorithm using three 8-byte keys (set by a single 24-byte key argument) and an optional 8-byte initialization vector.

Code Flags:

RET_VALUE_ONLY

Parameters

data	the data to be encrypted
key	the encryption key must be at least 24 bytes long (only the first 24 bytes will be used for the three 8-byte keys)
iv	the initialization vector must be at least 8 bytes long if present

Returns

a binary object of the encrypted data

Example:

my binary $bin = des_ede3_encrypt_cbc($data, $key);

Exceptions

DES-ENCRYPT-PARAM-ERROR	invalid initialization vector (less than 8 bytes)
DES-KEY-ERROR	invalid key (too short)
ENCRYPT-ERROR	processing error encrypting the data (should not normally happen)

binary Qore::des_ede_decrypt_cbc	(	binary	data,
		data	key,
		data	iv = Qore::DefaultIV
	)

Decrypts data using the Cipher Block Chaining function for the two-key triple DES algorithm using two eight-byte keys (set by a single 16-byte key argument)

Code Flags:

RET_VALUE_ONLY

Parameters

data	the data to be decrypted
key	the decryption key must be at least 16 bytes long (only the first 16 bytes will be used for the two 8-byte keys)
iv	the initialization vector must be at least 8 bytes long if present

Returns

a binary object of the decrypted data

Example:

my binary $bin = des_ede_decrypt_cbc($data, $key);

Exceptions

DES-ENCRYPT-PARAM-ERROR	invalid initialization vector (less than 8 bytes)
DES-KEY-ERROR	invalid key (too short)
DECRYPT-ERROR	processing error decrypting the data (for example invalid data)

string Qore::des_ede_decrypt_cbc_to_string	(	binary	data,
		data	key,
		data	iv = Qore::DefaultIV,
		*string	encoding
	)

Decrypts data using the Cipher Block Chaining function for the two-key triple DES algorithm using two eight-byte keys (set by a single 16-byte key argument)

Code Flags:

RET_VALUE_ONLY

Parameters

data	the data to be decrypted
key	the decryption key must be at least 16 bytes long (only the first 16 bytes will be used for the two 8-byte keys)
iv	the initialization vector must be at least 8 bytes long if present
encoding	the character encoding tag for the string return value; if not present, the default character encoding is assumed

Returns

a string of the decrypted data

Example:

my string $bin = des_ede_decrypt_cbc_to_string($data, $key, NOTHING, "iso-8859-1");

Exceptions

DES-ENCRYPT-PARAM-ERROR	invalid initialization vector (less than 8 bytes)
DES-KEY-ERROR	invalid key (too short)
DECRYPT-ERROR	processing error decrypting the data (for example invalid data)

Since

Qore 0.8.4 added the encoding parameter to specify the output encoding of the string

binary Qore::des_ede_encrypt_cbc	(	data	data,
		data	key,
		data	iv = Qore::DefaultIV
	)

Encrypts data using the Cipher Block Chaining function for the two-key triple DES algorithm using two eight-byte keys (set by a single 16-byte key argument)

Code Flags:

RET_VALUE_ONLY

Parameters

data	the data to be encrypted
key	the encryption key must be at least 16 bytes long (only the first 16 bytes will be used for the two 8-byte keys)
iv	the initialization vector must be at least 8 bytes long if present

Returns

a binary object of the encrypted data

Example:

my binary $bin = des_ede_encrypt_cbc($data, $key);

Exceptions

DES-ENCRYPT-PARAM-ERROR	invalid initialization vector (less than 8 bytes)
DES-KEY-ERROR	invalid key (too short)
ENCRYPT-ERROR	processing error encrypting the data (should not normally happen)

binary Qore::des_encrypt_cbc	(	data	data,
		data	key,
		data	iv = Qore::DefaultIV
	)

Encrypts data using the Cipher Block Chaining function for the DES algorithm using an 8-byte key.

Code Flags:

RET_VALUE_ONLY

Parameters

data	the data to be encrypted
key	the encryption key must be at least 8 bytes long (only the first 8 bytes will be used)
iv	the initialization vector must be at least 8 bytes long if present

Returns

a binary object of the encrypted data

Example:

my binary $bin = des_encrypt_cbc($data, $key);

Exceptions

DES-ENCRYPT-PARAM-ERROR	invalid initialization vector (less than 8 bytes)
DES-KEY-ERROR	invalid key (too short)
ENCRYPT-ERROR	processing error encrypting the data (should not normally happen)

binary Qore::des_random_key

(

)

Returns a binary object of a random key for the DES algorithm

Returns

a binary object of a random key for the DES algorithm

Code Flags:

CONSTANT

Example:

my binary $bin = des_random_key();

binary Qore::desx_decrypt_cbc	(	binary	data,
		data	key,
		data	iv = Qore::DefaultIV
	)

Decrypts data using the Cipher Block Chaining function for RSA's DESX algorithm using a 24-byte key and an optional 8-byte initialization vector.

Code Flags:

RET_VALUE_ONLY

Parameters

data	the data to be decrypted
key	the decryption key must be at least 24 bytes long (only the first 24 bytes will be used)
iv	the initialization vector must be at least 8 bytes long if present

Returns

a binary object of the decrypted data

Example:

my binary $bin = desx_decrypt_cbc($data, $key);

Exceptions

DESX-DECRYPT-PARAM-ERROR	invalid initialization vector (less than 8 bytes)
DESX-KEY-ERROR	invalid key (too short)
DECRYPT-ERROR	processing error decrypting the data (for example invalid data)

string Qore::desx_decrypt_cbc_to_string	(	binary	data,
		data	key,
		data	iv = Qore::DefaultIV,
		*string	encoding
	)

Decrypts data using the Cipher Block Chaining function for RSA's DESX algorithm using a 24-byte key and an optional 8-byte initialization vector.

Code Flags:

RET_VALUE_ONLY

Parameters

data	the data to be decrypted
key	the decryption key must be at least 24 bytes long (only the first 24 bytes will be used)
iv	the initialization vector must be at least 8 bytes long if present
encoding	the character encoding tag for the string return value; if not present, the default character encoding is assumed

Returns

a binary object of the decrypted data

Example:

my string $str = desx_decrypt_cbc_to_string($data, $key, NOTHING, "iso-8859-1");

Exceptions

DESX-DECRYPT-PARAM-ERROR	invalid initialization vector (less than 8 bytes)
DESX-KEY-ERROR	invalid key (too short)
DECRYPT-ERROR	processing error decrypting the data (for example invalid data)

Since

Qore 0.8.4 added the encoding parameter to specify the output encoding of the string

binary Qore::desx_encrypt_cbc	(	data	data,
		data	key,
		data	iv = Qore::DefaultIV
	)

Encrypts data using the Cipher Block Chaining function for RSA's DESX algorithm using a 24-byte key and an optional 8-byte initialization vector.

Code Flags:

RET_VALUE_ONLY

Parameters

data	the data to be encrypted
key	the encryption key must be at least 24 bytes long (only the first 24 bytes will be used)
iv	the initialization vector must be at least 8 bytes long if present

Returns

a binary object of the encrypted data

Example:

my binary $bin = desx_encrypt_cbc($data, $key);

Exceptions

DESX-ENCRYPT-PARAM-ERROR	invalid initialization vector (less than 8 bytes)
DESX-KEY-ERROR	invalid key (too short)
ENCRYPT-ERROR	processing error encrypting the data (should not normally happen)

binary Qore::rc2_decrypt_cbc	(	binary	data,
		data	key,
		data	iv = Qore::DefaultIV
	)

Decrypts data using the Cipher Block Chaining function for RSA's RC2(tm) algorithm using a variable-length key and an optional 8-byte initialization vector.

Code Flags:

RET_VALUE_ONLY

Parameters

data	the data to be decrypted
key	a variable-width decryption key
iv	the initialization vector must be at least 8 bytes long if present

Returns

a binary object of the decrypted data

Example:

my binary $bin = rc2_decrypt_cbc($data, $key);

Exceptions

RC2-DECRYPT-PARAM-ERROR	invalid initialization vector (less than 8 bytes)
DECRYPT-ERROR	processing error decrypting the data (for example invalid data)

string Qore::rc2_decrypt_cbc_to_string	(	binary	data,
		data	key,
		data	iv = Qore::DefaultIV,
		*string	encoding
	)

Decrypts data using the Cipher Block Chaining function for RSA's RC2(tm) algorithm using a variable-length key and an optional 8-byte initialization vector.

Code Flags:

RET_VALUE_ONLY

Parameters

data	the data to be decrypted
key	a variable-width decryption key
iv	the initialization vector must be at least 8 bytes long if present
encoding	the character encoding tag for the string return value; if not present, the default character encoding is assumed

Returns

a string of the decrypted data

Example:

my string $str = rc2_decrypt_cbc_to_string($data, $key);

Exceptions

RC2-DECRYPT-PARAM-ERROR	invalid initialization vector (less than 8 bytes)
DECRYPT-ERROR	processing error decrypting the data (for example invalid data)

Since

Qore 0.8.4 added the encoding parameter to specify the output encoding of the string

binary Qore::rc2_encrypt_cbc	(	data	data,
		data	key,
		data	iv = Qore::DefaultIV
	)

Encrypts data using the Cipher Block Chaining function for RSA's RC2(tm) algorithm using a variable-length key and an optional 8-byte initialization vector.

Code Flags:

RET_VALUE_ONLY

Parameters

data	the data to be encrypted
key	a variable-width encryption key
iv	the initialization vector must be at least 8 bytes long if present

Returns

a binary object of the encrypted data

Example:

my binary $bin = rc2_encrypt_cbc($data, $key);

Exceptions

RC2-ENCRYPT-PARAM-ERROR	invalid initialization vector (less than 8 bytes)
ENCRYPT-ERROR	processing error encrypting the data (should not normally happen)

binary Qore::rc4_decrypt	(	binary	data,
		data	key,
		data	iv = Qore::DefaultIV
	)

Decrypts data using the Alleged RC4 cipher algorithm, which should be compatible with RSA's RC4(tm) algorithm using a variable-length key and an optional 8-byte initialization vector.

Code Flags:

RET_VALUE_ONLY

Parameters

data	the data to be decrypted
key	a variable-width decryption key
iv	the initialization vector must be at least 8 bytes long if present

Returns

a binary object of the decrypted data

Example:

my binary $bin = rc4_decrypt($data, $key);

Exceptions

RC4-DECRYPT-PARAM-ERROR	invalid initialization vector (less than 8 bytes)
DECRYPT-ERROR	processing error decrypting the data (for example invalid data)

string Qore::rc4_decrypt_to_string	(	binary	data,
		data	key,
		data	iv = Qore::DefaultIV,
		*string	encoding
	)

Decrypts data using the Alleged RC4 cipher algorithm, which should be compatible with RSA's RC4(tm) algorithm using a variable-length key and an optional 8-byte initialization vector.

Code Flags:

RET_VALUE_ONLY

Parameters

data	the data to be decrypted
key	a variable-width decryption key
iv	the initialization vector must be at least 8 bytes long if present
encoding	the character encoding tag for the string return value; if not present, the default character encoding is assumed

Returns

a string of the decrypted data

Example:

my string $str = rc4_decrypt_to_string($encrypted_data, $key, NOTHING, "iso-8859-1");

Exceptions

RC4-DECRYPT-PARAM-ERROR	invalid initialization vector (less than 8 bytes)
DECRYPT-ERROR	processing error decrypting the data (for example invalid data)

Since

Qore 0.8.4 added the encoding parameter to specify the output encoding of the string

binary Qore::rc4_encrypt	(	data	data,
		data	key,
		data	iv = Qore::DefaultIV
	)

Encrypts data using the Alleged RC4 cipher algorithm, which should be compatible with RSA's RC4(tm) algorithm using a variable-length key and an optional 8-byte initialization vector.

Code Flags:

RET_VALUE_ONLY

Parameters

data	the data to be encrypted
key	a variable-width encryption key
iv	the initialization vector must be at least 8 bytes long if present

Returns

a binary object of the encrypted data

Example:

my binary $bin = rc4_encrypt($data, $key);

Exceptions

RC4-ENCRYPT-PARAM-ERROR	invalid initialization vector (less than 8 bytes)
ENCRYPT-ERROR	processing error encrypting the data (should not normally happen)

binary Qore::rc5_decrypt_cbc	(	binary	data,
		data	key,
		data	iv = Qore::DefaultIV
	)

Decrypts data using the Cipher Block Chaining function for RSA's RC2(tm) algorithm using a variable-length key and an optional 8-byte initialization vector.

Platform Availability:

Qore::Option::HAVE_RC5

Code Flags:

RET_VALUE_ONLY

Parameters

data	the data to be decrypted
key	a variable-width decryption key
iv	the initialization vector must be at least 8 bytes long if present

Returns

a binary object of the decrypted data

Example:

my binary $bin = rc2_decrypt_cbc($data, $key);

Exceptions

RC5-DECRYPT-PARAM-ERROR	invalid initialization vector (less than 8 bytes)
DECRYPT-ERROR	processing error decrypting the data (for example invalid data)

string Qore::rc5_decrypt_cbc_to_string	(	binary	data,
		data	key,
		data	iv = Qore::DefaultIV,
		*string	encoding
	)

Decrypts data using the Cipher Block Chaining function for RSA's RC2(tm) algorithm using a variable-length key and an optional 8-byte initialization vector.

Platform Availability:

Qore::Option::HAVE_RC5

Code Flags:

RET_VALUE_ONLY

Parameters

data	the data to be decrypted
key	a variable-width decryption key
iv	the initialization vector must be at least 8 bytes long if present
encoding	the character encoding tag for the string return value; if not present, the default character encoding is assumed

Returns

a string of the decrypted data

Example:

my string $str = rc2_decrypt_cbc_to_string($data, $key, NOTHING, "iso-8859-1");

Exceptions

RC5-DECRYPT-PARAM-ERROR	invalid initialization vector (less than 8 bytes)
DECRYPT-ERROR	processing error decrypting the data (for example invalid data)

Since

Qore 0.8.4 added the encoding parameter to specify the output encoding of the string

binary Qore::rc5_encrypt_cbc	(	data	data,
		data	key,
		data	iv = Qore::DefaultIV
	)

Encrypts data using the Cipher Block Chaining function for RSA's RC2(tm) algorithm using a variable-length key and an optional 8-byte initialization vector.

Platform Availability:

Qore::Option::HAVE_RC5

Code Flags:

RET_VALUE_ONLY

Parameters

data	the data to be encrypted
key	a variable-width encryption key
iv	the initialization vector must be at least 8 bytes long if present

Returns

a binary object of the encrypted data

Example:

my binary $bin = rc2_encrypt_cbc($data, $key);

Exceptions

RC5-ENCRYPT-PARAM-ERROR	invalid initialization vector (less than 8 bytes)
ENCRYPT-ERROR	processing error encrypting the data (should not normally happen)