logstash-output-http_auth 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 183a95d1df45ea65b0402888c9a74258dac4d849
+  data.tar.gz: 53ec525af25f06370ec2e062dac4e41abd152425
+SHA512:
+  metadata.gz: e288eb3dfe9e7363a1f09a9574c8725e36acfb59b6c7077a62933932649df500d32712a4af09aa783aec981b93170f3601af51f985c6b2d4d1404fadb416265c
+  data.tar.gz: 65731cca9d4e0d1c1201a115bebc0611df49f825a2f4f50f8207c8b7b68e70bd9c43e3a406ed1453f8a2b1a09c3583a6985a15f5a0b47d7641a9ff71c83e3fd8

data/.gitignore

@@ -0,0 +1,3 @@
+Gemfile.lock
+.ruby-version
+*.gem

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2012-2014 Elasticsearch <http://www.elasticsearch.org>
+
+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/Rakefile

@@ -0,0 +1,7 @@
+@files=[]
+
+task :default do
+  system("rake -T")
+end
+
+require "logstash/devutils/rake"

data/lib/logstash/outputs/http_auth.rb

@@ -0,0 +1,239 @@
+# encoding: utf-8
+require "logstash/outputs/base"
+require "logstash/namespace"
+require "logstash/json"
+
+class LogStash::Outputs::HttpAuth < LogStash::Outputs::Base
+    # This output lets you `PUT` or `POST` events to a
+    # generic HTTP(S) endpoint
+    #
+    # Additionally, you are given the option to customize
+    # the headers sent as well as basic customization of the
+    # event json itself.
+    #
+    # In addition to default http-plugin, you need 2 way authentication 
+    # with csrf_token verification? This is you plugin!
+
+    config_name "http_auth"
+
+    # If sign in is desired
+    config :sign_in, :validate => :boolean, :default => false
+
+    # Params to be sent within the body
+    config :sign_in_params, :validate => :hash
+
+    # Host-address of the server
+    config :host, :validate => :string
+
+    # Port of the server
+    config :port, :validate => :number
+
+    # Root path of the application to get the csrf-cookie
+    config :root_path, :validate => :string, :default => "/"
+
+    # Path of the action to be called
+    config :path, :validate => :string
+
+    # Sign-In path of the application to be authenticated
+    config :sign_in_path, :validate => :string, :default => "/users/sign_in"
+
+    # URL to use
+    config :url, :validate => :string
+
+    # validate SSL?
+    config :verify_ssl, :validate => :boolean, :default => true
+
+    # What verb to use
+    # only put and post are supported for now
+    config :http_method, :validate => ["put", "post"], :required => :true
+
+    # Custom headers to use
+    # format is `headers => ["X-My-Header", "%{host}"]
+    config :headers, :validate => :hash
+
+    # Content type
+    #
+    # If not specified, this defaults to the following:
+    #
+    # * if format is "json", "application/json"
+    # * if format is "form", "application/x-www-form-urlencoded"
+    config :content_type, :validate => :string
+
+    # This lets you choose the structure and parts of the event that are sent.
+    #
+    #
+    # For example:
+    #
+    #    mapping => ["foo", "%{host}", "bar", "%{type}"]
+    config :mapping, :validate => :hash
+
+    # Set the format of the http body.
+    #
+    # If form, then the body will be the mapping (or whole event) converted
+    # into a query parameter string (foo=bar&baz=fizz...)
+    #
+    # If message, then the body will be the result of formatting the event according to message
+    #
+    # Otherwise, the event is sent as json.
+    config :format, :validate => ["json", "form", "message"], :default => "json"
+
+    config :message, :validate => :string
+
+    public
+    def register
+        require "ftw"
+        require "uri"
+        @agent = FTW::Agent.new
+
+        if @content_type.nil?
+            case @format
+                when "form" ; @content_type = "application/x-www-form-urlencoded"
+                when "json" ; @content_type = "application/json"
+            end
+        end
+
+        if @format == "message"
+            if @message.nil?
+                raise "message must be set if message format is used"
+            end
+            if @content_type.nil?
+                raise "content_type must be set if message format is used"
+            end
+            unless @mapping.nil?
+                @logger.warn "mapping is not supported and will be ignored if message format is used"
+            end
+        end
+
+        @signed_in = false
+        @csrf_token = nil
+        @cookies = nil
+    end # def register
+
+    public
+    def receive(event)
+        return unless output?(event)
+
+        sign_in() if @sign_in
+
+        if @mapping
+            evt = Hash.new
+            @mapping.each do |k,v|
+                evt[k] = event.sprintf(v)
+            end
+        else
+            evt = event.to_hash
+        end
+
+        @url = URI::HTTP.build({:host => @host, :port=> @port, :path => @path}) if @url.nil?
+
+        case @http_method
+        when "put"
+          request = @agent.put(event.sprintf(@url))
+        when "post"
+          request = @agent.post(event.sprintf(@url))
+        else
+          @logger.error("Unknown verb:", :verb => @http_method)
+        end
+
+        if @headers
+          @headers.each do |k,v|
+            request.headers[k] = event.sprintf(v)
+          end
+        end
+
+        request["Content-Type"] = @content_type
+
+        set_header(request)
+
+        begin
+            if @format == "json"
+                request.body = evt.to_json
+            elsif @format == "message"
+                request.body = event.sprintf(@message)
+            else
+                request.body = encode(evt)
+            end
+
+            response = @agent.execute(request)
+
+            @signed_in = status_success?(response.status)
+
+            @logger.warn("Response Status #{response.status} for request #{@http_method} to #{@url}") if !status_success?(response.status)
+
+        rescue Exception => e
+            @logger.warn("Unhandled exception", :request => request, :response => response, :exception => e, :stacktrace => e.backtrace)
+        end
+    end # def receive
+
+    private
+    def encode(hash)
+        return hash.collect do |key, value|
+            CGI.escape(key) + "=" + CGI.escape(value)
+        end.join("&")
+    end # def encode
+
+    def set_cookies(response)
+        set_cookie = response.headers['set-cookie']
+
+        if(!set_cookie.nil? && !set_cookie.empty?)
+            cookies = []
+            set_cookie.each do |c|
+                cookie = c.split('; ')[0]
+
+                @csrf_token = CGI.unescape(cookie.split('=')[1]) if cookie.start_with?('XSRF-TOKEN')
+
+                cookies << cookie
+            end
+            @cookies = cookies.join('; ') if !cookies.empty?
+        end
+    end
+
+    def sign_in
+        if(!@signed_in)
+            if(@cookies.nil?)
+                request = @agent.get(
+                    URI::HTTP.build({:host => @host, :port=> @port, :path => @root_path})
+                )
+                request["Content-Type"] = @content_type
+                response = @agent.execute(request)
+
+                set_cookies(response)
+            end
+
+            request = @agent.post(
+                URI::HTTP.build({:host => @host, :port=> @port, :path => @sign_in_path})
+            )
+            request["Content-Type"] = @content_type
+
+            set_header(request)
+
+            body = Hash.new
+            @sign_in_params.each do |k,v|
+                body[k] = v
+            end
+
+            request.body = body.to_json
+
+            response = @agent.execute(request)
+
+            set_cookies(response)
+
+            # status 2xx success
+            @signed_in = status_success?(response.status)
+        end
+    end
+
+    def set_header(request)
+        request.headers['Cookie'] = @cookies if !@cookies.nil?
+
+        if !@csrf_token.nil?
+          request.headers['X-Requested-With'] = 'XMLHttpRequest'
+          request.headers['X-CSRF-Token'] = @csrf_token
+          request.headers['X-XSRF-Token'] = @csrf_token
+        end
+    end
+
+    def status_success?(status)
+        status >= 200 && status < 300
+    end
+end

