logstash-input-netldap 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: be202a873aeba9882eb0d10ba419644304528c3b8be77f07ce3867ad84c5912b
+  data.tar.gz: 43b4e9f9209cc1b59be77a9dd18419152fa7311d6ba58067d0699dede2dc18a8
+SHA512:
+  metadata.gz: c6a2d2c6e7e2038f6f700608d2ee6cee669d9cba52a9850a402b87e2fdf56494e99cd71b25402e03512e125742fb80150c87a4bad538f4b895b66bf36cfc9774
+  data.tar.gz: eaf733f78b3eda3bc7072c25cb38cbb5ed4ea813b0baaa820adebc16628e89f96f416d8128e4c82a72dc0ae486f7e768f027212304db992866d2db61ae9aa775

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 1.0.0
+
+* First release of the plugin

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+gemspec
+
+logstash_path = ENV["LOGSTASH_PATH"] || "../../logstash"
+use_logstash_source = ENV["LOGSTASH_SOURCE"] && ENV["LOGSTASH_SOURCE"].to_s == "1"
+
+if Dir.exist?(logstash_path) && use_logstash_source
+  gem 'logstash-core', :path => "#{logstash_path}/logstash-core"
+  gem 'logstash-core-plugin-api', :path => "#{logstash_path}/logstash-core-plugin-api"
+end

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2018 damterroba
+
+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/NOTICE.TXT

