logstash-input-http 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 032fe90380dce11dd20661a8aac9084aeaf1d98c
+  data.tar.gz: 4d54c4885e13df803bb65be27fadab2ffce058dc
+SHA512:
+  metadata.gz: bc1a5f6af20ffee231471deb4f3f424c60891053acdb89d9b6c88e53c5775874af31451322f812631e1ec7d1a8522692a51647b9ab34a4dc349b20a4972a073b
+  data.tar.gz: d6f67bf01ae8bc102de7eb14bb877a03daacb99d27367e4805343540d5f8ad8d778ac1bfc74b45982a68c5fe3f5ffe8916ebd4f9e95591583c3e193cda6472eb

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+Gemfile.lock
+Gemfile.bak
+.bundle
+vendor

data/DEVELOPER.md

@@ -0,0 +1 @@
+# logstash-input-http

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2012–2015 Elasticsearch <http://www.elastic.co>
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,86 @@
+# Logstash Plugin
+
+This is a plugin for [Logstash](https://github.com/elasticsearch/logstash).
+
+It is fully free and fully open source. The license is Apache 2.0, meaning you are pretty much free to use it however you want in whatever way.
+
+## Documentation
+
+Logstash provides infrastructure to automatically generate documentation for this plugin. We use the asciidoc format to write documentation so any comments in the source code will be first converted into asciidoc and then into html. All plugin documentation are placed under one [central location](http://www.elasticsearch.org/guide/en/logstash/current/).
+
+- For formatting code or config example, you can use the asciidoc `[source,ruby]` directive
+- For more asciidoc formatting tips, see the excellent reference here https://github.com/elasticsearch/docs#asciidoc-guide
+
+## Need Help?
+
+Need help? Try #logstash on freenode IRC or the https://discuss.elastic.co/c/logstash discussion forum.
+
+## Developing
+
+### 1. Plugin Developement and Testing
+
+#### Code
+- To get started, you'll need JRuby with the Bundler gem installed.
+
+- Create a new plugin or clone and existing from the GitHub [logstash-plugins](https://github.com/logstash-plugins) organization. We also provide [example plugins](https://github.com/logstash-plugins?query=example).
+
+- Install dependencies
+```sh
+bundle install
+```
+
+#### Test
+
+- Update your dependencies
+
+```sh
+bundle install
+```
+
+- Run tests
+
+```sh
+bundle exec rspec
+```
+
+### 2. Running your unpublished Plugin in Logstash
+
+#### 2.1 Run in a local Logstash clone
+
+- Edit Logstash `Gemfile` and add the local plugin path, for example:
+```ruby
+gem "logstash-filter-awesome", :path => "/your/local/logstash-filter-awesome"
+```
+- Install plugin
+```sh
+bin/plugin install --no-verify
+```
+- Run Logstash with your plugin
+```sh
+bin/logstash -e 'filter {awesome {}}'
+```
+At this point any modifications to the plugin code will be applied to this local Logstash setup. After modifying the plugin, simply rerun Logstash.
+
+#### 2.2 Run in an installed Logstash
+
+You can use the same **2.1** method to run your plugin in an installed Logstash by editing its `Gemfile` and pointing the `:path` to your local plugin development directory or you can build the gem and install it using:
+
+- Build your plugin gem
+```sh
+gem build logstash-filter-awesome.gemspec
+```
+- Install the plugin from the Logstash home
+```sh
+bin/plugin install /your/local/plugin/logstash-filter-awesome.gem
+```
+- Start Logstash and proceed to test the plugin
+
+## Contributing
+
+All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.
+
+Programming is not a required skill. Whatever you've seen about open source and maintainers or community members  saying "send patches or die" - you will not see that here.
+
+It is more important to the community that you are able to contribute.
+
+For more information about contributing, see the [CONTRIBUTING](https://github.com/elasticsearch/logstash/blob/master/CONTRIBUTING.md) file.

data/Rakefile

@@ -0,0 +1 @@
+require "logstash/devutils/rake"

data/lib/logstash/inputs/http.rb

@@ -0,0 +1,137 @@
+# encoding: utf-8
+require "logstash/inputs/base"
+require "logstash/namespace"
+require "stud/interval"
+require "socket" # for Socket.gethostname
+require "puma/server"
+require "puma/minissl"
+
+class Puma::Server
+  # ensure this method doesn't mess up our vanilla request
+  def normalize_env(env, client); end
+end
+
+# This output opens a web server and listens to HTTP requests,
+# converting them to LogStash::Event instances.
+#
+class LogStash::Inputs::Http < LogStash::Inputs::Base
+  config_name "http"
+
+  # If undefined, Logstash will complain, even if codec is unused.
+  default :codec, "plain"
+
+  # Which host or ip to bind to
+  config :host, :validate => :string, :default => "0.0.0.0"
+
+  # Which TCP port to bind to
+  config :port, :validate => :number, :default => 8080
+
+  # Maximum number of threads to use
+  config :threads, :validate => :number, :default => 4
+
+  # Basic Auth
+  config :user, :validate => :string, :required => false
+  config :password, :validate => :password, :required => false
+
+  # SSL Configurations
+  #
+  # Enable SSL
+  config :ssl, :validate => :boolean, :default => false
+
+  # The JKS keystore to validate the client's certificates
+  config :keystore, :validate => :path
+
+  #TODO: config :cacert, :validate => :path
+
+  # Set the truststore password
+  config :keystore_password, :validate => :password
+
+  # here you can describe how to decode specific content-types
+  # by default the default codec will be used
+  config :additional_codecs, :validate => :hash, :default => { "application/json" => "json" }
+
+  # useless headers puma adds to the requests
+  # mostly due to rack compliance
+  REJECTED_HEADERS = ["puma.socket", "rack.hijack?", "rack.hijack", "rack.url_scheme", "rack.after_reply", "rack.version", "rack.errors", "rack.multithread", "rack.multiprocess", "rack.run_once", "SCRIPT_NAME", "QUERY_STRING", "SERVER_PROTOCOL", "SERVER_SOFTWARE", "GATEWAY_INTERFACE"]
+
+  RESPONSE_HEADERS = {'Content-Type' => 'text/plain'}
+
+  public
+  def register
+    @server = ::Puma::Server.new(nil) # we'll set the rack handler later
+    if @user && @password then
+      token = Base64.strict_encode64("#{@user}:#{@password.value}")
+      @auth_token = "Basic #{token}"
+    end
+    if @ssl
+      if @keystore.nil? || @keystore_password.nil?
+        raise(LogStash::ConfigurationError, "Settings :keystore and :keystore_password are required because :ssl is enabled.")
+      end
+      ctx = Puma::MiniSSL::Context.new
+      ctx.keystore = @keystore
+      ctx.keystore_pass = @keystore_password.value
+      @server.add_ssl_listener(@host, @port, ctx)
+    else
+      @server.add_tcp_listener(@host, @port)
+    end
+    @server.min_threads = 0
+    @server.max_threads = @threads
+    @codecs = Hash.new
+    @additional_codecs.each do |content_type, codec|
+      @codecs[content_type] = LogStash::Plugin.lookup("codec", codec).new
+    end
+  end # def register
+
+  def run(queue)
+
+    # proc needs to be defined at this context
+    # to capture @codecs, @logger and lowercase_keys
+    p = Proc.new do |req|
+      begin
+        REJECTED_HEADERS.each {|k| req.delete(k) }
+        req = lowercase_keys(req)
+        body = req.delete("rack.input")
+        @codecs.fetch(req["content_type"], @codec).decode(body.read) do |event|
+          event["headers"] = req
+          decorate(event)
+          queue << event
+        end
+        ['200', RESPONSE_HEADERS, ['ok']]
+      rescue => e
+        @logger.error("unable to process event #{req.inspect}. exception => #{e.inspect}")
+        ['500', RESPONSE_HEADERS, ['internal error']]
+      end
+    end
+
+    auth = Proc.new do |username, password|
+      username == @user && password == @password.value
+    end if (@user && @password)
+
+    @server.app = Rack::Builder.new do
+      use(Rack::Auth::Basic, &auth) if auth
+      run(p)
+    end
+    @server.run.join
+  end
+
+  private
+  def lowercase_keys(hash)
+    new_hash = {}
+    hash.each_pair do |k,v|
+      new_hash[k.downcase] = v
+    end
+    new_hash
+  end
+
+  public
+  def teardown
+    if @server
+      @server.stop(true)
+      begin
+        @server.binder.close if @server.binder
+      rescue IOError
+      end
+    end
+  end
+
+end # class LogStash::Inputs::Http

data/logstash-input-http.gemspec

@@ -0,0 +1,29 @@
+Gem::Specification.new do |s|
+  s.name = 'logstash-input-http'
+  s.version         = '0.0.1'
+  s.licenses = ['Apache License (2.0)']
+  s.summary = "Logstash Input plugin that receives HTTP requests"
+  s.description = "This gem is a logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not a stand-alone program"
+  s.authors = ["Elastic"]
+  s.email = 'info@elastic.co'
+  s.homepage = "http://www.elastic.co/guide/en/logstash/current/index.html"
+  s.require_paths = ["lib"]
+
+  # Files
+  s.files = `git ls-files`.split($\)
+   # Tests
+  s.test_files = s.files.grep(%r{^(test|spec|features)/})
+
+  # Special flag to let us know this is actually a logstash plugin
+  s.metadata = { "logstash_plugin" => "true", "logstash_group" => "input" }
+
+  # Gem dependencies
+  s.add_runtime_dependency "logstash-core", '>= 1.4.0', '< 2.0.0'
+  s.add_runtime_dependency 'logstash-codec-plain'
+  s.add_runtime_dependency 'stud'
+  s.add_runtime_dependency 'puma'
+
+  s.add_development_dependency 'logstash-devutils'
+  s.add_development_dependency 'logstash-codec-json'
+  s.add_development_dependency 'ftw'
+end

data/spec/inputs/http_spec.rb

@@ -0,0 +1,139 @@
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/inputs/http"
+require "json"
+require "ftw"
+require "stud/temporary"
+
+describe LogStash::Inputs::Http do
+
+  let(:agent) { FTW::Agent.new }
+  let(:queue) { Queue.new }
+
+  after :each do
+    subject.teardown
+  end
+
+  context "with default codec" do
+    subject { LogStash::Inputs::Http.new }
+    context "when receiving a text/plain request" do
+      it "should process the request normally" do
+        subject.register
+        Thread.new { subject.run(queue) }
+        agent.post!("http://localhost:8080/meh.json",
+                    :headers => { "content-type" => "text/plain" },
+                    :body => "hello")
+        event = queue.pop
+        expect(event["message"]).to eq("hello")
+      end
+    end
+    context "when receiving an application/json request" do
+      it "should parse the json body" do
+        subject.register
+        Thread.new { subject.run(queue) }
+        agent.post!("http://localhost:8080/meh.json",
+                    :headers => { "content-type" => "application/json" },
+                    :body => { "message_body" => "Hello" }.to_json)
+        event = queue.pop
+        expect(event["message_body"]).to eq("Hello")
+      end
+    end
+  end
+
+  context "with json codec" do
+    subject { LogStash::Inputs::Http.new("codec" => "json") }
+    it "should parse the json body" do
+      subject.register
+      Thread.new { subject.run(queue) }
+      agent.post!("http://localhost:8080/meh.json", :body => { "message" => "Hello" }.to_json)
+      event = queue.pop
+      expect(event["message"]).to eq("Hello")
+    end
+  end
+
+  context "when using a custom codec mapping" do
+    subject { LogStash::Inputs::Http.new("additional_codecs" => { "application/json" => "plain" }) }
+    it "should decode the message accordingly" do
+      body = { "message" => "Hello" }.to_json
+      subject.register
+      Thread.new { subject.run(queue) }
+      agent.post!("http://localhost:8080/meh.json",
+                  :headers => { "content-type" => "application/json" },
+                  :body => body)
+      event = queue.pop
+      expect(event["message"]).to eq(body)
+    end
+  end
+
+  context "with :ssl => false" do
+    subject { LogStash::Inputs::Http.new("ssl" => false) }
+    it "should not raise exception" do
+      expect { subject.register }.to_not raise_exception
+    end
+  end
+  context "with :ssl => true" do
+    context "without :keystore and :keystore_password" do
+      subject { LogStash::Inputs::Http.new("ssl" => true) }
+      it "should raise exception" do
+        expect { subject.register }.to raise_exception(LogStash::ConfigurationError)
+      end
+    end
+    context "with :keystore and :keystore_password" do
+      let(:keystore) { Stud::Temporary.file }
+      subject { LogStash::Inputs::Http.new("ssl" => true,
+                                           "keystore" => keystore.path,
+                                           "keystore_password" => "pass") }
+      it "should not raise exception" do
+        expect { subject.register }.to_not raise_exception
+      end
+    end
+  end
+  describe "basic auth" do
+    user = "test"; password = "pwd"
+    subject { LogStash::Inputs::Http.new("user" => user, "password" => password) }
+    let(:auth_token) { Base64.strict_encode64("#{user}:#{password}") }
+    before :each do
+      subject.register
+      Thread.new { subject.run(queue) }
+    end
+    context "when client doesn't present auth token" do
+      let!(:response) { agent.post!("http://localhost:8080/meh", :body => "hi") }
+      it "should respond with 401" do
+        expect(response.status).to eq(401)
+      end
+      it "should not generate an event" do
+        expect(queue).to be_empty
+      end
+    end
+    context "when client presents incorrect auth token" do
+      let!(:response) do
+        agent.post!("http://localhost:8080/meh",
+                    :headers => {
+                      "content-type" => "text/plain",
+                      "authorization" => "Basic meh"
+                    },
+                    :body => "hi")
+      end
+      it "should respond with 401" do
+        expect(response.status).to eq(401)
+      end
+      it "should not generate an event" do
+        expect(queue).to be_empty
+      end
+    end
+    context "when client presents correct auth token" do
+      let!(:response) do
+        agent.post!("http://localhost:8080/meh",
+                    :headers => {
+                      "content-type" => "text/plain",
+                      "authorization" => "Basic #{auth_token}"
+                    }, :body => "hi")
+      end
+      it "should respond with 200" do
+        expect(response.status).to eq(200)
+      end
+      it "should generate an event" do
+        expect(queue).to_not be_empty
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: logstash-input-http
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Elastic
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2015-06-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logstash-core
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: logstash-codec-plain
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: stud
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: puma
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: logstash-devutils
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: logstash-codec-json
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: ftw
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
+description: This gem is a logstash plugin required to be installed on top of the Logstash core pipeline using $LS_HOME/bin/plugin install gemname. This gem is not a stand-alone program
+email: info@elastic.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGELOG.md
+- DEVELOPER.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/logstash/inputs/http.rb
+- logstash-input-http.gemspec
+- spec/inputs/http_spec.rb
+homepage: http://www.elastic.co/guide/en/logstash/current/index.html
+licenses:
+- Apache License (2.0)
+metadata:
+  logstash_plugin: 'true'
+  logstash_group: input
+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.4.5
+signing_key:
+specification_version: 4
+summary: Logstash Input plugin that receives HTTP requests
+test_files:
+- spec/inputs/http_spec.rb