logstash-input-ldap 0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 274ac5affd4347dbb2952533f6fba92d10487cd4
+  data.tar.gz: 968101426a058e95525ae2ece63fb7748e3d9e18
+SHA512:
+  metadata.gz: 514371e36afaec7df5435ee2470d166f9906565a9ec75345d36d811bc9185bab766bfc49010464745140e9d6643fd7373e0f4bb897863ce71c15bcbd514210d8
+  data.tar.gz: 5fcea41d8a229f6e1f4c1c3b9132d8654f3e38b8e29ff6bcbd54fccd15e57aafaa42a406115b9355444140c6cbfd9810675fed1e3db1f53387085be18f859ba9

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 0.1.0
+  - Plugin created with the logstash plugin generator

data/CONTRIBUTORS

@@ -0,0 +1,10 @@
+The following is a list of people who have contributed ideas, code, bug
+reports, or in general have helped logstash along its way.
+
+Contributors:
+* dariko - git@dariozanzico.com
+
+Note: If you've sent us patches, bug reports, or otherwise contributed to
+Logstash, and you aren't on the list above and want to be, please let us know
+and we'll make sure you're here. Contributions from folks like you are what make
+open source awesome.

data/DEVELOPER.md

@@ -0,0 +1,2 @@
+# logstash-input-ldap
+Example input plugin. This should help bootstrap your effort to write your own input plugin!

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,11 @@
+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/elastic/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.elastic.co/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/elastic/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/logstash-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/logstash-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/elastic/logstash/blob/master/CONTRIBUTING.md) file.

data/lib/logstash/inputs/ldap.rb

