password_expiration_notifier 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 899afe284850302b370bd0dceb6d95958af4e502
+  data.tar.gz: 7c52076152fb3f104e781c4b4c80c5b0090cc21f
+SHA512:
+  metadata.gz: 8590de419afac472a17a94258de6f015cc570c03f516362c476201a380ae7df0b22e49cd1b99cd348cc2ca4fa2bbf96323cf97b79255de52a54f0c4cf7c34c50
+  data.tar.gz: 06aba3cab05436bf3779ae17c8eb4cd71358abf2cc75f1972ecb4f2c23c5bbcecb7c5490cfb368674eba547515cfac7b3cabc261b857455b4e983be77f3a2914

data/.gitignore

@@ -0,0 +1,16 @@
+/vendor/
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+notifier.config

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in password_expire_notify.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 ISOBE Kazuhiko
+
+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,31 @@
+# PasswordExpirationNotifier
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'password_expiration_notifier'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install password_expiration_notifier
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/muramasa64/password_expiration_notifier/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/password_expiration_notifier

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'password_expiration_notifier'
+
+PasswordExpirationNotifier::CLI.start

data/lib/password_expiration_notifier.rb

@@ -0,0 +1,5 @@
+require "password_expiration_notifier/version"
+require 'password_expiration_notifier/cli'
+require 'password_expiration_notifier/ldap'
+require 'password_expiration_notifier/utils'
+require 'password_expiration_notifier/slack'

data/lib/password_expiration_notifier/cli.rb

@@ -0,0 +1,70 @@
+require 'password_expiration_notifier'
+require 'password_expiration_notifier/utils'
+require 'thor'
+
+module PasswordExpirationNotifier
+  class CLI < Thor
+    include Utils
+    class_option :config,
+      aliases: [:c],
+      type: :string,
+      desc: "use config file",
+      default: "notifier.config"
+    class_option :debug,
+      type: :boolean,
+      desc: "debug mode"
+
+    desc "list [--all] [--expire-within=DAYS]", "show account list of Active Directory"
+    option :all,
+      aliases: [:a],
+      type: :boolean,
+      desc: "show all accounts"
+    option :expire_within,
+      aliases: [:e],
+      type: :numeric,
+      desc: "expire within n days",
+      default: 7
+    option :expiration_days,
+      aliases: [:d],
+      type: :numeric,
+      desc: "password expiration days",
+      default: 90
+    option :exclude_expired,
+      aliases: [:x],
+      type: :boolean,
+      desc: "exclude password expiration",
+      default: true
+    def list()
+      users = fetch_users(config(options))
+      show_list(users)
+    end
+
+    desc "notify [--expire-within=DAYS] [--dry-run]", "send notify mail to the account it expires"
+    option :expire_within,
+      aliases: [:e],
+      type: :numeric,
+      desc: "expire within n days",
+      default: 7
+    option :expiration_days,
+      aliases: [:d],
+      type: :numeric,
+      desc: "password expiration days",
+      default: 90
+    option :dry_run,
+      type: :boolean,
+      desc: "show list only. do not sent notify"
+    option :exclude_expired,
+      aliases: [:x],
+      type: :boolean,
+      desc: "exclude password expiration",
+      default: true
+    def notify()
+      conf = config(options)
+      users = fetch_users(conf)
+      slack = PasswordExpirationNotifier::Slack.new(conf)
+      users.each do |user|
+        slack.notify_to(user)
+      end
+    end
+  end
+end

data/lib/password_expiration_notifier/config.rb

