Module: LogStash::PluginMixins::HttpClient::DeprecatedSslConfigSupport

Defined in:
lib/logstash/plugin_mixins/http_client/deprecated_ssl_config_support.rb

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.included(base) ⇒ Object 



3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/logstash/plugin_mixins/http_client/deprecated_ssl_config_support.rb', line 3

def self.included(base)
  fail ArgumentError unless base <= LogStash::PluginMixins::HttpClient::Implementation

  require 'logstash/plugin_mixins/normalize_config_support'
  base.include(LogStash::PluginMixins::NormalizeConfigSupport)

  # If you need to use a custom X.509 CA (.pem certs) specify the path to that here
  base.config :cacert, :validate => :path, :deprecated => 'Use `ssl_certificate_authorities` instead'
  # If you'd like to use a client certificate (note, most people don't want this) set the path to the x509 cert here
  base.config :client_cert, :validate => :path, :deprecated => 'Use `ssl_certificate` instead'
  # If you're using a client certificate specify the path to the encryption key here
  base.config :client_key, :validate => :path, :deprecated => 'Use `ssl_key` instead'
  # If you need to use a custom keystore (`.jks`) specify that here. This does not work with .pem keys!
  base.config :keystore, :validate => :path, :deprecated => 'Use `ssl_keystore_path` instead'
  # Specify the keystore password here.
  # Note, most .jks files created with keytool require a password!
  base.config :keystore_password, :validate => :password, :deprecated => 'Use `ssl_keystore_password` instead'
  # Specify the keystore type here. One of `JKS` or `PKCS12`. Default is `JKS`
  base.config :keystore_type, :validate => :string, :default => 'JKS', :deprecated => 'Use `ssl_keystore_type` instead'
  # If you need to use a custom truststore (`.jks`) specify that here. This does not work with .pem certs!
  base.config :truststore, :validate => :path, :deprecated => 'Use `ssl_truststore_path` instead'
  # Specify the truststore password here.
  # Note, most .jks files created with keytool require a password!
  base.config :truststore_password, :validate => :password, :deprecated => 'Use `ssl_truststore_password` instead'
  # Specify the truststore type here. One of `JKS` or `PKCS12`. Default is `JKS`
  base.config :truststore_type, :validate => :string, :default => 'JKS', :deprecated => 'Use `ssl_truststore_type` instead'
  # NOTE: the default setting [] uses Java SSL engine defaults.
end

Instance Method Details

#initialize(*a) ⇒ Object 



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/logstash/plugin_mixins/http_client/deprecated_ssl_config_support.rb', line 32

def initialize(*a)
  super

  @ssl_certificate_authorities = normalize_config(:ssl_certificate_authorities) do |normalize|
    normalize.with_deprecated_mapping(:cacert) do |cacert|
      [cacert]
    end
  end

  @ssl_certificate = normalize_config(:ssl_certificate) do |normalize|
    normalize.with_deprecated_alias(:client_cert)
  end

  @ssl_key = normalize_config(:ssl_key) do |normalize|
    normalize.with_deprecated_alias(:client_key)
  end

  %w[keystore truststore].each do |store|
    %w[path type password].each do |variable|
      config_name = "ssl_#{store}_#{variable}"
      normalized_value = normalize_config(config_name) do |normalize|
        deprecated_config_alias = variable == 'path' ? store : "#{store}_#{variable}"
        normalize.with_deprecated_alias(deprecated_config_alias.to_sym)
      end
      instance_variable_set("@#{config_name}", normalized_value)
    end
  end
end

#ssl_options ⇒ Object 



61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/logstash/plugin_mixins/http_client/deprecated_ssl_config_support.rb', line 61

def ssl_options
  fail(InvalidHTTPConfigError, "When `client_cert` is provided, `client_key` must also be provided") if @client_cert && !@client_key
  fail(InvalidHTTPConfigError, "A `client_key` is not allowed unless a `client_cert` is provided") if @client_key && !@client_cert

  fail(LogStash::ConfigurationError, "When `keystore` is provided, `keystore_password` must also be provided") if @keystore && !@keystore_password
  fail(LogStash::ConfigurationError, "A `keystore_password` is not allowed unless a `keystore` is provided") if @keystore_password && !@keystore

  fail(LogStash::ConfigurationError, "When `truststore` is provided, `truststore_password` must also be provided") if @truststore && !@truststore_password
  fail(LogStash::ConfigurationError, "A `truststore_password` is not allowed unless a `truststore` is provided") if @truststore_password && !@truststore

  super
end