Skip to content
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.

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

out_forward: Separate parameter names for certificates #2190

Merged
merged 2 commits into from
Nov 27, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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/fluent/plugin/out_forward.rb
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,8 @@ class ConnectionClosedError < Error; end
config_param :tls_verify_hostname, :bool, default: true
desc 'The additional CA certificate path for TLS.'
config_param :tls_ca_cert_path, :array, value_type: :string, default: nil
config_param :tls_cert_path, :array, value_type: :string, default: nil, deprecated: "Use tls_ca_cert_path instead"
desc 'The additional certificate path for TLS.'
config_param :tls_cert_path, :array, value_type: :string, default: nil

config_section :security, required: false, multi: false do
desc 'The hostname'
Expand Down Expand Up @@ -167,7 +168,7 @@ def configure(conf)
end

if @transport == :tls
# for backward compatibility
# socket helper adds CA cert or signed certificate to same cert store internally so unify it in this place.
if @tls_cert_path && !@tls_cert_path.empty?
@tls_ca_cert_path = @tls_cert_path
end
Expand Down
11 changes: 5 additions & 6 deletions test/plugin/test_out_forward.rb
Original file line number Diff line number Diff line change
Expand Up @@ -157,25 +157,24 @@ def read_ack_from_sock(sock, unpacker)
assert{ logs.any?{|log| log.include?(expected_log) && log.include?(expected_detail) } }
end

test 'configure tls_cert_path is deprecated' do
data('CA cert' => 'tls_ca_cert_path',
'non CA cert' => 'tls_cert_path')
test 'configure tls_cert_path/tls_ca_cert_path' do |param|
dummy_cert_path = File.join(TMP_DIR, "dummy_cert.pem")
FileUtils.touch(dummy_cert_path)
conf = %[
send_timeout 5
transport tls
tls_insecure_mode true
tls_cert_path #{dummy_cert_path}
#{param} #{dummy_cert_path}
<server>
host #{TARGET_HOST}
port #{TARGET_PORT}
</server>
]

@d = d = create_driver(conf)
expected_log = "'tls_cert_path' parameter is deprecated: Use tls_ca_cert_path instead"
logs = d.logs
assert{ logs.any?{|log| log.include?(expected_log) } }
assert_equal([dummy_cert_path], d.instance.tls_cert_path)
# In the plugin, tls_ca_cert_path is used for both cases
assert_equal([dummy_cert_path], d.instance.tls_ca_cert_path)
end

Expand Down