PHP Класс CI_Encryption, TastyIgniter

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

См. ссылку: https://codeigniter.com/user_guide/libraries/encryption.html

Автор: Andrey Andreev

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство	Тип	Описание
$_cipher	string	Encryption cipher
$_digests	array	name => digest size pairs
$_driver	string	PHP extension to be used
$_drivers	array	List of usable drivers (PHP extensions)
$_handle	mixed	Cipher handle
$_key	string	Encryption key
$_mode	string	Cipher mode
$_modes	array	List of available modes
$func_override	boolean	mbstring.func_override flag

Открытые методы

Метод	Описание
__construct ( array $params = [] ) : void	Class constructor
__get ( string $key ) : mixed	__get() magic
create_key ( integer $length ) : string	Create a random key
decrypt ( string $data, array $params = NULL ) : string	Decrypt
encrypt ( string $data, array $params = NULL ) : string	Encrypt
hkdf ( $key, $digest = 'sha512', $salt = NULL, $length = NULL, $info = '' ) : string	HKDF
initialize ( array $params ) : CI_Encryption	Initialize

Защищенные методы

Метод	Описание
_cipher_alias ( string &$cipher ) : void	Cipher alias
_get_params ( array $params ) : array	Get params
_mcrypt_decrypt ( string $data, array $params ) : string	Decrypt via MCrypt
_mcrypt_encrypt ( string $data, array $params ) : string	Encrypt via MCrypt
_mcrypt_get_handle ( string $cipher, string $mode ) : resource	Get MCrypt handle
_mcrypt_initialize ( array $params ) : void	Initialize MCrypt
_openssl_decrypt ( string $data, array $params ) : string	Decrypt via OpenSSL
_openssl_encrypt ( string $data, array $params ) : string	Encrypt via OpenSSL
_openssl_get_handle ( string $cipher, string $mode ) : string	Get OpenSSL handle
_openssl_initialize ( array $params ) : void	Initialize OpenSSL
strlen ( string $str ) : integer	Byte-safe strlen()
substr ( string $str, integer $start, integer $length = NULL ) : string	Byte-safe substr()

Описание методов

__construct() публичный Метод

Class constructor

public __construct ( array $params = [] ) : void
$params	array	Configuration parameters
Результат	void

__get() публичный Метод

__get() magic

public __get ( string $key ) : mixed
$key	string	Property name
Результат	mixed

_cipher_alias() защищенный Метод

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

protected _cipher_alias ( string &$cipher ) : void
$cipher	string	Cipher name
Результат	void

_get_params() защищенный Метод

Get params

protected _get_params ( array $params ) : array
$params	array	Input parameters
Результат	array

_mcrypt_decrypt() защищенный Метод

Decrypt via MCrypt

protected _mcrypt_decrypt ( string $data, array $params ) : string
$data	string	Encrypted data
$params	array	Input parameters
Результат	string

_mcrypt_encrypt() защищенный Метод

Encrypt via MCrypt

protected _mcrypt_encrypt ( string $data, array $params ) : string
$data	string	Input data
$params	array	Input parameters
Результат	string

_mcrypt_get_handle() защищенный Метод

Get MCrypt handle

protected _mcrypt_get_handle ( string $cipher, string $mode ) : resource
$cipher	string	Cipher name
$mode	string	Encryption mode
Результат	resource

_mcrypt_initialize() защищенный Метод

Initialize MCrypt

protected _mcrypt_initialize ( array $params ) : void
$params	array	Configuration parameters
Результат	void

_openssl_decrypt() защищенный Метод

Decrypt via OpenSSL

protected _openssl_decrypt ( string $data, array $params ) : string
$data	string	Encrypted data
$params	array	Input parameters
Результат	string

_openssl_encrypt() защищенный Метод

Encrypt via OpenSSL

protected _openssl_encrypt ( string $data, array $params ) : string
$data	string	Input data
$params	array	Input parameters
Результат	string

_openssl_get_handle() защищенный Метод

Get OpenSSL handle

protected _openssl_get_handle ( string $cipher, string $mode ) : string
$cipher	string	Cipher name
$mode	string	Encryption mode
Результат	string

_openssl_initialize() защищенный Метод

Initialize OpenSSL

protected _openssl_initialize ( array $params ) : void
$params	array	Configuration parameters
Результат	void

create_key() публичный Метод

Create a random key

public create_key ( integer $length ) : string
$length	integer	Output length
Результат	string

decrypt() публичный Метод

Decrypt

public decrypt ( string $data, array $params = NULL ) : string
$data	string	Encrypted data
$params	array	Input parameters
Результат	string

encrypt() публичный Метод

Encrypt

public encrypt ( string $data, array $params = NULL ) : string
$data	string	Input data
$params	array	Input parameters
Результат	string

hkdf() публичный Метод

HKDF

См. ссылку: https://tools.ietf.org/rfc/rfc5869.txt

public hkdf ( $key, $digest = 'sha512', $salt = NULL, $length = NULL, $info = '' ) : string
$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
Результат	string	A pseudo-random key

initialize() публичный Метод

Initialize

public initialize ( array $params ) : CI_Encryption
$params	array	Configuration parameters
Результат	CI_Encryption

strlen() защищенный статический Метод

Byte-safe strlen()

protected static strlen ( string $str ) : integer
$str	string
Результат	integer

substr() защищенный статический Метод

Byte-safe substr()

protected static substr ( string $str, integer $start, integer $length = NULL ) : string
$str	string
$start	integer
$length	integer
Результат	string

Описание свойств

$_cipher защищенное свойство

Encryption cipher

protected string $_cipher
Результат	string

$_digests защищенное свойство

name => digest size pairs

protected array $_digests
Результат	array

$_driver защищенное свойство

PHP extension to be used

protected string $_driver
Результат	string

$_drivers защищенное свойство

List of usable drivers (PHP extensions)

protected array $_drivers
Результат	array

$_handle защищенное свойство

Cipher handle

protected mixed $_handle
Результат	mixed

$_key защищенное свойство

Encryption key

protected string $_key
Результат	string

$_mode защищенное свойство

Cipher mode

protected string $_mode
Результат	string

$_modes защищенное свойство

List of available modes

protected array $_modes
Результат	array

$func_override защищенное статическое свойство

mbstring.func_override flag

protected static bool $func_override
Результат	boolean