data/logstash-output-http_auth.gemspec

@@ -0,0 +1,29 @@
+Gem::Specification.new do |s|
+
+  s.name            = 'logstash-output-http_auth'
+  s.version         = '0.1.0'
+  s.licenses        = ['Apache License (2.0)']
+  s.summary         = "This output lets you `PUT` or `POST` events to a generic HTTP(S) endpoint with 2 way authentication"
+  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         = ["Signify"]
+  s.email           = 'dietmar@signifydata.com'
+  s.homepage        = "http://www.signifydata.com"
+  s.require_paths = ["lib"]
+
+  # Files
+  s.files = `git ls-files`.split($\)+::Dir.glob('vendor/*')
+
+  # 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" => "output" }
+
+  # Gem dependencies
+  s.add_runtime_dependency 'logstash-core', '>= 1.4.0', '< 2.0.0'
+
+  s.add_runtime_dependency 'ftw', ['~> 0.0.40']
+
+  s.add_development_dependency 'logstash-devutils'
+end
+

data/spec/outputs/http_auth_spec.rb

@@ -0,0 +1,5 @@
+require "logstash/devutils/rspec/spec_helper"
+require 'logstash/outputs/http_auth'
+
+describe LogStash::Outputs::HttpAuth do
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: logstash-output-http_auth
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Signify
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2015-08-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  name: logstash-core
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+    - - <
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.40
+  name: ftw
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.40
+- !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'
+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: dietmar@signifydata.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- Rakefile
+- lib/logstash/outputs/http_auth.rb
+- logstash-output-http_auth.gemspec
+- spec/outputs/http_auth_spec.rb
+homepage: http://www.signifydata.com
+licenses:
+- Apache License (2.0)
+metadata:
+  logstash_plugin: 'true'
+  logstash_group: output
+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.1.9
+signing_key:
+specification_version: 4
+summary: This output lets you `PUT` or `POST` events to a generic HTTP(S) endpoint with 2 way authentication
+test_files:
+- spec/outputs/http_auth_spec.rb