Библиотека шифрования

Библиотека шифрования обеспечивает двустороннее шифрование данных. Для обеспечения криптографической безопасности она использует расширения PHP, которые, к сожалению, не всегда доступны на всех системах. Для использования этой библиотеки необходимо выполнить одно из следующих требований:

• OpenSSL
• MCrypt (и MCRYPT_DEV_URANDOM)

Если ни одно из вышеперечисленных требований не выполнено, мы не можем предложить вам достаточной реализации, отвечающей высоким стандартам надлежащей криптографии.

• Использование библиотеки шифрования
  • Инициализация класса
  • Поведение по умолчанию
  • Установка ключа шифрования
  • Поддерживаемые алгоритмы шифрования и режимы
    • Портабельные алгоритмы шифрования
    • Алгоритмы шифрования, специфичные для драйвера
    • Режимы шифрования
  • Длина сообщения
  • Настройка библиотеки
  • Шифрование и дешифрование данных
    • Как это работает
    • Использование пользовательских параметров
    • Поддерживаемые алгоритмы аутентификации HMAC
• Справочник по классу

Использование библиотеки шифрования

Инициализация класса

Как и большинство других классов в CodeIgniter, библиотека шифрования инициализируется в вашем контроллере с помощью метода $this->load->library():

$this->load->library('encryption');

После загрузки объект библиотеки шифрования будет доступен с помощью:

$this->encryption

Поведение по умолчанию

По умолчанию библиотека шифрования будет использовать алгоритм шифрования AES-128 в режиме CBC, используя настроенный ключ шифрования и аутентификацию SHA512 HMAC.

Однако ключ шифрования не используется напрямую.

Если вы знакомы с криптографией, вам должно быть известно, что HMAC также требует секретного ключа, а использование одного и того же ключа для шифрования и аутентификации — плохая практика.

Поэтому из вашего настроенного ключа шифрования выводятся два отдельных ключа: один для шифрования и один для аутентификации. Это делается с помощью техники, называемой функцией вывода ключа на основе HMAC (HKDF).

Установка ключа шифрования

Ключ шифрования — это информация, которая управляет криптографическим процессом и позволяет шифровать и дешифровать строку простого текста. Это секретный «ингредиент», позволяющий вам быть единственным, кто может дешифровать данные, которые вы решили скрыть от глаз общественности. После использования одного ключа для шифрования данных, этот же ключ обеспечивает **единственный** способ дешифровать его, поэтому его необходимо тщательно выбирать, и вы не должны его терять, так как в этом случае вы также потеряете доступ к данным.

Следует отметить, что для обеспечения максимальной безопасности такой ключ должен быть не только максимально сильным, но и часто меняться. Однако такое поведение редко бывает практичным или возможным для реализации, и поэтому CodeIgniter предоставляет вам возможность настроить единственный ключ, который будет использоваться (почти) каждый раз.

Само собой разумеется, что вы должны тщательно охранять свой ключ. Если кто-то получит доступ к вашему ключу, данные будут легко дешифрованы. Если ваш сервер не полностью находится под вашим контролем, невозможно гарантировать безопасность ключа, поэтому вы можете тщательно обдумать использование ключа для чего-либо, требующего высокой безопасности, например, для хранения номеров кредитных карт.

Ключ шифрования **должен** быть такой длины, как это позволяет используемый алгоритм шифрования. Для AES-128 это 128 бит или 16 байт (символов).

Ниже приведена таблица, в которой показаны поддерживаемые длины ключей различных алгоритмов.

Ключ должен быть максимально случайным и **не должен** быть обычной строкой текста, результатом функции хеширования и т. д. Для создания правильного ключа необходимо использовать метод библиотеки шифрования create_key().

// $key will be assigned a 16-byte (128-bit) random key
$key = $this->encryption->create_key(16);

Ключ можно хранить в файле application/config/config.php или разработать собственную систему хранения и динамически передавать ключ при шифровании/дешифровании.

Чтобы сохранить ключ в application/config/config.php, откройте файл и установите:

$config['encryption_key'] = 'YOUR KEY';

Вы заметите, что метод create_key() выводит двоичные данные, с которыми трудно работать (например, копирование и вставка может повредить их), поэтому можно использовать bin2hex(), hex2bin() или кодирование Base64 для работы с ключом более удобным способом. Например:

// Get a hex-encoded representation of the key:
$key = bin2hex($this->encryption->create_key(16));

// Put the same value in your config with hex2bin(),
// so that it is still passed as binary to the library:
$config['encryption_key'] = hex2bin(<your hex-encoded key>);

Поддерживаемые алгоритмы шифрования и режимы

Портабельные алгоритмы шифрования

Так как MCrypt и OpenSSL (также называемые драйверами в данном документе) поддерживают различные наборы алгоритмов шифрования и часто реализуют их по-разному, наша библиотека шифрования разработана для использования их в портативном режиме, другими словами — она позволяет вам использовать их взаимозаменяемо, по крайней мере, для алгоритмов шифрования, поддерживаемых обоими драйверами.