@@ -0,0 +1,214 @@
+# encoding: utf-8
+require "logstash/inputs/base"
+require "logstash/namespace"
+require "stud/interval"
+require "socket" # for Socket.gethostname
+
+class LdapConnectTimeout < Timeout::Error;end
+
+class LogStash::Inputs::Ldap < LogStash::Inputs::Base
+  config_name "ldap"
+
+  default :codec, "plain"
+
+  config :bind_dn,        :validate => :string, :required => true
+  config :bind_password,  :validate => :string, :required => true
+  config :ldap_uri,       :validate => :string, :required => true
+  config :cacert_path,    :validate => :string, :required => false
+	config :filter,         :validate => :string, :default => "(objectclass=*)"
+  config :interval,       :validate => :number
+  config :timeout,        :validate => :number, :default => 10
+  config :timestamp_filter_on,            :validate => :boolean,  :default => false
+  config :timestamp_filter_field,         :validate => :string,   :default => "reqstart"
+  config :timestamp_filter_field_end,     :validate => :string,   :default => nil
+  config :timestamp_filter_save_metadata, :validate => :boolean,  :default => true
+  config :timestamp_filter_metadata_path, :validate => :string,
+                                          :default => "#{ENV['HOME']}/.logstash_ldap_last_run"
+
+  public
+  def format_ldap_time(time)
+    time.utc.strftime("%Y%m%d%H%M%SZ")
+  end
+
+  def register
+    require 'net-ldap'
+    require 'uri'
+    require "stud/interval"
+    require "yaml"
+    # timeout has problems in jruby 1.7.19, using jruby_timeout instead
+    # require 'timeout'
+
+    begin
+      parsed_uri = URI.parse @ldap_uri
+      raise ArgumentError.new("uri is not an ldap uri") unless
+              [ URI::LDAP, URI::LDAPS ].index parsed_uri.class
+      @host   = parsed_uri.host
+      @port   = parsed_uri.port
+      @ssl    = parsed_uri.scheme == "ldaps" ? true : false
+      @base   = parsed_uri.dn
+      @scope  = case parsed_uri.scope
+        when "sub"
+          Net::LDAP::SearchScope_WholeSubtree
+        when "base"
+          Net::LDAP::SearchScope_BaseObject
+        when "single"
+          Net::LDAP::SearchScope_SingleLevel
+      end
+    rescue ArgumentError, URI::InvalidURIError => e
+      @logger.error("Not an LDAP/LDAPS uri", :error_message => e.message)
+      raise e
+    end
+
+    begin
+      @parsed_filter=Net::LDAP::Filter.from_rfc2254 @filter
+    rescue ArgumentError, URI::InvalidURIError => e
+      @logger.error("Invalid filter #{@filter}", :error_message => e.message)
+      raise e
+    end
+
+    if @cacert_path and not File.readable? @cacert_path
+      @logger.error "Unreadable #{@cacert_path}"
+      raise IOError.new("Unreadable #{@cacert_path}")
+    end
+
+    # load timestamp_filter_last_value from file if exists
+    if @timestamp_filter_on && File.exist?(@timestamp_filter_metadata_path)
+      @timestamp_filter_last_value = YAML.load( File.read( @timestamp_filter_metadata_path ) )
+      @logger.debug("read timestamp_filter_last_value: #{@timestamp_filter_last_value}")
+    elsif @timestamp_filter_on
+      @timestamp_filter_last_value = "00000101000000.000000Z"
+      @logger.debug("set timestamp_filter_last_value as default: #{@timestamp_filter_last_value}")
+    end
+  end
+
+  def entry_to_event( entry )
+    data = {}
+    entry.attribute_names.each do |an|
+      data[an.to_s] = entry[an]
+    end
+    #data["ldap_server"] = @host
+    event = LogStash::Event.new( data )
+    decorate( event )
+    event
+  end
+
+  def connect()
+    ldap=nil
+    begin
+      tls_options = (not @cacert_path) ? {} : {
+        :ca_file => @cacert_path
+      }
+      enc = ( not @ssl ) ? {} : {
+          :method => :simple_tls,
+          :tls_options => tls_options
+      }
+      jruby_timeout(@timeout, LdapConnectTimeout) do
+        ldap=Net::LDAP.new(
+          :host => @host, :base => @base, :port => @port, :encryption => enc,
+          :auth => {
+            :username => @bind_dn, :password => @bind_password, :method => :simple
+          }
+          #,:connect_timeout => @timeout
+        )
+      end
+    rescue LdapConnectTimeout => ex
+      @logger.error("Timeout connecting to LDAP")
+      raise ex
+    rescue Net::LDAP::Error => ex
+      @logger.error("Failed to connect to LDAP", :error_message => ex.message)
+      raise ex
+    else
+      return ldap
+    end
+  end
+
+  # alternate timeout for jruby
+  # https://gist.github.com/jorgenpt/1356797
+  def jruby_timeout(sec,klass)
+    return yield(sec) if sec == nil or sec.zero?
+    thread = Thread.new { yield(sec) }
+
+    if thread.join(sec).nil?
+      java_thread = JRuby.reference(thread)
+      thread.kill
+      java_thread.native_thread.interrupt
+      thread.join(0.15)
+      raise klass, 'execution expired'
+    else
+      thread.value
+    end
+  end
+
+  def run_once(queue)
+    begin
+      filter= if not @timestamp_filter_on
+        @parsed_filter
+      else
+        @parsed_filter.&(
+          Net::LDAP::Filter.ge( timestamp_filter_field, @timestamp_filter_last_value )
+        )
+      end
+      @logger.debug("Using filter: #{filter.to_s}")
+
+      timestamp_filter_last_value = @timestamp_filter_last_value
+
+      # jruby_timeout overcoming old jruby problems
+      jruby_timeout(@timeout, LdapConnectTimeout ) do
+        ris = @ldap.search( :base => @base,
+                            :filter => filter,
+                            :return_result => false,
+                            # maybe, someday 
+                            #:time_limit => @timeout,
+                            :scope => Net::LDAP::SearchScope_SingleLevel) do |entry|
+          yield(entry)
+          if @timestamp_filter_on
+            entry_timestamp = if @timestamp_filter_field_end
+              entry[@timestamp_filter_field_end][0].to_s
+            else
+              entry[@timestamp_filter_field][0].to_s
+            end
+
+            timestamp_filter_last_value = entry_timestamp if
+                  entry_timestamp > timestamp_filter_last_value
+          end
+        end
+      end
+    rescue LdapConnectTimeout => e
+      @logger.error("Timeout running query")
+    rescue Net::Ldap::Error => e
+      @logger.error("LDAP error running query: #{e.message}")
+    rescue Exception => e
+      @logger.error("Error running query [#{e.class}]: #{e}", :error_message => e.message)
+      raise e
+    else
+      @timestamp_filter_last_value = timestamp_filter_last_value
+      update_state_file if @timestamp_filter_save_metadata
+    end
+  end
+  def run(queue)
+    @ldap=connect()
+    loop do
+      run_once(queue) do |entry|
+        event = entry_to_event entry
+        queue << event
+      end
+      # run only once if @interval not set
+      break if (not @interval) or stop?
+      Stud.stoppable_sleep(@interval) { stop? }
+    end
+  end
+
+  def stop
+    # nothing to do in this case so it is not necessary to define stop
+    # examples of common "stop" tasks:
+    #  * close sockets (unblocking blocking reads/accepts)
+    #  * cleanup temporary files
+    #  * terminate spawned threads
+  end
+  def update_state_file
+    if @timestamp_filter_save_metadata
+      @logger.debug("saving timestamp_filter_last_value: #{@timestamp_filter_last_value}")
+      File.write(@timestamp_filter_metadata_path, YAML.dump(@timestamp_filter_last_value))
+    end
+  end
+end

