CodeIgniter v3.0.0 API
\

\CI_Encrypt

CodeIgniter Encryption Class

Provides two-way keyed encoding using Mcrypt

Summary

Methods
Properties
Constants
__construct()
get_key()
set_key()
encode()
decode()
encode_from_legacy()
mcrypt_encode()
mcrypt_decode()
set_cipher()
set_mode()
set_hash()
hash()
$encryption_key
No constants found
_xor_decode()
_xor_merge()
_add_cipher_noise()
_remove_cipher_noise()
_get_cipher()
_get_mode()
strlen()
substr()
$_hash_type
$_mcrypt_exists
$_mcrypt_cipher
$_mcrypt_mode
N/A
No private methods found
No private properties found
N/A

Properties

$encryption_key

$encryption_key : string

Reference to the user's encryption key

Type

string

$_hash_type

$_hash_type : string

Type of hash operation

Type

string

$_mcrypt_exists

$_mcrypt_exists : boolean

Flag for the existence of mcrypt

Type

boolean

$_mcrypt_cipher

$_mcrypt_cipher : string

Current cipher to be used with mcrypt

Type

string

$_mcrypt_mode

$_mcrypt_mode : integer

Method for encrypting/decrypting data

Type

integer

Methods

__construct()

__construct() : void

Initialize Encryption class

get_key()

get_key(  $key = '') : string

Fetch the encryption key

Returns it as MD5 in order to have an exact-length 128 bit key. Mcrypt is sensitive to keys that are not the correct length

Parameters

$key

Returns

string

set_key()

set_key(  $key = '') : \CI_Encrypt

Set the encryption key

Parameters

$key

Returns

\CI_Encrypt

encode()

encode(  $string,   $key = '') : string

Encode

Encodes the message string using bitwise XOR encoding. The key is combined with a random hash, and then it too gets converted using XOR. The whole thing is then run through mcrypt using the randomized key. The end result is a double-encrypted message string that is randomized with each call to this function, even if the supplied message and key are the same.

Parameters

$string
$key

Returns

string

decode()

decode(  $string,   $key = '') : string

Decode

Reverses the above process

Parameters

$string
$key

Returns

string

encode_from_legacy()

encode_from_legacy(  $string,   $legacy_mode = MCRYPT_MODE_ECB,   $key = '') : string

Encode from Legacy

Takes an encoded string from the original Encryption class algorithms and returns a newly encoded string using the improved method added in 2.0.0 This allows for backwards compatibility and a method to transition to the new encryption algorithms.

For more details, see https://codeigniter.com/user_guide/installation/upgrade_200.html#encryption

Parameters

$string
$legacy_mode
$key

Returns

string

mcrypt_encode()

mcrypt_encode(  $data,   $key) : string

Encrypt using Mcrypt

Parameters

$data
$key

Returns

string

mcrypt_decode()

mcrypt_decode(  $data,   $key) : string

Decrypt using Mcrypt

Parameters

$data
$key

Returns

string

set_cipher()

set_cipher(  $cipher) : \CI_Encrypt

Set the Mcrypt Cipher

Parameters

$cipher

Returns

\CI_Encrypt

set_mode()

set_mode(  $mode) : \CI_Encrypt

Set the Mcrypt Mode

Parameters

$mode

Returns

\CI_Encrypt

set_hash()

set_hash(  $type = 'sha1') : void

Set the Hash type

Parameters

$type

hash()

hash(  $str) : string

Hash encode a string

Parameters

$str

Returns

string

_xor_decode()

_xor_decode(  $string,   $key) : string

XOR Decode

Takes an encoded string and key as input and generates the plain-text original message

Parameters

$string
$key

Returns

string

_xor_merge()

_xor_merge(  $string,   $key) : string

XOR key + string Combiner

Takes a string and key as input and computes the difference using XOR

Parameters

$string
$key

Returns

string

_add_cipher_noise()

_add_cipher_noise(  $data,   $key) : string

Adds permuted noise to the IV + encrypted data to protect against Man-in-the-middle attacks on CBC mode ciphers http://www.ciphersbyritter.com/GLOSSARY.HTM#IV

Parameters

$data
$key

Returns

string

_remove_cipher_noise()

_remove_cipher_noise(string  $data, string  $key) : string

Removes permuted noise from the IV + encrypted data, reversing _add_cipher_noise()

Function description

Parameters

string $data
string $key

Returns

string

_get_cipher()

_get_cipher() : integer

Get Mcrypt cipher Value

Returns

integer

_get_mode()

_get_mode() : integer

Get Mcrypt Mode Value

Returns

integer

strlen()

strlen(string  $str) : integer

Byte-safe strlen()

Parameters

string $str

Returns

integer

substr()

substr(string  $str, integer  $start, integer  $length = NULL) : string

Byte-safe substr()

Parameters

string $str
integer $start
integer $length

Returns

string