Она также реализована так, чтобы соответствовать стандартным реализациям в других языках программирования и библиотеках.

Вот список так называемых «портативных» алгоритмов шифрования, где «название в CodeIgniter» — это строковое значение, которое необходимо передать библиотеке шифрования для использования этого алгоритма:

Алгоритмы шифрования, специфичные для драйвера

Как отмечалось выше, MCrypt и OpenSSL поддерживают различные наборы алгоритмов шифрования. Из соображений портативности и потому что мы не провели их надлежащей проверки, мы не рекомендуем использовать алгоритмы, специфичные для драйвера, но, независимо от этого, вот список большинства из них:

Режимы шифрования

Разные режимы шифрования обладают разными характеристиками и служат для разных целей. Некоторые из них сильнее других, некоторые быстрее, а некоторые предлагают дополнительные возможности. Мы не будем углубляться в это здесь, мы оставим это экспертам по криптографии. Таблица ниже предназначена для предоставления краткой справочной информации нашим более опытным пользователям. Если вы новичок, просто придерживайтесь режима CBC — он широко признан сильным и безопасным для общих целей.

Длина сообщения

Вероятно, важно знать, что зашифрованная строка обычно длиннее исходной, открытого текста (в зависимости от шифра). Это зависит от самого алгоритма шифра, IV, предшествующего шифрованному тексту, и сообщения аутентификации HMAC, которое также предшествует. Кроме того, зашифрованное сообщение также кодируется в Base64, чтобы обеспечить безопасность хранения и передачи независимо от используемой кодировки.

Учитывайте эту информацию при выборе механизма хранения данных. Например, файлы cookie могут хранить только 4 КБ информации.

Настройка библиотеки

Для удобства использования, производительности, а также по историческим причинам, связанным с нашим старым классом Encrypt Class, библиотека шифрования разработана для многократного использования одного и того же драйвера, шифра, режима и ключа.

Как отмечено в разделе «Поведение по умолчанию» выше, это означает использование автоматически обнаруженного драйвера (OpenSSL имеет более высокий приоритет), шифра AES-128 в режиме CBC и вашего значения $config['encryption_key']. Однако, если вы хотите изменить это, вам необходимо использовать метод initialize(). Он принимает ассоциативный массив параметров, все из которых являются необязательными:

Например, если вы хотите изменить алгоритм и режим шифрования на AES-256 в режиме CTR, вот что вам нужно сделать:

$this->encryption->initialize(
        array(
                'cipher' => 'aes-256',
                'mode' => 'ctr',
                'key' => '<a 32-character random string>'
        )
);

Обратите внимание, что мы упомянули только о желании изменения шифра и режима, но также включили пример ключа. Как отмечалось ранее, важно выбрать ключ соответствующего размера для используемого алгоритма.

Также есть возможность изменить драйвер, если по какой-то причине у вас есть оба, но вы хотите использовать MCrypt вместо OpenSSL:

// Switch to the MCrypt driver
$this->encryption->initialize(array('driver' => 'mcrypt'));

// Switch back to the OpenSSL driver
$this->encryption->initialize(array('driver' => 'openssl'));

Шифрование и расшифровка данных

Шифрование и расшифровка данных с использованием уже настроенных параметров библиотеки проста. Достаточно просто передать строку в методы encrypt() и/или decrypt().

$plain_text = 'This is a plain-text message!';
$ciphertext = $this->encryption->encrypt($plain_text);

// Outputs: This is a plain-text message!
echo $this->encryption->decrypt($ciphertext);

И это все! Библиотека шифрования сделает все необходимое для того, чтобы весь процесс был криптографически безопасным «из коробки». Вам не нужно беспокоиться об этом.

Как это работает

Если вам нужно знать, как работает процесс, вот что происходит под капотом:

• $this->encryption->encrypt($plain_text)
  1. Извлечь ключ шифрования и ключ HMAC из вашего настроенного encryption_key с помощью HKDF, используя алгоритм хеширования SHA-512.
  2. Сгенерировать случайный вектор инициализации (IV).
  3. Зашифровать данные с помощью AES-128 в режиме CBC (или другого предварительно настроенного шифра и режима), используя полученный ключ шифрования и IV.
  4. Добавить указанный IV к результирующему шифрованному тексту.
  5. Кодировать результирующую строку в Base64, чтобы ее можно было безопасно хранить или передавать, не беспокоясь о кодировках.
  6. Создать сообщение аутентификации HMAC SHA-512, используя полученный ключ HMAC, чтобы обеспечить целостность данных, и добавить его к строке Base64.
• $this->encryption->decrypt($ciphertext)
  1. Извлечь ключ шифрования и ключ HMAC из вашего настроенного encryption_key с помощью HKDF, используя алгоритм хеширования SHA-512. Так как ваш настроенный encryption_key один и тот же, это даст тот же результат, что и в методе encrypt() выше — в противном случае вы не сможете его расшифровать.
  2. Проверить, достаточно ли длинной строка, извлечь HMAC и проверить его корректность (это делается таким образом, чтобы предотвратить атаки на время против него). Вернуть FALSE, если одно из проверок не пройдёт.
  3. Декодировать строку из Base64.
  4. Извлечь IV из шифрованного текста и расшифровать указанный зашифрованный текст, используя этот IV и извлечённый ключ шифрования.

