logstash-output-opensearch 1.0.0-java

data/spec/unit/outputs/opensearch_ssl_spec.rb

@@ -0,0 +1,179 @@
+# SPDX-License-Identifier: Apache-2.0
+#
+#  The OpenSearch Contributors require contributions made to
+#  this file be licensed under the Apache-2.0 license or a
+#  compatible open source license.
+#
+#  Modifications Copyright OpenSearch Contributors. See
+#  GitHub history for details.
+
+require_relative "../../../spec/spec_helper"
+require 'stud/temporary'
+
+describe "SSL option" do
+  let(:manticore_double) { double("manticoreSSL #{self.inspect}") }
+  before do
+    allow(manticore_double).to receive(:close)
+    
+    response_double = double("manticore response").as_null_object
+    # Allow healtchecks
+    allow(manticore_double).to receive(:head).with(any_args).and_return(response_double)
+    allow(manticore_double).to receive(:get).with(any_args).and_return(response_double)
+    
+    allow(::Manticore::Client).to receive(:new).and_return(manticore_double)
+  end
+  
+  context "when using ssl without cert verification" do
+    subject do
+      require "logstash/outputs/opensearch"
+      settings = {
+        "hosts" => "localhost",
+        "ssl" => true,
+        "ssl_certificate_verification" => false,
+        "pool_max" => 1,
+        "pool_max_per_route" => 1
+      }
+      LogStash::Outputs::OpenSearch.new(settings)
+    end
+    
+    after do
+      subject.close
+    end
+    
+    it "should pass the flag to the OpenSearch client" do
+      expect(::Manticore::Client).to receive(:new) do |args|
+        expect(args[:ssl]).to eq(:enabled => true, :verify => false)
+      end.and_return(manticore_double)
+      
+      subject.register
+    end
+
+    it "should print a warning" do
+      disabled_matcher = /You have enabled encryption but DISABLED certificate verification/
+      expect(subject.logger).to receive(:warn).with(disabled_matcher).at_least(:once)
+      allow(subject.logger).to receive(:warn).with(any_args)
+      
+      subject.register
+      allow(LogStash::Outputs::OpenSearch::HttpClient::Pool).to receive(:start)
+    end
+  end
+
+  context "when using ssl with client certificates" do
+    let(:keystore_path) { Stud::Temporary.file.path }
+    before do
+      `openssl req -x509  -batch -nodes -newkey rsa:2048 -keyout lumberjack.key -out #{keystore_path}.pem`
+    end
+
+    after :each do
+      File.delete(keystore_path)
+      subject.close
+    end
+
+    subject do
+      require "logstash/outputs/opensearch"
+      settings = {
+        "hosts" => "node01",
+        "ssl" => true,
+        "cacert" => keystore_path,
+      }
+      next LogStash::Outputs::OpenSearch.new(settings)
+    end
+
+    it "should pass the keystore parameters to the OpenSearch client" do
+      expect(::Manticore::Client).to receive(:new) do |args|
+        expect(args[:ssl]).to include(:keystore => keystore_path, :keystore_password => "test")
+      end.and_call_original
+      subject.register
+    end
+
+  end
+
+  context "when using ssl with client certificates and key" do
+    let(:tls_certificate) { Stud::Temporary.file.path }
+    let(:tls_key) { Stud::Temporary.file.path }
+    before do
+      `openssl req -x509  -batch -nodes -newkey rsa:2048 -keyout #{tls_key} -out #{tls_certificate}`
+    end
+
+    after :each do
+      File.delete(tls_key)
+      File.delete(tls_certificate)
+      subject.close
+    end
+
+    subject do
+      require "logstash/outputs/opensearch"
+      settings = {
+        "hosts" => "node01",
+        "ssl" => true,
+        "tls_certificate" => tls_certificate,
+        "tls_key" => tls_key
+      }
+      next LogStash::Outputs::OpenSearch.new(settings)
+    end
+
+    it "should pass the tls certificate parameters to the OpenSearch client" do
+      expect(::Manticore::Client).to receive(:new) do |args|
+        expect(args[:ssl]).to include(:client_cert => tls_certificate, :client_key => tls_key)
+      end.and_call_original
+      subject.register
+    end
+
+  end
+
+  context "passing only tls certificate but missing the key" do
+    let(:tls_certificate) { Stud::Temporary.file.path }
+    let(:tls_key) { Stud::Temporary.file.path }
+    before do
+      `openssl req -x509  -batch -nodes -newkey rsa:2048 -keyout #{tls_key} -out #{tls_certificate}`
+    end
+
+    after :each do
+      File.delete(tls_key)
+      File.delete(tls_certificate)
+      subject.close
+    end
+
+    subject do
+      settings = {
+        "hosts" => "node01",
+        "ssl" => true,
+        "tls_certificate" => tls_certificate,
+      }
+      next LogStash::Outputs::OpenSearch.new(settings)
+    end
+
+    it "should not load plugin" do
+      expect { subject.register }.to raise_error(LogStash::ConfigurationError)
+    end
+  end
+
+  context "passing only tls key but missing the certificate" do
+    let(:tls_certificate) { Stud::Temporary.file.path }
+    let(:tls_key) { Stud::Temporary.file.path }
+    before do
+      `openssl req -x509  -batch -nodes -newkey rsa:2048 -keyout #{tls_key} -out #{tls_certificate}`
+    end
+
+    after :each do
+      File.delete(tls_key)
+      File.delete(tls_certificate)
+      subject.close
+    end
+
+    subject do
+      settings = {
+        "hosts" => "node01",
+        "ssl" => true,
+        "tls_key" => tls_key,
+      }
+      next LogStash::Outputs::OpenSearch.new(settings)
+    end
+
+    it "should not load plugin" do
+      expect { subject.register }.to raise_error(LogStash::ConfigurationError)
+    end
+  end
+
+
+end