@@ -0,0 +1,38 @@
+require 'password_expiration_notifier'
+require 'ostruct'
+require 'yaml'
+
+module PasswordExpirationNotifier
+  class Config < OpenStruct
+    def initialize(options = nil)
+      @table = {}
+      @hash_table = {}
+
+      if options
+        if options[:config]
+          conf = YAML.load_file(options[:config])
+          @table, @hash_table = load_config(conf)
+        end
+
+        @table, @hash_table = load_config(options, @table, @hash_table)
+      end
+    end
+
+    def to_h
+      @hash_table
+    end
+
+    private
+    def load_config(conf, table = {}, hash_table = {})
+      table = table.dup
+      hash_table = hash_table.dup
+      conf.each do |k,v|
+        table[k.to_sym] = (v.is_a?(Hash) ? self.class.new(v) : v)
+        hash_table[k.to_sym] = v
+
+        new_ostruct_member(k)
+      end
+      [table, hash_table]
+    end
+  end
+end

data/lib/password_expiration_notifier/ldap.rb

@@ -0,0 +1,50 @@
+require 'password_expiration_notifier'
+require 'net/ldap'
+
+module PasswordExpirationNotifier
+  class LDAP
+    def initialize(conf)
+      opt = conf.ldap.to_h
+      opt[:auth] = {
+        username: conf.ldap.user,
+        password: conf.ldap.password,
+        method:   :simple
+      }
+      @filters = []
+      @connection = Net::LDAP.new(opt)
+    end
+
+    def add_filter(key, value)
+      @filters << Net::LDAP::Filter.eq(key, value)
+    end
+
+    def users(key = nil, value = nil)
+      users = {}
+      if @connection.bind
+        filter = @filters.inject {|f1, f2| f1 & f2}
+        @connection.search(filter: filter, return_result: false) do |entry|
+          # UserAccountControl flag 0x0002 => ACCOUNTDISABLE
+          # see https://support.microsoft.com/en-us/kb/305144
+          next unless entry['UserAccountControl'].first.to_i & 0x0002 == 0
+          entries = {}
+          entry.each do |attr, values|
+            entries[attr] = values.size == 1 ? values.first : values
+          end
+          users[entry['sAMAccountName'].first] = entries
+        end
+      end
+      users.map do |k,v|
+        v[:pwdlastset] = LDAP.windows_time_to_ruby_time(v[:pwdlastset])
+        [k, v]
+      end
+    end
+
+    class << self
+      def windows_time_to_ruby_time(windows_time)
+        unix_time = (windows_time.to_i)/10000000-11644473600
+        Time.at(unix_time)
+      end
+    end
+  end
+end
+

data/lib/password_expiration_notifier/slack.rb

@@ -0,0 +1,27 @@
+require 'password_expiration_notifier'
+require 'slack-notify'
+
+module PasswordExpirationNotifier
+  class Slack
+    def initialize(conf)
+      @conf = conf
+    end
+
+    def notify_to(user)
+      attr = user.last
+      client = SlackNotify::Client.new(
+        webhook_url: @conf.slack.webhook_url,
+        channel: "@#{attr[:samaccountname]}",
+        icon_url: @conf.slack.icon_url,
+        icon_emoji: @conf.slack.icon_emoji,
+        link_names: @conf.slack.link_names
+      )
+      message = "Your domain account #{attr[:samaccountname]}'s password expire at #{attr[:expire_at]}. Please update your password."
+      if @conf.dry_run
+        puts message
+      else
+        client.notify(message)
+      end
+    end
+  end
+end

data/lib/password_expiration_notifier/utils.rb

