Skip to content

Allow OpenSSL::SSL::SSLContext#max_version to be set on SSL connections #984

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Allow OpenSSL::SSL::SSLContext#max_version to be set on SSL connections #984

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions lib/kafka/client.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ def initialize(seed_brokers:, client_id: "ruby-kafka", logger: nil, connect_time
sasl_aws_msk_iam_secret_key_id: nil,
sasl_aws_msk_iam_aws_region: nil,
sasl_aws_msk_iam_session_token: nil,
sasl_over_ssl: true, ssl_ca_certs_from_system: false, partitioner: nil, sasl_oauth_token_provider: nil, ssl_verify_hostname: true,
sasl_over_ssl: true, ssl_ca_certs_from_system: false, partitioner: nil, sasl_oauth_token_provider: nil, ssl_verify_hostname: true, ssl_max_version: nil,
resolve_seed_brokers: false)
@logger = TaggedLogger.new(logger)
@instrumenter = Instrumenter.new(client_id: client_id)
Expand All @@ -104,7 +104,8 @@ def initialize(seed_brokers:, client_id: "ruby-kafka", logger: nil, connect_time
client_cert_key_password: ssl_client_cert_key_password,
client_cert_chain: ssl_client_cert_chain,
ca_certs_from_system: ssl_ca_certs_from_system,
verify_hostname: ssl_verify_hostname
verify_hostname: ssl_verify_hostname,
max_version: ssl_max_version
)

sasl_authenticator = SaslAuthenticator.new(
Expand Down
4 changes: 3 additions & 1 deletion lib/kafka/ssl_context.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ module Kafka
module SslContext
CLIENT_CERT_DELIMITER = "\n-----END CERTIFICATE-----\n"

def self.build(ca_cert_file_path: nil, ca_cert: nil, client_cert: nil, client_cert_key: nil, client_cert_key_password: nil, client_cert_chain: nil, ca_certs_from_system: nil, verify_hostname: true)
def self.build(ca_cert_file_path: nil, ca_cert: nil, client_cert: nil, client_cert_key: nil, client_cert_key_password: nil, client_cert_chain: nil, ca_certs_from_system: nil, verify_hostname: true, max_version: nil)
return nil unless ca_cert_file_path || ca_cert || client_cert || client_cert_key || client_cert_key_password || client_cert_chain || ca_certs_from_system

ssl_context = OpenSSL::SSL::SSLContext.new
Expand Down Expand Up @@ -60,6 +60,8 @@ def self.build(ca_cert_file_path: nil, ca_cert: nil, client_cert: nil, client_ce
# Verify certificate hostname if supported (ruby >= 2.4.0)
ssl_context.verify_hostname = verify_hostname if ssl_context.respond_to?(:verify_hostname=)

ssl_context.max_version = max_version if max_version

ssl_context
end
end
Expand Down
13 changes: 13 additions & 0 deletions spec/ssl_context_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,4 +61,17 @@
expect(subject.extra_chain_cert).to eq expected_chain
end
end

context 'with max version specified' do
let(:client_cert) { IO.read("spec/fixtures/client_cert.pem") }
let(:client_cert_key) { IO.read("spec/fixtures/client_cert_key.pem") }
let(:max_version) { OpenSSL::SSL::TLS1_2_VERSION }

subject { Kafka::SslContext.build(client_cert: client_cert, client_cert_key: client_cert_key, max_version: max_version) }

it 'configures max version' do
# OpenSSL::SSL::SSLContext doesn't provide public method to read this attribute
expect(subject.instance_variable_get(:@max_proto_version)).to eq(max_version)
end
end
end