metadata

@@ -0,0 +1,289 @@
+--- !ruby/object:Gem::Specification
+name: logstash-output-opensearch
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: java
+authors:
+- Elastic
+- OpenSearch Contributors
+autorequire:
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDfDCCAmSgAwIBAgIBATANBgkqhkiG9w0BAQUFADBCMRMwEQYDVQQDDApvcGVu
+  c2VhcmNoMRYwFAYKCZImiZPyLGQBGRYGYW1hem9uMRMwEQYKCZImiZPyLGQBGRYD
+  Y29tMB4XDTIxMDgwMjIxMDQwM1oXDTIyMDgwMjIxMDQwM1owQjETMBEGA1UEAwwK
+  b3BlbnNlYXJjaDEWMBQGCgmSJomT8ixkARkWBmFtYXpvbjETMBEGCgmSJomT8ixk
+  ARkWA2NvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAM1z3/jcitjV
+  umXwRFn+JSBBd36qZB54Dtucf6+E2fmNPzBRhgYN5XJy/+clQJ9NIJV7C8H52P3V
+  dsce/VXcNAcgfUdlN57nM0ksjFFNlnHWXea8Ub9/6R1K0p1RBizEINzUneoJLvqe
+  7w/KfvBJStj7AmJgZmzCiu98j75YLcdLhZQykRyJdB03wZsMQUvxPFkhTZn+Qi8k
+  0U909l9JD0i1PC0xVukYlskUA2xeo36kMMllABJGN536Z0aIT2KX2XTiKK7hILoP
+  +flNmgA4eyXa5Ki9q4HBN6QhsTKdEinqGngQnUI35YTu2AHsvfjn1wP/nUa9aRVH
+  zfR37/NQFkECAwEAAaN9MHswCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0O
+  BBYEFJJ2myhLXK742btavNbG0IWrMNBIMCAGA1UdEQQZMBeBFW9wZW5zZWFyY2hA
+  YW1hem9uLmNvbTAgBgNVHRIEGTAXgRVvcGVuc2VhcmNoQGFtYXpvbi5jb20wDQYJ
+  KoZIhvcNAQEFBQADggEBAE7gBP5ecTtKb04qmEsnbJ6+yn0LUSmxPabFBnB6h1+T
+  XW8BvBw9MpE//5fQf4HSia3m9XjRpl4WxBcJiyfLER64tk/c1JLhV2+rq3CCV/be
+  DFSP6gY93kK7jwauajGQvyHzORaW1TBM6diIRYCMLY7Isf+PTHl0xhZZBSVm8wl6
+  IstV+mTP2KC1l7hSzUDb4rrOSnpRB7AEczcDdkjwzHKIlw8rcL+PLLnFTOgqKyq3
+  yXikuH6LEVykA8pgOcB9gKsB2/zMd2ZlSj2monM8Qw9EfB14ZSDTYS8VYuwWCeF0
+  eFmXXk0ufQFKl1Yll7quHkmQ0PzKkvXTpONBT6qPkXE=
+  -----END CERTIFICATE-----
+date: 2021-08-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.4
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  name: manticore
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.4
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.17
+  name: stud
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.17
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.60'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '2.99'
+  name: logstash-core-plugin-api
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.60'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '2.99'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  name: logstash-mixin-ecs_compatibility_support
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: logstash-codec-plain
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: logstash-devutils
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: flores
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  name: cabin
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+description: This gem is a Logstash plugin required to be installed on top of the
+  Logstash core pipeline using $LS_HOME/bin/logstash-plugin install gem. This gem
+  is not a stand-alone program
+email: opensearch@amazon.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ADMINS.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- DEVELOPER_GUIDE.md
+- Gemfile
+- LICENSE
+- MAINTAINERS.md
+- NOTICE
+- README.md
+- RELEASING.md
+- SECURITY.md
+- lib/logstash/outputs/opensearch.rb
+- lib/logstash/outputs/opensearch/distribution_checker.rb
+- lib/logstash/outputs/opensearch/http_client.rb
+- lib/logstash/outputs/opensearch/http_client/manticore_adapter.rb
+- lib/logstash/outputs/opensearch/http_client/pool.rb
+- lib/logstash/outputs/opensearch/http_client_builder.rb
+- lib/logstash/outputs/opensearch/template_manager.rb
+- lib/logstash/outputs/opensearch/templates/ecs-disabled/1x.json
+- lib/logstash/outputs/opensearch/templates/ecs-disabled/7x.json
+- lib/logstash/plugin_mixins/opensearch/api_configs.rb
+- lib/logstash/plugin_mixins/opensearch/common.rb
+- lib/logstash/plugin_mixins/opensearch/noop_distribution_checker.rb
+- logstash-output-opensearch.gemspec
+- spec/fixtures/_nodes/nodes.json
+- spec/fixtures/htpasswd
+- spec/fixtures/nginx_reverse_proxy.conf
+- spec/fixtures/scripts/painless/scripted_update.painless
+- spec/fixtures/scripts/painless/scripted_update_nested.painless
+- spec/fixtures/scripts/painless/scripted_upsert.painless
+- spec/integration/outputs/compressed_indexing_spec.rb
+- spec/integration/outputs/create_spec.rb
+- spec/integration/outputs/delete_spec.rb
+- spec/integration/outputs/index_spec.rb
+- spec/integration/outputs/index_version_spec.rb
+- spec/integration/outputs/ingest_pipeline_spec.rb
+- spec/integration/outputs/metrics_spec.rb
+- spec/integration/outputs/no_opensearch_on_startup_spec.rb
+- spec/integration/outputs/painless_update_spec.rb
+- spec/integration/outputs/parent_spec.rb
+- spec/integration/outputs/retry_spec.rb
+- spec/integration/outputs/routing_spec.rb
+- spec/integration/outputs/sniffer_spec.rb
+- spec/integration/outputs/templates_spec.rb
+- spec/integration/outputs/update_spec.rb
+- spec/opensearch_spec_helper.rb
+- spec/spec_helper.rb
+- spec/unit/http_client_builder_spec.rb
+- spec/unit/outputs/error_whitelist_spec.rb
+- spec/unit/outputs/opensearch/http_client/manticore_adapter_spec.rb
+- spec/unit/outputs/opensearch/http_client/pool_spec.rb
+- spec/unit/outputs/opensearch/http_client_spec.rb
+- spec/unit/outputs/opensearch/template_manager_spec.rb
+- spec/unit/outputs/opensearch_proxy_spec.rb
+- spec/unit/outputs/opensearch_spec.rb
+- spec/unit/outputs/opensearch_ssl_spec.rb
+homepage: https://opensearch.org/
+licenses:
+- Apache-2.0
+metadata:
+  logstash_plugin: 'true'
+  logstash_group: output
+  source_code_uri: https://github.com/opensearch-project/logstash-output-opensearch
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.7.10
+signing_key:
+specification_version: 4
+summary: Stores logs in OpenSearch
+test_files:
+- spec/fixtures/_nodes/nodes.json
+- spec/fixtures/htpasswd
+- spec/fixtures/nginx_reverse_proxy.conf
+- spec/fixtures/scripts/painless/scripted_update.painless
+- spec/fixtures/scripts/painless/scripted_update_nested.painless
+- spec/fixtures/scripts/painless/scripted_upsert.painless
+- spec/integration/outputs/compressed_indexing_spec.rb
+- spec/integration/outputs/create_spec.rb
+- spec/integration/outputs/delete_spec.rb
+- spec/integration/outputs/index_spec.rb
+- spec/integration/outputs/index_version_spec.rb
+- spec/integration/outputs/ingest_pipeline_spec.rb
+- spec/integration/outputs/metrics_spec.rb
+- spec/integration/outputs/no_opensearch_on_startup_spec.rb
+- spec/integration/outputs/painless_update_spec.rb
+- spec/integration/outputs/parent_spec.rb
+- spec/integration/outputs/retry_spec.rb
+- spec/integration/outputs/routing_spec.rb
+- spec/integration/outputs/sniffer_spec.rb
+- spec/integration/outputs/templates_spec.rb
+- spec/integration/outputs/update_spec.rb
+- spec/opensearch_spec_helper.rb
+- spec/spec_helper.rb
+- spec/unit/http_client_builder_spec.rb
+- spec/unit/outputs/error_whitelist_spec.rb
+- spec/unit/outputs/opensearch/http_client/manticore_adapter_spec.rb
+- spec/unit/outputs/opensearch/http_client/pool_spec.rb
+- spec/unit/outputs/opensearch/http_client_spec.rb
+- spec/unit/outputs/opensearch/template_manager_spec.rb
+- spec/unit/outputs/opensearch_proxy_spec.rb
+- spec/unit/outputs/opensearch_spec.rb
+- spec/unit/outputs/opensearch_ssl_spec.rb