CodeIgniter v3.0.0 API
\

\CI_Encryption

CodeIgniter Encryption Class

Provides two-way keyed encryption via PHP's MCrypt and/or OpenSSL extensions.

Summary

Methods
Properties
Constants
__construct()
initialize()
create_key()
encrypt()
decrypt()
hkdf()
__get()
No public properties found
No constants found
_mcrypt_initialize()
_openssl_initialize()
_mcrypt_encrypt()
_openssl_encrypt()
_mcrypt_decrypt()
_openssl_decrypt()
_get_params()
_mcrypt_get_handle()
_openssl_get_handle()
_cipher_alias()
strlen()
substr()
$_cipher
$_mode
$_handle
$_key
$_driver
$_drivers
$_modes
$_digests
$func_overload
N/A
No private methods found
No private properties found
N/A

Properties

$_cipher

$_cipher : string

Encryption cipher

Type

string

$_mode

$_mode : string

Cipher mode

Type

string

$_handle

$_handle : mixed

Cipher handle

Type

mixed

$_key

$_key : string

Encryption key

Type

string

$_driver

$_driver : string

PHP extension to be used

Type

string

$_drivers

$_drivers : array

List of usable drivers (PHP extensions)

Type

array

$_modes

$_modes : array

List of available modes

Type

array

$_digests

$_digests : array

List of supported HMAC algorithms

name => digest size pairs

Type

array

$func_overload

$func_overload : boolean

mbstring.func_overload flag

Type

boolean

Methods

__construct()

__construct(array  $params = array()) : void

Class constructor

Parameters

array $params

Configuration parameters

initialize()

initialize(array  $params) : \CI_Encryption

Initialize

Parameters

array $params

Configuration parameters

Returns

\CI_Encryption

create_key()

create_key(integer  $length) : string

Create a random key

Parameters

integer $length

Output length

Returns

string

encrypt()

encrypt(string  $data, array  $params = NULL) : string

Encrypt

Parameters

string $data

Input data
array $params

Input parameters

Returns

string

decrypt()

decrypt(string  $data, array  $params = NULL) : string

Decrypt

Parameters

string $data

Encrypted data
array $params

Input parameters

Returns

string

hkdf()

hkdf(  $key,   $digest = 'sha512',   $salt = NULL,   $length = NULL,   $info = '') : string

HKDF

Parameters

$key

Input key
$digest

A SHA-2 hashing algorithm
$salt

Optional salt
$length

Output length (defaults to the selected digest size)
$info

Optional context/application-specific info

Returns

string —

A pseudo-random key

__get()

__get(string  $key) : mixed

__get() magic

Parameters

string $key

Property name

Returns

mixed

_mcrypt_initialize()

_mcrypt_initialize(array  $params) : void

Initialize MCrypt

Parameters

array $params

Configuration parameters

_openssl_initialize()

_openssl_initialize(array  $params) : void

Initialize OpenSSL

Parameters

array $params

Configuration parameters

_mcrypt_encrypt()

_mcrypt_encrypt(string  $data, array  $params) : string

Encrypt via MCrypt

Parameters

string $data

Input data
array $params

Input parameters

Returns

string

_openssl_encrypt()

_openssl_encrypt(string  $data, array  $params) : string

Encrypt via OpenSSL

Parameters

string $data

Input data
array $params

Input parameters

Returns

string

_mcrypt_decrypt()

_mcrypt_decrypt(string  $data, array  $params) : string

Decrypt via MCrypt

Parameters

string $data

Encrypted data
array $params

Input parameters

Returns

string

_openssl_decrypt()

_openssl_decrypt(string  $data, array  $params) : string

Decrypt via OpenSSL

Parameters

string $data

Encrypted data
array $params

Input parameters

Returns

string

_get_params()

_get_params(array  $params) : array

Get params

Parameters

array $params

Input parameters

Returns

array

_mcrypt_get_handle()

_mcrypt_get_handle(string  $cipher, string  $mode) : resource

Get MCrypt handle

Parameters

string $cipher

Cipher name
string $mode

Encryption mode

Returns

resource

_openssl_get_handle()

_openssl_get_handle(string  $cipher, string  $mode) : string

Get OpenSSL handle

Parameters

string $cipher

Cipher name
string $mode

Encryption mode

Returns

string

_cipher_alias()

_cipher_alias(string  $cipher) : void

Cipher alias

Tries to translate cipher names between MCrypt and OpenSSL's "dialects".

Parameters

string $cipher

Cipher name

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