data/logstash-input-ldap.gemspec

@@ -0,0 +1,27 @@
+Gem::Specification.new do |s|
+  s.name            = 'logstash-input-ldap'
+  s.version         = '0.3'
+  s.licenses        = ['Apache License (2.0)']
+  s.summary         = "This input reads data from a slapo-accesslog overlay via LDAP"
+  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.homepage        = "http://www.elastic.co/guide/en/logstash/current/index.html"
+  s.authors         = ["Dario Zanzico"]
+  s.email           = 'git@dariozanzico.com'
+  s.require_paths   = ["lib"]
+
+  # Files
+  s.files = Dir['lib/**/*','spec/**/*','vendor/**/*','*.gemspec','*.md','CONTRIBUTORS','Gemfile','LICENSE','NOTICE.TXT']
+   # 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-plugin-api", "~> 2.0"
+  s.add_runtime_dependency 'logstash-codec-plain'
+  s.add_runtime_dependency 'stud', '>= 0.0.22'
+  s.add_development_dependency 'logstash-devutils', '>= 0.0.16'
+  s.add_runtime_dependency 'net-ldap', '>= 0.12.1'
+  s.add_runtime_dependency 'rufus-scheduler'
+end

data/spec/inputs/ldap_spec.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/inputs/ldap"
+
+#describe LogStash::Inputs::Ldap do
+
+  #it_behaves_like "an interruptible input plugin" do
+    #let(:config) { { "interval" => 100 } }
+  #end
+
+#end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: logstash-input-ldap
+version: !ruby/object:Gem::Version
+  version: '0.3'
+platform: ruby
+authors:
+- Dario Zanzico
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2017-04-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  name: logstash-core-plugin-api
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: logstash-codec-plain
+  prerelease: false
+  type: :runtime
+  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.0.22
+  name: stud
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.22
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.16
+  name: logstash-devutils
+  prerelease: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.16
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.1
+  name: net-ldap
+  prerelease: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.1
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  name: rufus-scheduler
+  prerelease: false
+  type: :runtime
+  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: git@dariozanzico.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTORS
+- DEVELOPER.md
+- Gemfile
+- LICENSE
+- README.md
+- lib/logstash/inputs/ldap.rb
+- logstash-input-ldap.gemspec
+- spec/inputs/ldap_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.8
+signing_key:
+specification_version: 4
+summary: This input reads data from a slapo-accesslog overlay via LDAP
+test_files:
+- spec/inputs/ldap_spec.rb