модуль OpenSSL
OpenSSL предоставляет SSL, TLS и криптографию общего назначения. Он оборачивает библиотеку OpenSSL.
Примеры
Все примеры предполагают, что вы загрузили OpenSSL с помощью:
require 'openssl'
Эти примеры строятся друг на друге. Например, ключ, созданный в следующем примере, используется во всех этих примерах.
Ключи
Создание ключа
Этот пример создаёт пару ключей RSA размером 2048 бит и сохраняет её в текущем каталоге.
key = OpenSSL::PKey::RSA.new 2048 open 'private_key.pem', 'w' do |io| io.write key.to_pem end open 'public_key.pem', 'w' do |io| io.write key.public_key.to_pem end
Экспорт ключа
Ключи, сохранённые на диске без шифрования, небезопасны, так как любой, получивший ключ, может его использовать, если он не зашифрован. Для безопасного экспорта ключа можно экспортировать его с фразой доступа.
cipher = OpenSSL::Cipher.new 'aes-256-cbc' pass_phrase = 'my secure pass phrase goes here' key_secure = key.export cipher, pass_phrase open 'private.secure.pem', 'w' do |io| io.write key_secure end
OpenSSL::Cipher.ciphers возвращает список доступных шифров.
Загрузка ключа
Ключ также можно загрузить из файла.
key2 = OpenSSL::PKey.read File.read 'private_key.pem' key2.public? # => true key2.private? # => true
или
key3 = OpenSSL::PKey.read File.read 'public_key.pem' key3.public? # => true key3.private? # => false
Загрузка зашифрованного ключа
OpenSSL попросит вас ввести фразу доступа при загрузке зашифрованного ключа. Если вы не сможете ввести фразу доступа, вы можете предоставить её при загрузке ключа:
key4_pem = File.read 'private.secure.pem' pass_phrase = 'my secure pass phrase goes here' key4 = OpenSSL::PKey.read key4_pem, pass_phrase
Шифрование RSA
RSA предоставляет шифрование и дешифрование с использованием открытого и закрытого ключей. Вы можете использовать различные методы заполнения в зависимости от предполагаемого использования зашифрованных данных.
Шифрование и дешифрование
Асимметричное шифрование с открытым/закрытым ключом медленное и подвержено атакам в случаях, когда оно используется без заполнения или непосредственно для шифрования больших блоков данных. Типичные случаи использования шифрования RSA включают «обёртку» симметричного ключа с открытым ключом получателя, который «развернёт» этот симметричный ключ снова с помощью своего закрытого ключа. Однако, на практике не следует использовать этот упрощённый пример схемы переноса ключей. Вместо этого всегда следует предпочитать стандартные протоколы.
wrapped_key = key.public_encrypt key
Симметричный ключ, зашифрованный с помощью открытого ключа, может быть расшифрован только с помощью соответствующего закрытого ключа получателя.
original_key = key.private_decrypt wrapped_key
По умолчанию используется заполнение PKCS#1, но также можно использовать и другие виды заполнения, см. PKey::RSA для получения дополнительной информации.
Подписи
Использование «private_encrypt» для шифрования данных с помощью закрытого ключа эквивалентно применению цифровой подписи к данным. Проверяющая сторона может проверить подпись, сравнив результат расшифровки подписи с помощью «public_decrypt» с исходными данными. Однако, OpenSSL::PKey уже имеет методы «sign» и «verify», которые обрабатывают цифровые подписи стандартным способом — «private_encrypt» и «public_decrypt» на практике использовать не следует.
Для подписи документа сначала вычисляется криптографически безопасный хэш документа, который затем подписывается с помощью закрытого ключа.
signature = key.sign 'SHA256', document
Для проверки подписи снова вычисляется хэш документа, а подпись расшифровывается с помощью открытого ключа. Результат сравнивается с только что вычисленным хэшем; если они совпадают, подпись была действительной.
if key.verify 'SHA256', signature, document puts 'Valid' else puts 'Invalid' end
PBKDF2 Шифрование, основанное на пароле
Если это поддерживается используемой версией OpenSSL, шифрование, основанное на пароле, должно использовать возможности PKCS5. Если это не поддерживается или требуется legacy приложениями, поддерживаются также более старые, менее безопасные методы, указанные в RFC 2898 (см. ниже).
PKCS5 поддерживает PBKDF2, как это было указано в PKCS#5 v2.0. Он по-прежнему использует пароль, соль и, дополнительно, количество итераций, которое замедляет процесс вывода ключа. Чем медленнее это происходит, тем больше работы требуется для подбора ключа.
Шифрование
Стратегия заключается в том, чтобы сначала инициализировать Cipher для шифрования, а затем сгенерировать случайный IV и ключ, выведенный из пароля с помощью PBKDF2. PKCS #5 v2.0 рекомендует использовать не менее 8 байт для соли, количество итераций в значительной степени зависит от используемого оборудования.
cipher = OpenSSL::Cipher.new 'aes-256-cbc'
cipher.encrypt
iv = cipher.random_iv
pwd = 'some hopefully not to easily guessable password'
salt = OpenSSL::Random.random_bytes 16
iter = 20000
key_len = cipher.key_len
digest = OpenSSL::Digest.new('SHA256')
key = OpenSSL::PKCS5.pbkdf2_hmac(pwd, salt, iter, key_len, digest)
cipher.key = key
Now encrypt the data:
encrypted = cipher.update document
encrypted << cipher.final Расшифровка
Используйте те же шаги, что и раньше, для вывода симметричного ключа AES, на этот раз настроив Cipher для дешифрования.
cipher = OpenSSL::Cipher.new 'aes-256-cbc'
cipher.decrypt
cipher.iv = iv # the one generated with #random_iv
pwd = 'some hopefully not to easily guessable password'
salt = ... # the one generated above
iter = 20000
key_len = cipher.key_len
digest = OpenSSL::Digest.new('SHA256')
key = OpenSSL::PKCS5.pbkdf2_hmac(pwd, salt, iter, key_len, digest)
cipher.key = key
Now decrypt the data:
decrypted = cipher.update encrypted
decrypted << cipher.final PKCS #5 Шифрование, основанное на пароле
PKCS #5 — это стандарт шифрования, основанного на пароле, описанный в RFC2898. Он позволяет использовать короткий пароль или фразу доступа для создания защищённого ключа шифрования. Если это возможно, следует использовать PBKDF2, как описано выше, если это позволяют обстоятельства.
PKCS #5 использует Cipher, фразу доступа и соль для генерации ключа шифрования.
pass_phrase = 'my secure pass phrase goes here' salt = '8 octets'
Шифрование
Сначала настройте шифр для шифрования
encryptor = OpenSSL::Cipher.new 'aes-256-cbc' encryptor.encrypt encryptor.pkcs5_keyivgen pass_phrase, salt
Затем передайте данные, которые вы хотите зашифровать
encrypted = encryptor.update 'top secret document' encrypted << encryptor.final
Расшифровка
Используйте новый экземпляр Cipher, настроенный для дешифрования
decryptor = OpenSSL::Cipher.new 'aes-256-cbc' decryptor.decrypt decryptor.pkcs5_keyivgen pass_phrase, salt
Затем передайте данные, которые вы хотите расшифровать
plain = decryptor.update encrypted plain << decryptor.final
Сертификаты
Создание сертификата
Этот пример создаёт самоподписанный сертификат с использованием ключа RSA и подписи SHA1.
key = OpenSSL::PKey::RSA.new 2048 name = OpenSSL::X509::Name.parse '/CN=nobody/DC=example' cert = OpenSSL::X509::Certificate.new cert.version = 2 cert.serial = 0 cert.not_before = Time.now cert.not_after = Time.now + 3600 cert.public_key = key.public_key cert.subject = name
Расширения сертификата
Вы можете добавить расширения к сертификату с помощью OpenSSL::SSL::ExtensionFactory, чтобы указать назначение сертификата.
extension_factory = OpenSSL::X509::ExtensionFactory.new nil, cert
cert.add_extension \
extension_factory.create_extension('basicConstraints', 'CA:FALSE', true)
cert.add_extension \
extension_factory.create_extension(
'keyUsage', 'keyEncipherment,dataEncipherment,digitalSignature')
cert.add_extension \
extension_factory.create_extension('subjectKeyIdentifier', 'hash')
Список поддерживаемых расширений (и в некоторых случаях их возможных значений) можно получить из файла «objects.h» в исходном коде OpenSSL.
Подписание сертификата
Для подписания сертификата задайте издателя и используйте OpenSSL::X509::Certificate#sign с алгоритмом дайджеста. Это создаёт самоподписанный сертификат, поскольку мы используем одно и то же имя и ключ для подписания сертификата, что и для его создания.
cert.issuer = name
cert.sign key, OpenSSL::Digest.new('SHA1')
open 'certificate.pem', 'w' do |io| io.write cert.to_pem end
Загрузка сертификата
Как и ключ, сертификат также можно загрузить из файла.
cert2 = OpenSSL::X509::Certificate.new File.read 'certificate.pem'
Проверка сертификата
Certificate#verify вернёт true, когда сертификат был подписан заданным открытым ключом.
raise 'certificate can not be verified' unless cert2.verify key
Центр сертификации
Центр сертификации (ЦС) — это доверенная третья сторона, которая позволяет вам проверять владение неизвестными сертификатами. ЦС выдает подписи ключей, указывающие на то, что он доверяет пользователю этого ключа. Пользователь, столкнувшийся с ключом, может проверить подпись, используя открытый ключ ЦС.
Ключ ЦС
Ключи ЦС ценны, поэтому мы шифруем и сохраняем их на диске, а также убеждаемся, что они недоступны другим пользователям.
ca_key = OpenSSL::PKey::RSA.new 2048 pass_phrase = 'my secure pass phrase goes here' cipher = OpenSSL::Cipher.new 'aes-256-cbc' open 'ca_key.pem', 'w', 0400 do |io| io.write ca_key.export(cipher, pass_phrase) end
Сертификат ЦС
Сертификат ЦС создаётся так же, как и сертификат выше, но с другими расширениями.
ca_name = OpenSSL::X509::Name.parse '/CN=ca/DC=example'
ca_cert = OpenSSL::X509::Certificate.new
ca_cert.serial = 0
ca_cert.version = 2
ca_cert.not_before = Time.now
ca_cert.not_after = Time.now + 86400
ca_cert.public_key = ca_key.public_key
ca_cert.subject = ca_name
ca_cert.issuer = ca_name
extension_factory = OpenSSL::X509::ExtensionFactory.new
extension_factory.subject_certificate = ca_cert
extension_factory.issuer_certificate = ca_cert
ca_cert.add_extension \
extension_factory.create_extension('subjectKeyIdentifier', 'hash')
Это расширение указывает, что ключ ЦС может использоваться как ЦС.
ca_cert.add_extension \
extension_factory.create_extension('basicConstraints', 'CA:TRUE', true)
Это расширение указывает, что ключ ЦС может использоваться для проверки подписей как на сертификатах, так и на отзывах сертификатов.
ca_cert.add_extension \
extension_factory.create_extension(
'keyUsage', 'cRLSign,keyCertSign', true)
Корневые сертификаты ЦС самоподписанные.
ca_cert.sign ca_key, OpenSSL::Digest.new('SHA1')
Сертификат ЦС сохраняется на диске, чтобы его можно было распространить всем пользователям ключей, которые он будет подписывать.
open 'ca_cert.pem', 'w' do |io| io.write ca_cert.to_pem end
Запрос на подписание сертификата
ЦС подписывает ключи через запрос на подписание сертификата (CSR). CSR содержит информацию, необходимую для идентификации ключа.
csr = OpenSSL::X509::Request.new
csr.version = 0
csr.subject = name
csr.public_key = key.public_key
csr.sign key, OpenSSL::Digest.new('SHA1')
CSR сохраняется на диске и отправляется в ЦС для подписания.
open 'csr.pem', 'w' do |io| io.write csr.to_pem end
Создание сертификата из CSR
При получении CSR ЦС проверяет его перед подписанием. Минимальная проверка — это проверка подписи CSR.
csr = OpenSSL::X509::Request.new File.read 'csr.pem' raise 'CSR can not be verified' unless csr.verify csr.public_key
После проверки создаётся сертификат, помеченный для различных применений, подписанный ключом ЦС и возвращённый запросившему.
csr_cert = OpenSSL::X509::Certificate.new
csr_cert.serial = 0
csr_cert.version = 2
csr_cert.not_before = Time.now
csr_cert.not_after = Time.now + 600
csr_cert.subject = csr.subject
csr_cert.public_key = csr.public_key
csr_cert.issuer = ca_cert.subject
extension_factory = OpenSSL::X509::ExtensionFactory.new
extension_factory.subject_certificate = csr_cert
extension_factory.issuer_certificate = ca_cert
csr_cert.add_extension \
extension_factory.create_extension('basicConstraints', 'CA:FALSE')
csr_cert.add_extension \
extension_factory.create_extension(
'keyUsage', 'keyEncipherment,dataEncipherment,digitalSignature')
csr_cert.add_extension \
extension_factory.create_extension('subjectKeyIdentifier', 'hash')
csr_cert.sign ca_key, OpenSSL::Digest.new('SHA1')
open 'csr_cert.pem', 'w' do |io|
io.write csr_cert.to_pem
end
SSL и TLS-соединения
Используя созданные нами ключ и сертификат, мы можем создать SSL или TLS-соединение. SSLContext используется для настройки SSL сессии.
context = OpenSSL::SSL::SSLContext.new
SSL Сервер
Для безопасного взаимодействия с клиентами SSL серверу необходим сертификат и закрытый ключ:
context.cert = cert context.key = key
Затем создайте SSLServer с сокетом TCP-сервера и контекстом. Используйте SSLServer как обычный TCP-сервер.
require 'socket'
tcp_server = TCPServer.new 5000
ssl_server = OpenSSL::SSL::SSLServer.new tcp_server, context
loop do
ssl_connection = ssl_server.accept
data = ssl_connection.gets
response = "I got #{data.dump}"
puts response
ssl_connection.puts "I got #{data.dump}"
ssl_connection.close
end
SSL клиент
Клиент SSL создаётся с помощью TCP-соккета и контекста. Необходимо вызвать SSLSocket#connect, чтобы инициировать SSL рукопожатие и начать шифрование. Для сокета клиента ключ и сертификат не требуются.
Обратите внимание, что SSLSocket#close по умолчанию не закрывает подлежащий сокет. Установите SSLSocket#sync_close в true, если вам это нужно.
require 'socket' tcp_socket = TCPSocket.new 'localhost', 5000 ssl_client = OpenSSL::SSL::SSLSocket.new tcp_socket, context ssl_client.sync_close = true ssl_client.connect ssl_client.puts "hello server!" puts ssl_client.gets ssl_client.close # shutdown the TLS connection and close tcp_socket
Проверка псевдонима
Непроверенное SSL соединение не обеспечивает достаточной безопасности. Для повышения безопасности клиент или сервер может проверить сертификат своего псевдонима.
Клиент может быть изменён для проверки сертификата сервера по отношению к сертификату центра сертификации:
context.ca_file = 'ca_cert.pem' context.verify_mode = OpenSSL::SSL::VERIFY_PEER require 'socket' tcp_socket = TCPSocket.new 'localhost', 5000 ssl_client = OpenSSL::SSL::SSLSocket.new tcp_socket, context ssl_client.connect ssl_client.puts "hello server!" puts ssl_client.gets
Если сертификат сервера недействителен или context.ca_file не установлено при проверке псевдонимов, будет поднято исключение OpenSSL::SSL::SSLError.
Константы
- OPENSSL_FIPS
-
Логическое значение, указывающее, поддерживает ли
OpenSSLстандарт FIPS или нет - OPENSSL_LIBRARY_VERSION
- OPENSSL_VERSION
-
Версия
OpenSSL, с которой был скомпилирован модуль расширения RubyOpenSSL - OPENSSL_VERSION_NUMBER
-
Номер версии
OpenSSL, с которой был скомпилирован модуль расширения RubyOpenSSL(в шестнадцатеричной системе) - VERSION
Публичные методы класса
# File ext/openssl/lib/openssl/digest.rb, line 67 def Digest(name) OpenSSL::Digest.const_get(name) end
Возвращает подкласс Digest по имени
require 'openssl'
OpenSSL::Digest("MD5")
# => OpenSSL::Digest::MD5
Digest("Foo")
# => NameError: wrong constant name Foo
static VALUE
ossl_debug_get(VALUE self)
{
return dOSSL;
} static VALUE
ossl_debug_set(VALUE self, VALUE val)
{
dOSSL = RTEST(val) ? Qtrue : Qfalse;
return val;
} Включает или выключает режим отладки. В режиме отладки все ошибки, добавленные в очередь ошибок OpenSSL, будут выводиться в stderr.
VALUE
ossl_get_errors(VALUE _)
{
VALUE ary;
long e;
ary = rb_ary_new();
while ((e = ERR_get_error()) != 0){
rb_ary_push(ary, rb_str_new2(ERR_error_string(e, NULL)));
}
return ary;
} Просмотр оставшихся ошибок в очереди.
Любые ошибки, которые вы здесь видите, вероятно, являются ошибкой в реализации Ruby OpenSSL.
static VALUE
ossl_fips_mode_get(VALUE self)
{
#ifdef OPENSSL_FIPS
VALUE enabled;
enabled = FIPS_mode() ? Qtrue : Qfalse;
return enabled;
#else
return Qfalse;
#endif
} static VALUE
ossl_fips_mode_set(VALUE self, VALUE enabled)
{
#ifdef OPENSSL_FIPS
if (RTEST(enabled)) {
int mode = FIPS_mode();
if(!mode && !FIPS_mode_set(1)) /* turning on twice leads to an error */
ossl_raise(eOSSLError, "Turning on FIPS mode failed");
} else {
if(!FIPS_mode_set(0)) /* turning off twice is OK */
ossl_raise(eOSSLError, "Turning off FIPS mode failed");
}
return enabled;
#else
if (RTEST(enabled))
ossl_raise(eOSSLError, "This version of OpenSSL does not support FIPS mode");
return enabled;
#endif
} Включает или выключает режим FIPS. Включение режима FIPS будет иметь эффект только для установок OpenSSL с поддержкой FIPS. Попытка сделать это в противном случае приведёт к ошибке.
Примеры
OpenSSL.fips_mode = true # turn FIPS mode on OpenSSL.fips_mode = false # and off again
static VALUE
ossl_crypto_fixed_length_secure_compare(VALUE dummy, VALUE str1, VALUE str2)
{
const unsigned char *p1 = (const unsigned char *)StringValuePtr(str1);
const unsigned char *p2 = (const unsigned char *)StringValuePtr(str2);
long len1 = RSTRING_LEN(str1);
long len2 = RSTRING_LEN(str2);
if (len1 != len2) {
ossl_raise(rb_eArgError, "inputs must be of equal length");
}
switch (CRYPTO_memcmp(p1, p2, len1)) {
case 0: return Qtrue;
default: return Qfalse;
}
} Сравнение памяти с постоянным временем для строк фиксированной длины, таких как результаты расчётов HMAC.
Возвращает true если строки идентичны, false если они имеют одинаковую длину, но не идентичны. Если длины различаются, ArgumentError.
static VALUE
mem_check_start(VALUE self)
{
CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ON);
return Qnil;
} Вызывает CRYPTO_mem_ctrl(CRYPTO_MEM_CHECK_ON). Начинает отслеживание выделения памяти. См. также OpenSSL.print_mem_leaks.
Доступно только при компиляции с совместимой библиотекой OpenSSL и опцией конфигурации –enable-debug.
static VALUE
print_mem_leaks(VALUE self)
{
#if OPENSSL_VERSION_NUMBER >= 0x10100000
int ret;
#endif
#ifndef HAVE_RB_EXT_RACTOR_SAFE
// for Ruby 2.x
void ossl_bn_ctx_free(void); // ossl_bn.c
ossl_bn_ctx_free();
#endif
#if OPENSSL_VERSION_NUMBER >= 0x10100000
ret = CRYPTO_mem_leaks_fp(stderr);
if (ret < 0)
ossl_raise(eOSSLError, "CRYPTO_mem_leaks_fp");
return ret ? Qfalse : Qtrue;
#else
CRYPTO_mem_leaks_fp(stderr);
return Qnil;
#endif
} Для отладки библиотеки Ruby/OpenSSL. Вызывает CRYPTO_mem_leaks_fp(stderr). Выводит обнаруженные утечки памяти в стандартную ошибку. Это очищает глобальное состояние, поэтому вы не можете использовать какие-либо методы библиотеки после вызова этой функции.
Возвращает true если утечки обнаружены, false в противном случае.
Доступно только при компиляции с совместимой библиотекой OpenSSL и опцией конфигурации –enable-debug.
Пример
OpenSSL.mem_check_start
NOT_GCED = OpenSSL::PKey::RSA.new(256)
END {
GC.start
OpenSSL.print_mem_leaks # will print the leakage
}
# File ext/openssl/lib/openssl.rb, line 32
def self.secure_compare(a, b)
hashed_a = OpenSSL::Digest.digest('SHA256', a)
hashed_b = OpenSSL::Digest.digest('SHA256', b)
OpenSSL.fixed_length_secure_compare(hashed_a, hashed_b) && a == b
end Сравнение памяти с постоянным временем. Входные данные хешируются с помощью SHA-256 для маскирования длины секрета. Возвращает true если строки идентичны, false в противном случае.
Приватные методы экземпляра
# File ext/openssl/lib/openssl/digest.rb, line 67 def Digest(name) OpenSSL::Digest.const_get(name) end
Возвращает подкласс Digest по имени
require 'openssl'
OpenSSL::Digest("MD5")
# => OpenSSL::Digest::MD5
Digest("Foo")
# => NameError: wrong constant name Foo
Ruby Core © 1993–2022 Yukihiro Matsumoto
Licensed under the Ruby License.
Ruby Standard Library © contributors
Licensed under their own licenses.