@@ -0,0 +1,73 @@
+require 'password_expiration_notifier'
+require 'password_expiration_notifier/ldap'
+require 'password_expiration_notifier/config'
+require 'date'
+
+module PasswordExpirationNotifier
+  module Utils
+
+    def now
+      @now ||= Time.now
+    end
+
+    def remaining(password_last_set_t, expiration_days)
+      -((now - password_last_set_t).divmod(24*60*60)[0] - expiration_days)
+    end
+
+    def expire_at(password_last_set_t, expiration_days)
+      password_last_set_t + (24 * 60 * 60 * expiration_days)
+    end
+
+    def expire_soon?(remaining, expire_within)
+      remaining <= 0 || remaining <= expire_within
+    end
+
+    def expired?(remaining, expire_within)
+      remaining <= 0 || remaining > expire_within
+    end
+
+    def show_list(users)
+      puts "username\tdescription\texpire_at\tremaining"
+      users.sort_by {|user| user[1][:remaining] }.each do |user|
+        attr = user[1]
+        puts "#{attr[:samaccountname]}\t#{attr[:description]}\t#{attr[:expire_at]}\t#{attr[:remaining]}"
+      end
+    end
+
+    def select(attr, conf)
+      if options[:all]
+        attr
+      else
+        if conf.exclude_expired && !expired?(attr[:remaining], conf.expire_within)
+          attr
+        end
+        if expire_soon?(attr[:remaining], conf.expire_within)
+        end
+      end
+
+    end
+
+    def fetch_users(conf)
+      ad = PasswordExpirationNotifier::LDAP.new(conf)
+      ad.add_filter('objectClass', 'user')
+      if conf.ldap.filterkey && conf.ldap.filtervalue
+        ad.add_filter(conf.ldap.filterkey, conf.ldap.filtervalue)
+      end
+
+      selected_users = {}
+      ad.users.each do |user, attr|
+        attr[:remaining] = remaining(attr[:pwdlastset], conf.expiration_days)
+        attr[:expire_at] = expire_at(attr[:pwdlastset], conf.expiration_days)
+        if options[:all] || expire_soon?(attr[:remaining], conf.expire_within)
+          next if conf.exclude_expired && attr[:remaining] <= 0
+          selected_users[user] = attr
+        end
+      end
+      selected_users
+    end
+
+    def config(options)
+      PasswordExpirationNotifier::Config.new(options)
+    end
+  end
+end

data/lib/password_expiration_notifier/version.rb

@@ -0,0 +1,3 @@
+module PasswordExpirationNotifier
+  VERSION = "0.1.0"
+end

data/notifier.config.sample

@@ -0,0 +1,15 @@
+---
+expire_within: 7
+expiration_days: 20
+ldap:
+  user: "user@example.local"
+  password: "user password"
+  base: "dc=example,dc=local"
+  host: "ldap.example.local"
+  port: 389
+  filterkey: "filter key"
+  filtervalue: "filter value"
+slack:
+  webhook_url: "webhook_url"
+  icon_url: "icon_url"
+  icon_emoji: ":icon_emoji:"

data/password_expiration_notifier.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'password_expiration_notifier/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "password_expiration_notifier"
+  spec.version       = PasswordExpirationNotifier::VERSION
+  spec.authors       = ["ISOBE Kazuhiko"]
+  spec.email         = ["muramasa64@gmail.com"]
+  spec.summary       = %q{Notify the password expiration date of the Active Directory account}
+  spec.description   = %q{Notify the password expiration date of the Active Directory account}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+
+  spec.add_dependency "thor"
+  spec.add_dependency "activeldap"
+  spec.add_dependency "net-ldap"
+  spec.add_dependency "slack-notify"
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: password_expiration_notifier
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ISOBE Kazuhiko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-02 00:00:00.000000000 Z
+dependencies:
+- !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: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activeldap
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: net-ldap
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: slack-notify
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Notify the password expiration date of the Active Directory account
+email:
+- muramasa64@gmail.com
+executables:
+- password_expiration_notifier
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/password_expiration_notifier
+- lib/password_expiration_notifier.rb
+- lib/password_expiration_notifier/cli.rb
+- lib/password_expiration_notifier/config.rb
+- lib/password_expiration_notifier/ldap.rb
+- lib/password_expiration_notifier/slack.rb
+- lib/password_expiration_notifier/utils.rb
+- lib/password_expiration_notifier/version.rb
+- notifier.config.sample
+- password_expiration_notifier.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+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: Notify the password expiration date of the Active Directory account
+test_files: []