Class QCryptography

Class QCryptography: Helps in encrypting and decrypting data It depends on the mcrypt module.

While this module IS serializeable, the information it contains in serialized form is not secure and can be used to decrypt encrypted items. So, make sure you either encrypt the serialized results, or store the results in a secure location. That means, if you are using this in a form object, you must make sure your formstates are not visible to the public, or they are encrypted, since the serialized version of this object will be in the formstate.

Refer: http://php.net/manual/en/book.mcrypt.php

QBaseClass

QCryptography

Located at includes/framework/QCryptography.class.php

Methods summary
`public`	# `__construct( null\|string $strKey = null, null\|boolean $blnBase64 = null, null\|string $strCipher = null, null\|string $strMode = null, null\|string $strRandomSource = null )` The Random Number Generator the library uses to generate the IV: - MCRYPT_DEV_RANDOM = /dev/random (only on nix systems) - MCRYPT_DEV_URANDOM = /dev/urandom (only on nix systems) - MCRYPT_RAND = the internal PHP srand() mechanism (on Windows, you must use MCRYPT_RAND, b/c /dev/random and /dev/urandom doesn't exist) TODO: there appears to be some /dev/random locking issues on the QCubed development environment (using Fedora Core 3 with PHP 5.0.4 and LibMcrypt 2.5.7). Because of this, we are using MCRYPT_RAND be default. Feel free to change to to /dev/random at your own risk. The Random Number Generator the library uses to generate the IV: - MCRYPT_DEV_RANDOM = /dev/random (only on nix systems) - MCRYPT_DEV_URANDOM = /dev/urandom (only on nix systems) - MCRYPT_RAND = the internal PHP srand() mechanism (on Windows, you must* use MCRYPT_RAND, b/c /dev/random and /dev/urandom doesn't exist) TODO: there appears to be some /dev/random locking issues on the QCubed development environment (using Fedora Core 3 with PHP 5.0.4 and LibMcrypt 2.5.7). Because of this, we are using MCRYPT_RAND be default. Feel free to change to to /dev/*random at your own risk. Parameters `$strKey` Encryption key `$blnBase64` Are we going to use Base 64 encoded data? `$strCipher` Cipher to be used (default is MCRYPT_TRIPLEDES) `$strMode` Mode (default is MCRYPT_MODE_ECB) `$strRandomSource` Random source (default is MCRYPT_RAND) Throws Exception `QCallerException` `QCryptographyException`
`public mixed\|string`	# `Encrypt( string $strData )` Encrypt the data (depends on the value of class members) Encrypt the data (depends on the value of class members) Parameters `$strData` Returns mixed\|string Throws `QCryptographyException`
`public string`	# `Decrypt( string $strEncryptedData )` Decrypt the data (depends on the value of class memebers) Decrypt the data (depends on the value of class memebers) Parameters `$strEncryptedData` Returns string Throws `QCryptographyException`
`public mixed\|string`	# `EncryptFile( string $strFile )` Encrypt a file (depends on the value of class memebers) Encrypt a file (depends on the value of class memebers) Parameters `$strFile` Path of the file to be encrypted Returns mixed\|string Throws `QCallerException`\|`QCryptographyException`
`public string`	# `DecryptFile( string $strFile )` Decrypt a file (depends on the value of class memebers) Decrypt a file (depends on the value of class memebers) Parameters `$strFile` File to be decrypted Returns string Throws `QCallerException`\|`QCryptographyException`
`public`	# `__destruct( )` Closes the mcrypt module (Some methods just want to watch the world burn!) Closes the mcrypt module (Some methods just want to watch the world burn!)
`public`	# `__sleep( )`
`public`	# `__wakeup( )`

Methods inherited from QBaseClass
`OverrideAttributes(), __call(), __get(), __set()`

Properties summary
`protected resource`	`$objMcryptModule` Mcrypt algorithm module resource Mcrypt algorithm module resource	#
`protected boolean`	`$blnBase64` Are we going to use Base 64 encoding? Are we going to use Base 64 encoding?	#
`protected string`	`$strKey` Key to be used for encryption/decryption - used for mycrypt_generic_init Key to be used for encryption/decryption - used for mycrypt_generic_init	#
`protected string`	`$strIv` Initialization vector for the algorithm Initialization vector for the algorithm	#
`protected string`	`$strCipher` Cipher to use when creating the encryption object Cipher to use when creating the encryption object	#
`protected string`	`$strMode` Mode to use when creating the encryption object Mode to use when creating the encryption object	#
`protected string`	`$strRandomSource` Random source to use when creating IVs Random source to use when creating IVs	#
`public static string`	`$Base64` Default Base64 mode for any new QCryptography instances that get constructed. This is similar to MIME-based Base64 encoding/decoding, but is safe to use in URLs, POST/GET data, and any other text-based stream. Note that by setting Base64 to true, it will result in an encrypted data string that is 33% larger. Default Base64 mode for any new QCryptography instances that get constructed. This is similar to MIME-based Base64 encoding/decoding, but is safe to use in URLs, POST/GET data, and any other text-based stream. Note that by setting Base64 to true, it will result in an encrypted data string that is 33% larger.	# `true`
`public static string`	`$Key` Default Key for any new QCryptography instances that get constructed Default Key for any new QCryptography instances that get constructed	# `"qc0Do!d3F@lT.k3Y"`

Packages

Classes

Interfaces

Traits

Exceptions

Functions

Class QCryptography

Parameters

Throws

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Throws

Parameters

Returns

Throws