sensu-plugins-openldap 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9badc6dc1068dc01f239745654edfdab993a1a1f
+  data.tar.gz: 1c041933733c1c50f13d5254dbd40cbfa4d74134
+SHA512:
+  metadata.gz: 95ae1b7e3b41718228431ba75e3fa57d15f95e4995e68ce5cbb73283aeda31c882debceb7236da21dec219620921907412ef318b5902aba1c90c9a5c81349ccc
+  data.tar.gz: 108a3f44680c0b769f0de79d4d5db7a19e432f3463759a457a09f2c9a313b332ca37e7a84a0e90bed71a83bd3f605525838f37ec97ae487201950517765eb4d4

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+#Change Log
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachangelog.com/)
+
+## Unreleased][unreleased]
+
+## 0.0.1 - 2015-05-21
+
+### Added
+- initial release
+

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Sensu-Plugins
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,22 @@
+## Sensu-Plugins-openldap
+
+[![Build Status](https://travis-ci.org/sensu-plugins/sensu-plugins-openldap.svg?branch=master)](https://travis-ci.org/sensu-plugins/sensu-plugins-openldap)
+[![Gem Version](https://badge.fury.io/rb/sensu-plugins-openldap.svg)](http://badge.fury.io/rb/sensu-plugins-openldap)
+[![Code Climate](https://codeclimate.com/github/sensu-plugins/sensu-plugins-openldap/badges/gpa.svg)](https://codeclimate.com/github/sensu-plugins/sensu-plugins-openldap)
+[![Test Coverage](https://codeclimate.com/github/sensu-plugins/sensu-plugins-openldap/badges/coverage.svg)](https://codeclimate.com/github/sensu-plugins/sensu-plugins-openldap)
+[![Dependency Status](https://gemnasium.com/sensu-plugins/sensu-plugins-openldap.svg)](https://gemnasium.com/sensu-plugins/sensu-plugins-openldap)
+[ ![Codeship Status for sensu-plugins/sensu-plugins-openldap](https://codeship.com/projects/7cc16ea0-db3b-0132-9eb0-0eed4ec53b27/status?branch=master)](https://codeship.com/projects/79575)
+
+## Functionality
+
+## Files
+ * bin/check-syncrepl
+ * bin/metrics-ldap
+
+## Usage
+
+## Installation
+
+[Installation and Setup](https://github.com/sensu-plugins/documentation/blob/master/user_docs/installation_instructions.md)
+
+## Notes

data/bin/check-syncrepl.rb

@@ -0,0 +1,158 @@
+#! /usr/bin/env ruby
+#
+#   check-syncrepl
+#
+# DESCRIPTION:
+#   This plugin checks OpenLDAP nodes to veryfiy syncrepl is working.
+#   The plugin will attempt to use an unauthenticated connection if no
+#   user name (with the -u or --user option) and password (with the -p
+#   or --password option) are specified.
+#
+# OUTPUT:
+#   plain text
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#   gem: net-ldap
+#
+# USAGE:
+#   bind to LDAP without authorisation
+#   ----------------------------------
+#   ./check-syncrepl.rb -h 'ldap1.domain,ldap2.domain'
+#   will compare the contextCSN of the ldap servers ldap1.domain and
+#   ldap2.domain
+#
+#   bind to LDAP requiring authorisation
+#   ------------------------------------
+#   ./check-syncrepl.rb -h 'ldap1.domain,ldap2.domain' -u auser -p passwd
+#   will bind to the ldap servers ldap1.domain and ldap2.domain as user
+#   auser with password passwd and compare the contextCSN
+#
+# NOTES:
+#
+# LICENSE:
+#   Copyright (c) 2014, Justin Lambert <jlambert@letsevenup.com>
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+
+require 'sensu-plugin/check/cli'
+require 'net/ldap'
+
+class CheckSyncrepl < Sensu::Plugin::Check::CLI
+  option :hosts,
+         short: '-h HOSTS',
+         long: '--hosts HOSTS',
+         description: 'Comma seperated list of hosts to compare',
+         required: true,
+         proc: proc { |hosts| hosts.split(',') }
+
+  option :port,
+         short: '-t PORT',
+         long: '--port PORT',
+         description: 'Port to connect to OpenLDAP on',
+         default: 389,
+         proc: proc(&:to_i)
+
+  option :base,
+         short: '-b BASE',
+         long: '--base BASE',
+         description: 'Base to fetch the ContextCSN for',
+         required: true
+
+  option :user,
+         short: '-u USER',
+         long: '--user USER',
+         description: 'User to bind as'
+
+  option :password,
+         short: '-p PASSWORD',
+         long: '--password PASSWORD',
+         description: 'Password used to bind'
+
+  option :insecure,
+         short: '-i',
+         long: '--insecure',
+         description: 'Do not use encryption'
+
+  option :retries,
+         short: '-r RETRIES',
+         long: '--retries RETRIES',
+         description: 'Number of times to retry (useful for environments with larger number of writes)',
+         default: 0,
+         proc: proc(&:to_i)
+
+  def get_csns(host)
+    if config[:user]
+      ldap = Net::LDAP.new host: host,
+                           port: config[:port],
+                           auth: {
+                             method: :simple,
+                             username: config[:user],
+                             password: config[:password]
+                           }
+    else
+      ldap = Net::LDAP.new host: host,
+                           port: config[:port]
+    end
+
+    unless config[:insecure]
+      ldap.encryption(method: :simple_tls)
+    end
+
+    begin
+      if ldap.bind
+        ldap.search(base: config[:base], attributes: ['contextCSN'], return_result: true, scope: Net::LDAP::SearchScope_BaseObject) do |entry|
+          return entry['contextcsn']
+        end
+      else
+        message = "Cannot connect to #{host}:#{config[:port]}"
+        if config[:user]
+          message += " as #{config[:user]}"
+        end
+        critical message
+      end
+    end
+  rescue
+    message = "Cannot connect to #{host}:#{config[:port]}"
+    if config[:user]
+      message += " as #{config[:user]}"
+    end
+    critical message
+  end
+
+  def run
+    unknown 'Cannot compare 1 node (to anything else).' if config[:hosts].length == 1
+
+    (config[:retries] + 1).times do
+      # Build a list of contextCSNs from each host
+      csns = {}
+      config[:hosts].each do |host|
+        csns[host] = get_csns host
+      end
+
+      # Compare all combinations of nodes
+      @differences = []
+      combinations = csns.keys.combination(2).to_a
+      combinations.each do |hosts|
+        @differences << hosts if (csns[hosts[0]] - csns[hosts[1]]).length > 0
+      end
+
+      # If everything is OK, no need to retry
+      ok 'All nodes are in sync' if @differences.length == 0
+    end
+
+    # Hit max retries, report latest differences
+    message = 'ContextCSNs differe between: '
+
+    joined = []
+    @differences.each do |different|
+      joined << different.sort.join(' and ')
+    end
+    message += joined.sort.join(', ')
+    critical message
+  end
+end

data/bin/metrics-ldap.rb

@@ -0,0 +1,173 @@
+#!/usr/bin/env ruby
+#
+#   ldap-metrics.rb
+#
+# AUTHOR
+#   Matt Ford
+#    - matt@dancingfrog.co.uk
+#    - matt@bashton.com
+#
+# DESCRIPTION
+#   This plugin uses the LDAP cn=monitor database to generate
+#   output suitable for graphite
+#
+#   It requires that the monitoring module is loaded and that a monitoring
+#   database has been set up.
+#
+#   ldapmodify the following:
+#   dn: cn=module{0},cn=config
+#   changetype: modify
+#   add: olcModuleLoad
+#   olcModuleLoad: back_monitor
+#
+#   ldapadd the following:
+#   dn: olcDatabase=Monitor,cn=config
+#   objectClass: olcDatabaseConfig
+#   objectClass: olcMonitorConfig
+#   olcDatabase: Monitor
+#   olcAccess: to dn.subtree="cn=Monitor" by dn.base="cn=suitable,dc=user" read by * none
+#
+# LICENSE:
+#   Copyright (c) 2014, Bashton Ltd
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+
+require 'sensu-plugin/metric/cli'
+require 'sensu-plugin/utils'
+require 'socket'
+require 'net/ldap'
+
+include Sensu::Plugin::Utils
+
+class LDAPGraphite < Sensu::Plugin::Metric::CLI::Graphite
+  option :scheme,
+         description: 'Metric naming scheme, text to prepend to metric',
+         short: '-s SCHEME',
+         long: '--scheme SCHEME',
+         default: "#{Socket.gethostname}.ldap_metrics"
+
+  option :host,
+         short: '-h HOST',
+         long: '--host HOST',
+         description: 'Host',
+         default: 'localhost'
+
+  option :port,
+         short: '-t PORT',
+         long: '--port PORT',
+         description: 'Port to connect to OpenLDAP on',
+         default: 389,
+         proc: proc(&:to_i)
+
+  option :base,
+         short: '-b BASE',
+         long: '--base BASE',
+         description: 'Base',
+         default: 'cn=Monitor'
+
+  option :user,
+         short: '-u USER',
+         long: '--user USER',
+         description: 'User to bind as',
+         required: true
+
+  option :password,
+         short: '-p PASSWORD',
+         long: '--password PASSWORD',
+         description: 'Password used to bind',
+         required: true
+
+  option :insecure,
+         short: '-i',
+         long: '--insecure',
+         description: 'Do not use encryption'
+
+  def get_metrics(host)
+    ldap = Net::LDAP.new host: host,
+                         port: config[:port],
+                         auth: {
+                           method: :simple,
+                           username: config[:user],
+                           password: config[:password]
+                         }
+
+    unless config[:insecure]
+      ldap.encryption(method: :simple_tls)
+    end
+
+    begin
+      if ldap.bind
+        message += 'So far'
+        metrics = {
+          conn_total: {
+            title: 'connections.total',
+            search: 'cn=Total,cn=Connections',
+            attribute: 'monitorCounter'
+          },
+          conn_cur: {
+            title: 'connections.current',
+            search: 'cn=Current,cn=Connections',
+            attribute: 'monitorCounter'
+          },
+          stats_bytes: {
+            title: 'statistics.bytes',
+            search: 'cn=Bytes,cn=Statistics',
+            attribute: 'monitorCounter'
+          },
+          stats_PDU: {
+            title: 'statistics.pdu',
+            search: 'cn=PDU,cn=Statistics',
+            attribute: 'monitorCounter'
+          },
+          stats_entries: {
+            title: 'statistics.entries',
+            search: 'cn=Entries,cn=Statistics',
+            attribute: 'monitorCounter'
+          },
+          stats_referrals: {
+            title: 'statistics.referrals',
+            search: 'cn=Referrals,cn=Statistics',
+            attribute: 'monitorCounter'
+          }
+        }
+        monitor_ops = %w(add modify delete search compare bind unbind)
+        %w(initiated completed).each do |state|
+          monitor_ops.each do |op|
+            metrics["ops_#{op}_#{state}".to_sym] = {
+              title: "operations.#{op}.#{state}",
+              search: "cn=#{op},cn=Operations",
+              attribute: "monitorOp#{state}"
+            }
+          end
+        end
+        metrics.each do |_key, metric|
+          ldap.search(base: "#{metric[:search]},#{config[:base]}",
+                      attributes: [metric[:attribute]],
+                      return_result: true,
+                      scope: Net::LDAP::SearchScope_BaseObject) do |entry|
+            metric[:value] = entry[metric[:attribute]]
+          end
+        end
+        return metrics
+      else
+        message = "Cannot connect to #{host}:#{config[:port]}"
+        if config[:user]
+          message += " as #{config[:user]}"
+        end
+        critical message
+      end
+    end
+  rescue
+    message = "Cannot connect to #{host}:#{config[:port]}"
+    message += " as #{config[:user]}"
+    critical message
+  end
+
+  def run
+    get_metrics(config[:host]).each do |_key, metric|
+      output [config[:scheme], metric[:title]].join('.'), metric[:value]
+    end
+    ok
+  end
+end

data/lib/sensu-plugins-openldap/version.rb

@@ -0,0 +1,28 @@
+require 'json'
+
+# encoding: utf-8
+module SensuPluginsOpenldap
+  # This defines the version of the gem
+  module Version
+    MAJOR = 0
+    MINOR = 0
+    PATCH = 1
+
+    VER_STRING = [MAJOR, MINOR, PATCH].compact.join('.')
+
+    NAME   = 'sensu-plugins-openldap'
+    BANNER = "#{NAME} v%s"
+
+    module_function
+
+    def version
+      format(BANNER, VER_STRING)
+    end
+
+    def json_version
+      {
+        'version' => VER_STRING
+      }.to_json
+    end
+  end
+end

data/lib/sensu-plugins-openldap.rb

@@ -0,0 +1,15 @@
+
+require 'sensu-plugins-openldap/version'
+
+# Load the defaults
+
+#
+# Default class
+#
+module SensuPluginsOpenldap
+  class << self
+  end
+
+  class << self
+  end
+end

metadata

@@ -0,0 +1,218 @@
+--- !ruby/object:Gem::Specification
+name: sensu-plugins-openldap
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sensu-Plugins and contributors
+autorequire: 
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDgDCCAmigAwIBAgIBATANBgkqhkiG9w0BAQUFADBDMRIwEAYDVQQDDAltYXR0
+  am9uZXMxGDAWBgoJkiaJk/IsZAEZFgh5aWVsZGJvdDETMBEGCgmSJomT8ixkARkW
+  A2NvbTAeFw0xNTAxMjgyMTAyNTFaFw0xNjAxMjgyMTAyNTFaMEMxEjAQBgNVBAMM
+  CW1hdHRqb25lczEYMBYGCgmSJomT8ixkARkWCHlpZWxkYm90MRMwEQYKCZImiZPy
+  LGQBGRYDY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAyTSzVYnO
+  CLgyrIyT1mBQakArQyW8xhi6MlDqyzXHJGeERT790U6EgoBVeS4XoK0ptFZNR8Tf
+  zko0w+Nv47TarSCgkPOaxY+mxWnAVR10dOmfeLr7huiMyps+YD56/EF2FqQ3jf/+
+  qohENfKD91qy1ieEy+Fn7Pf74ltbNKUdkb9a9eFXQ0DQ4ip5vik7DzjQkUTj4lca
+  k6ArwnmHX4YDhZoYtrQJ8jVktN0/+NtA40M5qkCYHNe5tUW25b/tKVYuioxG6b2Z
+  oIzaZxRLxf6HVAWpCVRT/F5+/yjigkX4u++eYacfLGleXQzoK7BL65vHGMJygWEE
+  0TKGqFOrl/L0AQIDAQABo38wfTAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNV
+  HQ4EFgQUEf6a8Td7MrSZc8ImbLFZAENPbz0wIQYDVR0RBBowGIEWbWF0dGpvbmVz
+  QHlpZWxkYm90LmNvbTAhBgNVHRIEGjAYgRZtYXR0am9uZXNAeWllbGRib3QuY29t
+  MA0GCSqGSIb3DQEBBQUAA4IBAQBbzXAYA3BVGw8DZ0YYoY1VHPNEcH5qPIApmHO8
+  rvSmuUT0yMEi7u00H/5uHRFf4LleGT/+sTdyXKsNPGT9kdRuQEgwi+vf7Zfvd8aX
+  UF/+4VkEYf/8rV8Ere6u2QaWPgApdMV6JjKr1fAwCTd8AuGXNaWItiPPMseSQzLJ
+  JKP4hVvbc1d+oS925B1lcBiqn2aYvElbyNAVmQPywNNqkWmvtlqj9ZVJfV5HQLdu
+  8sHuVruarogxxKPBzlL2is4EUb6oN/RdpGx2l4254+nyR+abg//Ed27Ym0PkB4lk
+  HP0m8WSjZmFr109pE/sVsM5jtOCvogyujQOjNVGN4gz1wwPr
+  -----END CERTIFICATE-----
+date: 2015-05-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sensu-plugin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.30'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.30'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: github-markup
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: Sensu plugins for openldap
+email: "<sensu-users@googlegroups.com>"
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- bin/check-syncrepl.rb
+- bin/metrics-ldap.rb
+- lib/sensu-plugins-openldap.rb
+- lib/sensu-plugins-openldap/version.rb
+homepage: https://github.com/sensu-plugins/sensu-plugins-openldap
+licenses:
+- MIT
+metadata:
+  maintainer: ''
+  development_status: active
+  production_status: unstable - testing recommended
+  release_draft: 'false'
+  release_prerelease: 'false'
+post_install_message: You can use the embedded Ruby by setting EMBEDDED_RUBY=true
+  in /etc/default/sensu
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Sensu plugins for openldap
+test_files: []