Использование пользовательских параметров

Предположим, вам нужно взаимодействовать с другой системой, которая находится вне вашего контроля и использует другой метод шифрования данных. Метод, который, безусловно, не будет соответствовать вышеописанной последовательности и, вероятно, не будет использовать все шаги.

Библиотека шифрования позволяет изменить работу процессов шифрования и расшифровки, чтобы вы могли легко адаптировать пользовательское решение для таких ситуаций.

Все, что вам нужно сделать, это передать ассоциативный массив с несколькими параметрами в метод encrypt() или decrypt(). Вот пример:

// Assume that we have $ciphertext, $key and $hmac_key
// from on outside source

$message = $this->encryption->decrypt(
        $ciphertext,
        array(
                'cipher' => 'blowfish',
                'mode' => 'cbc',
                'key' => $key,
                'hmac_digest' => 'sha256',
                'hmac_key' => $hmac_key
        )
);

В приведенном выше примере мы расшифровываем сообщение, которое было зашифровано с помощью шифра Blowfish в режиме CBC и аутентифицировано с помощью HMAC SHA-256.

Ниже приведен список доступных параметров.

Однако, если вам это действительно нужно и вы знаете, что делаете, мы рекомендуем не изменять процесс шифрования, так как это может повлиять на безопасность, поэтому делайте это с осторожностью.

Поддерживаемые алгоритмы аутентификации HMAC

Для аутентификации сообщений HMAC библиотека шифрования поддерживает использование алгоритмов семейства SHA-2:

Причина, по которой не включены другие популярные алгоритмы, такие как MD5 или SHA1, заключается в том, что они больше не считаются достаточно безопасными, и поэтому мы не хотим поощрять их использование. Если вам абсолютно необходимо их использовать, это легко сделать с помощью встроенной функции PHP hash_hmac().

Более сильные алгоритмы, конечно, будут добавлены в будущем, по мере их появления и широкого распространения.

Справочник по классам

class CI_Encryption

initialize($params)

Параметры:	$params (array) – Параметры конфигурации
Возвращает:	Экземпляр CI_Encryption (метод цепочки)
Тип возвращаемого значения:	CI_Encryption

Инициализирует (настраивает) библиотеку для использования другого драйвера, алгоритма шифрования, режима или ключа.

Пример:

$this->encryption->initialize(
        array('mode' => 'ctr')
);

Обратитесь к разделу Настройка библиотеки за подробной информацией.

encrypt($data[, $params = NULL])

Параметры:	$data (string) – Данные для шифрования $params (array) – Необязательные параметры
Возвращает:	Зашифрованные данные или FALSE при ошибке
Тип возвращаемого значения:	string

Шифрует входные данные и возвращает зашифрованный текст.

Пример:

$ciphertext = $this->encryption->encrypt('My secret message');

Обратитесь к разделу Использование пользовательских параметров за информацией об необязательных параметрах.

decrypt($data[, $params = NULL])

Параметры:	$data (string) – Данные для дешифрования $params (array) – Необязательные параметры
Возвращает:	Расшифрованные данные или FALSE при ошибке
Тип возвращаемого значения:	string

Дешифрует входные данные и возвращает их в виде простого текста.

Пример:

echo $this->encryption->decrypt($ciphertext);

Обратитесь к разделу Использование пользовательских параметров за информацией об необязательных параметрах.

create_key($length)

Параметры:	$length (int) – Длина вывода
Возвращает:	Псевдослучайный криптографический ключ заданной длины или FALSE при ошибке
Тип возвращаемого значения:	string

Создает криптографический ключ, извлекая случайные данные из источников операционной системы (например, /dev/urandom).

hkdf($key[, $digest = 'sha512'[, $salt = NULL[, $length = NULL[, $info = '']]]])

Параметры:	$key (string) – Входной материал ключа $digest (string) – Алгоритм хеширования семейства SHA-2 $salt (string) – Необязательная соль $length (int) – Необязательная длина вывода $info (string) – Необязательная информация о контексте/приложении
Возвращает:	Псевдослучайный ключ или FALSE при ошибке
Тип возвращаемого значения:	string

Выводит ключ из другого, предположительно более слабого ключа.

Этот метод используется внутри для вывода ключа шифрования и HMAC из вашего настроенного encryption_key.

Он доступен публично из-за его общего назначения. Он описан в RFC 5869.

Однако, в отличие от описания в RFC 5869, эта реализация не поддерживает SHA1.

Пример:

$hmac_key = $this->encryption->hkdf(
        $key,
        'sha512',
        NULL,
        NULL,
        'authentication'
);

// $hmac_key is a pseudo-random key with a length of 64 bytes