logstash-input-LDAPSearch 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: db3a194fc8eb70cfc593b9e0886ae8974dbd4754
+  data.tar.gz: cb02f1997099adbb1e9f436b2314b9a0386c5601
+SHA512:
+  metadata.gz: bdcfb01dc37200f235569b984ab68ec4ce2f2e16ee3995597cbed9cb59c339f5510aab2bf19a39b0c5752ce7ca9fd645ed1ddcbc635cfd9debfdaca682d43b96
+  data.tar.gz: 7baebc7edf3b43f5c5ca895f9ff90acbe387a049e9650a1a8b88e57b4de7659cbe438b3967d7f0150f918e28314e103d48c9578cf05ea550273fffd7421acbe2

data/.gitignore

@@ -0,0 +1,35 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/DEVELOPER.md

@@ -0,0 +1,2 @@
+# logstash-input-example
+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
+gem 'jruby-ldap'

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,98 @@
+# 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 logstash-users@googlegroups.com mailing list.
+
+## Developing
+
+### 1. Plugin Developement and Testing
+
+
+#### To make bundle install work
+- I need to install rvm before :
+```sh
+    # gpg --keyserver hkp://keys.gnupg.net --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3
+    # curl -sSL https://get.rvm.io | bash -s stable --ruby
+```
+- then I need to install jruby
+```sh
+    # sudo rvm install jruby
+```
+ 
+#### 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/LDAPSearch.rb

@@ -0,0 +1,79 @@
+# encoding: utf-8
+require "logstash/inputs/base"
+require "logstash/namespace"
+require "stud/interval"
+require "socket" # for Socket.gethostname
+
+# Perform an LDAP Search
+#
+# Example:
+#
+#     input {
+#        LDAPSearch {
+#         host => "myLDAPServer"
+#         dn => "myDN"
+#         password => "myPassword"
+#         filter => "myldapfilter"
+#         base => "ou=people,dc=univ,dc=fr"
+#         attrs => ['myattrubteslist']
+#        }
+#    }
+
+class LogStash::Inputs::LDAPSearch < LogStash::Inputs::Base
+  config_name "LDAPSearch"
+
+  # If undefined, Logstash will complain, even if codec is unused.
+  default :codec, "plain" 
+
+  # LDAP parameters
+  config :host, :validate => :string, :required => true
+  config :dn, :validate => :string, :required => true
+  config :password, :validate => :password, :required => true
+  config :filter, :validate => :string, :required => true
+  config :base, :validate => :string, :required => true
+  config :port, :validate => :number, :default => 389
+  config :attrs, :validate => :array, :default => ['uid']
+
+  public
+  def register
+    require 'base64'
+    require 'rubygems'
+    require 'ldap'
+  end # def register
+
+  public
+  def run(queue)
+      
+    @host = Socket.gethostbyname(@host).first
+    #attrs = ['uid', 'sn', 'cn', 'eduPersonPrimaryAffiliation']
+    scope = LDAP::LDAP_SCOPE_SUBTREE #LDAP::LDAP_SCOPE_ONELEVEL
+    conn = LDAP::Conn.new(@host, @port)
+    conn.bind(@dn, @password.value)
+    begin
+      @logger.debug("Executing LDAP search base='#{@base}' filter='#{@filter}'")
+      conn.search(base, scope, filter, attrs) { |entry|
+        # print distinguished name
+        # p entry.dn
+        event = LogStash::Event.new
+        decorate(event)
+        event["host"] = @host
+        entry.get_attributes.each do |attr|
+        #values = entry.get_values(attr).first
+        values = entry.get_values(attr)
+        values = values.map { |value|
+            (/[^[:print:]]/ =~ value).nil? ? value : Base64.strict_encode64(value)
+        }
+        event[attr] = values
+        end
+        #event["attr"] = entry.attrs
+        queue << event
+          
+      }
+    rescue LDAP::ResultError => ex
+      @logger.error("LDAP search error: #{ex}\n#{ex.backtrace}")
+      exit
+    end
+    finished
+  end # def run
+
+end # class LogStash::Inputs::LDAPSearch

data/logstash-input-LDAPSearch.gemspec

@@ -0,0 +1,35 @@
+Gem::Specification.new do |s|
+
+  s.name            = 'logstash-input-LDAPSearch'
+  s.version         = '0.1.0'
+  s.licenses        = ['Apache License (2.0)']
+  s.summary         = "logstash input plugin to perform search into 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.authors         = ["Nicolas CAN"]
+  s.email           = 'nicolas.can@univ-lille1.fr'
+  s.homepage        = "https://github.com/SemmLille/logstash-input-LDAPSearch" #"http://www.elastic.co/guide/en/logstash/current/index.html"
+  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" => "input" }
+
+  # Gem dependencies
+  s.add_runtime_dependency "logstash-core", '>= 1.4.0', '< 2.0.0'
+
+  s.add_runtime_dependency 'jruby-ldap'
+  #s.add_runtime_dependency 'ruby_base64'
+  
+  #s.add_runtime_dependency 'logstash-codec-plain'
+  #s.add_runtime_dependency 'logstash-codec-line'
+  #s.add_runtime_dependency 'logstash-codec-json'
+  #s.add_runtime_dependency 'logstash-codec-json_lines'
+  #s.add_runtime_dependency 'concurrent-ruby'
+
+  s.add_development_dependency 'logstash-devutils'
+end

data/spec/inputs/LDAPSearch_spec.rb

@@ -0,0 +1 @@
+require "logstash/devutils/rspec/spec_helper"

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: logstash-input-LDAPSearch
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nicolas CAN
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2015-06-16 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: jruby-ldap
+  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
+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: nicolas.can@univ-lille1.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- DEVELOPER.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/logstash/inputs/LDAPSearch.rb
+- logstash-input-LDAPSearch.gemspec
+- spec/inputs/LDAPSearch_spec.rb
+homepage: https://github.com/SemmLille/logstash-input-LDAPSearch
+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 to perform search into ldap.
+test_files:
+- spec/inputs/LDAPSearch_spec.rb