@@ -0,0 +1,5 @@
+Elasticsearch
+Copyright 2012-2015 Elasticsearch
+
+This product includes software developed by The Apache Software
+Foundation (http://www.apache.org/).

data/README.md

@@ -0,0 +1,97 @@
+# NetLdap 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 build documentation for this plugin. We provide a template file, index.asciidoc, where you can add documentation. The contents of this file will be converted into html and then placed with other plugin documentation in a [central location](http://www.elastic.co/guide/en/logstash/current/).
+
+* For formatting config examples, you can use the asciidoc `[source,json]` directive
+* For more asciidoc formatting tips, see the excellent reference here https://github.com/elastic/docs#asciidoc-guide
+* Information for this plugin configuration can be found [here](docs/index.asciidoc)
+
+## 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
+```
+
+### 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-input-netldap", :path => "/your/local/logstash-input-netldap"
+```
+
+* Install plugin
+
+```sh
+# Logstash 2.3 and higher
+bin/logstash-plugin install --no-verify
+
+# Prior to Logstash 2.3
+bin/plugin install --no-verify
+```
+
+* Run Logstash with your plugin
+
+```sh
+bin/logstash -e 'filter {netldap {[...]}}'
+```
+
+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-input-netldap.gemspec
+```
+
+* Install the plugin from the Logstash home
+
+```sh
+# Logstash 2.3 and higher
+bin/logstash-plugin install --no-verify
+
+# Prior to Logstash 2.3
+bin/plugin install --no-verify
+```
+
+* 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/netldap.rb

@@ -0,0 +1,105 @@
+# encoding: utf-8
+require "logstash/inputs/base"
+require "logstash/namespace"
+require "stud/interval"
+require "socket" # for Socket.gethostname
+require "base64"
+require "rubygems"
+require "net/ldap"
+
+# Performs a LDAP search using net-ldap. 
+#
+# Usage : 
+#
+# input {
+#   ldap{
+#     host => "myLdapHost"
+#     port => 389
+#     dn => "myDn"
+#     password => "myPassword"
+#     base => "ou=people,dc=gouv,dc=fr"
+#     filter => [{field=>"field1" value=>"value1"}, {field=>"field2" value=>"value2"}
+#     attrs => ['uid', 'mail', 'sn', 'cn']
+#   } 
+# }
+#
+
+class LogStash::Inputs::NetLdap < LogStash::Inputs::Base
+  config_name "netldap"
+
+  # If undefined, Logstash will complain, even if codec is unused.
+  default :codec, "plain"
+
+  # The ldap host to perform the search
+  # Can be ip or hostname
+  config :ldap_host, :validate => :string, :required => true
+
+  # The ldap port to connect on, 389 by default
+  config :port, :validate => :number, :default => 389, :required => true
+
+  # Specifies if the bind is anonymous
+  # If not, you'll need to set the user bind DN and password
+  config :anonymous, :validate => :boolean, :default => false
+
+  # User to bind an the ldap server
+  config :dn, :validate => :string
+
+  # Configure the password
+  config :password, :validate => :password
+
+  # LDAP base DN to search in
+  config :base, :validate => :string, :required => true
+
+  # Filters of the ldap search, an array of hashes
+  config :filters, :validate => :array, :default => [{ "field" =>  "objectclass", "value" => "inetorgperson" }]
+
+  # Specify the attributes you wanna get for each entry
+  config :attrs, :validate => :array, :default => ["uid", "mail"]
+
+  public
+  def register
+    @host = Socket.gethostname
+    
+    if @anonymous
+      auth = { :method => :anonymous}
+    else
+      auth = {
+        :method => :simple,
+        :username => @dn,
+        :password => @password.value  
+      }
+    end
+    @conn = Net::LDAP.new :host => @ldap_host,
+    :port => @port,
+    :auth => auth
+  end
+
+  def run(queue)
+    # Filters def
+    finalFilter = "" # need to initialize this outside the each
+    @filters.each.with_index do |hashFilter, index|
+      tmpFilter = Net::LDAP::Filter.eq(hashFilter['field'], hashFilter['value'])
+      case index
+      when 0
+        finalFilter = tmpFilter
+      else
+        finalFilter = Net::LDAP::Filter.join(finalFilter, tmpFilter)
+      end
+    end
+
+    #filter = Net::LDAP::Filter.eq("objectclass", "inetorgperson")
+    @conn.search(:base => @base, :filter => finalFilter, :attributes => @attrs) do |entry|
+      # event = LogStash::Event::new
+      event = LogStash::Event.new()
+      decorate(event)
+      entry.each do |attribute, value|
+        if value.count() > 1
+          event.set("#{attribute}", value)
+        else
+          event.set("#{attribute}", value.first)
+        end
+      end
+      queue << event
+    end
+  end 
+end

data/logstash-input-netldap.gemspec

@@ -0,0 +1,26 @@
+Gem::Specification.new do |s|
+  s.name = 'logstash-input-netldap'
+  s.version         = '1.0.1'
+  s.licenses = ['Apache-2.0']
+  s.summary = "Logstash input plugin that performs an LDAP search."
+  s.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 gemname. This gem is not a stand-alone program"
+  s.authors = ["damterroba"]
+  s.email = 'mathieu.terroba@gmail.com'
+  s.homepage = "https://github.com/damterroba/logstash-input-netldap/"
+  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", ">= 1.60", "<= 2.99"
+  s.add_runtime_dependency 'logstash-codec-plain'
+  s.add_runtime_dependency 'stud', '>= 0.0.22'
+  s.add_runtime_dependency 'net-ldap'
+  s.add_development_dependency 'logstash-devutils'
+end

data/spec/inputs/netldap_spec.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+require "logstash/devutils/rspec/spec_helper"
+require "logstash/inputs/ldap"
+
+describe LogStash::Inputs::NetLdap do
+  
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: logstash-input-netldap
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- damterroba
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2018-05-15 00:00:00.000000000 Z
+dependencies:
+- !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: '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'
+  name: net-ldap
+  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'
+  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/logstash-plugin install gemname. This
+  gem is not a stand-alone program
+email: mathieu.terroba@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- NOTICE.TXT
+- README.md
+- lib/logstash/inputs/netldap.rb
+- logstash-input-netldap.gemspec
+- spec/inputs/netldap_spec.rb
+homepage: https://github.com/damterroba/logstash-input-netldap/
+licenses:
+- Apache-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.6.11
+signing_key:
+specification_version: 4
+summary: Logstash input plugin that performs an LDAP search.
+test_files:
+- spec/inputs/netldap_spec.rb