ldap_tools 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 87ea99ec2ff3fdf48a25f53868073540168f34fe
-  data.tar.gz: 918dd42c64afeb5ceec56935fc72c34ff57439fa
+  metadata.gz: 3c022535acfa6078a97828ec84635bf46696480f
+  data.tar.gz: d9e03db054a580a268acf7742226602dfae551b7
 SHA512:
-  metadata.gz: 208965f680e094e1afc62ee1a2b5c58f2d5a23e1afe11a1491beadea8dcdb21ab72bbfadefe0a5b763dee16b081bf36a439fd1d48bb0977456a55031bb8a3e14
-  data.tar.gz: b52b0151ad7114e7e36ccab2347b43ac7e340ac784ca2d654ecdb19da64c27632403eb37012fbae006ad7f8045011fbd8ef59ab1cc932f7a5a24670033649bd2
+  metadata.gz: 1c0129b763def56e8a9ec64715b0339634a86db95387438175a1ae50004eb7fd6be7300137030fd7850c56e0c12df2a7597a89341844c369c0b7f01060c453a4
+  data.tar.gz: 9ea951e5f59988399c2447ea32e451a05f8769d2356dd0d30a87e85bef000eca5605ff5ddab52006775b4ea97d95b2d0691b791ad960a7e94d48b18b36128ded

data/bin/ldaptools

@@ -25,10 +25,7 @@ when "user"  # run commands associated with user object
 when 'group'
   Tapjoy::LDAP::Group.commands
 when 'key'
-  KEY_SUB_COMMANDS = %w(add remove install list show)
-  commands('This object is used for group management', cmd, KEY_SUB_COMMANDS)
-  keys = Tapjoy::LDAP::Key.new
-  puts keys.show(ARGV.shift)
+  Tapjoy::LDAP::Key.commands
 when 'audit'
   AUDIT_SUB_COMMANDS = %w(by_user by_group raw)
   commands('This object is used for auditing LDAP permissions', cmd, AUDIT_SUB_COMMANDS)

data/lib/tapjoy/ldap/base.rb

@@ -44,6 +44,16 @@ module Tapjoy
         return return_result
       end
 
+      def add_attribute(distinguished_name, attribute, value)
+        @conn.add_attribute(dn, attribute, value)
+        return return_result
+      end
+
+      def replace_attribute(distinguished_name, attribute, value)
+        @conn.replace_attribute(distinguished_name, attribute, value)
+        return_result
+      end
+
       # Modify objects in LDAP
       def modify(distinguished_name, operations)
         @conn.modify(:dn => distinguished_name, :operations => operations)

data/lib/tapjoy/ldap/key.rb

@@ -1,196 +1,97 @@
+require_relative 'key/add'
+require_relative 'key/remove'
+require_relative 'key/show'
+require_relative 'key/install'
+
 module Tapjoy
   module LDAP
-    class Key
-
-      # Instantiate class
-      def initialize
-        command = ARGV.shift
-
-        case command
-        when 'add', 'remove', 'install', 'list'
-          send(command)
-        when 'show'
-          return
-        else
-          raise Tapjoy::LDAP::InvalidArgument
-        end
-      end
-
-      def show(user)
-        get_keys_from_ldap[user]
-      end
+    # Entry point for all key subcommands
+    module Key
+      class << self
+        SUB_COMMANDS = %w(add remove install list show)
 
-      ## Private methods start here ##
-      private
-      # Get key listing from LDAP
-      def get_keys_from_ldap
+        def commands
+          Trollop::options do
+            usage 'key [SUB_COMMAND] [options]'
+            synopsis "\nThis object is used for user key management\nAvailable subcommands are: #{SUB_COMMANDS}"
 
-        key_results = {}
-
-        results = Tapjoy::LDAP::client.search(attributes = ['uid', 'sshPublicKey'],
-                    filter = Net::LDAP::Filter.eq('sshPublicKey', '*'))
-
-        results.each { |result| key_results[result.uid[0]] = result.sshPublicKey }
-
-        return key_results
-      end
+            stop_on SUB_COMMANDS
+          end
 
-      # Retrieve keys from file/stdin
-      def get_keys_from_commandline(filename)
-        return_keys = []
+          cmd = ARGV.shift
 
-        if filename.eql?('-')
-          STDIN.each do |str|
-            return_keys << str.chomp!
+          case cmd
+          when 'add', 'remove', 'install', 'list', 'show'
+            send(cmd) # call method with respective name
+          else
+            raise Tapjoy::LDAP::InvalidArgument
           end
-        else
-          return_keys = Array(File.open(filename))
         end
 
-        return_keys.each { |key| verify(key) }
-        return return_keys
-      end
-
-      # Verify key format
-      def verify(key)
-        unless key.start_with?('ssh')
-          puts "Invalid key due to missing ssh key type:\n\n"
-          puts "\t#{ key }\n\n"
-          abort "Please verify your key and try again"
+        def add
+          key = Tapjoy::LDAP::Key::Add.new
+          key.add
         end
-      end
-
-      # Add key to LDAP
-      def add
-        opts = Trollop::options do
-          # Set help message
-          banner("#{$0} key add [options]")
 
-          opt :user, 'Specify username to add key to', :type => :string,
-              :required => true
-          opt :filename, 'File to load keys from', :type => :string, :default => '-'
+        def remove
+          key = Tapjoy::LDAP::Key::Remove.new
+          key.remove
         end
 
-        keys = get_keys_from_commandline(opts[:filename])
-
-        filter = Net::LDAP::Filter.eq('uid', opts[:user])
-        results = Tapjoy::LDAP::client.search(attributes = ['*'], filter = filter)
-
-        # Make sure we return one, and only one user DN
-        if results.size < 1
-          abort 'user not found'
-        elsif results.size > 1
-          abort 'Multiple users found. Please narrow your search.'
+        def install
+          key = Tapjoy::LDAP::Key::Install.new
+          key.install
         end
 
-        results.each  do |result|
-          unless result.objectclass.include?('ldapPublicKey')
-            puts 'LDAP Public Key Object Class not found.'
-            abort 'Please ensure user was created correctly.'
-          end
-          keys.each do |key|
-            Tapjoy::LDAP::client.conn.add_attribute(result.dn, :sshPublicKey, key)
-            puts Tapjoy::LDAP::client.return_result
-          end
+        def list
+          Tapjoy::LDAP::Key.get_keys_from_ldap
         end
-      end
 
-      # Remove key from LDAP
-      def remove
-        opts = Trollop::options do
-          # Set help message
-          banner("#{$0} key remove [options]")
-
-          opt :user, 'Specify username to delete key from', :type => :string,
-              :required => true
-          opt :filename, 'File to load key deletion list from', :type => :string,
-              :default => '-'
-          opt(:force, 'Force delete')
+        def show
+          key = Tapjoy::LDAP::Key::Show.new
+          key.show
         end
 
-        keys = get_keys_from_commandline(opts[:filename])
-
-        filter = Net::LDAP::Filter.eq('uid', opts[:user])
-        attributes = ['sshPublicKey']
-        old_array = []
-
-        new_array = []
+        def get_keys_from_ldap
 
-        results = Tapjoy::LDAP::client.search(attributes, filter)
-        if results.size < 1
-          puts "User (#{ opts[:user] }) not found."
-          abort 'Please check the username and try again'
-        elsif results.size > 1
-          abort 'Multiple users found. Please narrow your search.'
+          key_results = {}
+          filter = Net::LDAP::Filter.eq('sshPublicKey', '*')
+          attributes = %w(uid sshPublicKey)
+          results = Tapjoy::LDAP::client.search(attributes, filter)
+          results.each {|result| key_results[result.uid[0]] = result.sshPublicKey}
+          key_results
         end
 
-        results.each do |result|
-          @user_dn = result.dn
-          puts "User DN: #{ @user_dn }"
-          old_array = result.sshPublicKey
-        end
+        # Retrieve keys from file/stdin
+        def get_keys_from_commandline(filename=nil)
+          ARGV << filename unless filename.nil?
+          return_keys = []
 
-        keep_keys = old_array - keys
-        delete_keys = old_array & keys
-        keys_not_found = keys - old_array
-
-        puts 'Please confirm the following operations:'
-        puts "Keep these keys:\n\n"
-        print "\t #{ keep_keys }\n\n"
-        puts "Delete these keys:\n\n"
-        print "\t #{ delete_keys }\n\n"
-        puts "Ignore these keys (not found in LDAP for #{ opts[:user]}):\n\n"
-        print "\t #{ keys_not_found }\n\n"
-
-        # We have to create a new stdin here, because we already use stdin
-        # in the get_keys_from_commandline method.
-        fd = IO.sysopen('/dev/tty', 'w+')
-        unless opts[:force]
-          print '>'
-          confirm = ''
-          IO.open(fd, 'w+')  { |io| confirm = io.gets.chomp }
-          unless confirm.eql?('y') || confirm.eql?('yes')
-            abort("Deletion of #{ opts[:user] } aborted")
+          ARGF.each do |line|
+            return_keys << line.chomp!
           end
+          ARGV << '-'  # close ARGF
+          return_keys.each { |key| verify_key(key) }
+          return_keys
         end
 
-        Tapjoy::LDAP::client.conn.replace_attribute(@user_dn, :sshPublicKey, keep_keys)
-      end
-
-      # Install key on localhost
-      def install
-        opts = Trollop::options do
-          # Set help message
-          banner("#{$0} key install [options]")
-
-          opt :debug, 'Enable debug/dry-run mode'
-        end
-
-        # Store results of query
-        if opts[:debug]
-          puts search_results
-          exit 1
+        def verify_key(key)
+          unless key.start_with?('ssh')
+            puts "Invalid key due to missing ssh key type:\n\n"
+            puts "\t#{ key }\n\n"
+            abort "Please verify your key and try again"
+          end
         end
 
-        get_keys_from_ldap.each do |key,values|
-          directory = "/etc/ssh/users/#{key}"
-          FileUtils.mkdir_p(directory) unless File.exists?directory
-          keypath = "#{directory}/authorized_keys"
-          if File.exists?(keypath)
-            keys = File.read(keypath)
-          else
-            keys = []
-          end
-          File.open(keypath, 'a+') do |file|
-            file.puts values.reject { |value| keys.include?(value) }
+        def verify_user(user, results)
+          # Make sure we return one, and only one user DN
+          if results.size < 1
+            puts "User (#{user}) not found."
+            abort 'Please check the username and try again'
+          elsif results.size > 1
+            abort 'Multiple users found. Please narrow your search.'
           end
         end
-
-        # @TODO method to remove from authorized_keys any key that is not in LDAP
-      end
-
-      def list
-        puts get_keys_from_ldap
       end
     end
   end

data/lib/tapjoy/ldap/key/add.rb

@@ -0,0 +1,51 @@
+module Tapjoy
+  module LDAP
+    module Key
+      # Add user key to user profile
+      class Add
+        # Add key to LDAP
+        def add
+          filter_users.each  do |result|
+            confirm_ldap_schema(result)
+            keys.each do |key|
+              puts Tapjoy::LDAP::client.add_attribute(result.dn, :sshPublicKey, key)
+            end
+          end
+        end
+
+        private
+        def opts
+          @opts ||= Trollop::options do
+              # Set help message
+              usage 'key add [options]'
+              synopsis "\nThis command is for adding user keys to a given user's profile"
+
+              opt :user, 'Specify username to add key to', type: :string,
+                required: true
+              opt :filename, 'File to load keys from', type: :string
+          end
+        end
+
+        def keys
+          @keys ||= Tapjoy::LDAP::Key.get_keys_from_commandline(opts[:filename] || nil)
+        end
+
+        def filter_users
+          filter = Net::LDAP::Filter.eq('uid', opts[:user])
+          results = Tapjoy::LDAP::client.search(attributes = ['*'], filter = filter)
+
+          Tapjoy::LDAP::Key.verify_user(opts[:user], results)
+
+          results
+        end
+
+        def confirm_ldap_schema(result)
+          unless result.objectclass.include?('ldapPublicKey')
+            puts 'LDAP Public Key Object Class not found.'
+            abort 'Please ensure user was created correctly.'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tapjoy/ldap/key/install.rb

@@ -0,0 +1,46 @@
+module Tapjoy
+  module LDAP
+    module Key
+      # Install key on localhost
+      class Install
+        def install
+          Tapjoy::LDAP::Key.get_keys_from_ldap.each do |user, values|
+            directory = directory(user)
+            FileUtils.mkdir_p(directory) unless File.exists?directory
+            authorized_keys_file = "#{directory}/authorized_keys"
+            keys = load_keys_from_file(authorized_keys_file)
+            insert_keys(authorized_keys_file, keys, values)
+          end
+        end
+
+        private
+        def opts
+          @opts ||= Trollop::options do
+              # Set help message
+              usage 'key install [options]'
+              synopsis "\nThis command is for keys to the appropriate authorized_keys file"
+
+          end
+        end
+
+        def load_keys_from_file(authorized_keys_file)
+          if File.exists?(authorized_keys_file)
+            keys = File.read(authorized_keys_file)
+          else
+            keys = []
+          end
+        end
+
+        def insert_keys(authorized_keys_file, keys, values)
+          File.open(authorized_keys_file, 'a+') do |file|
+            file.puts values.reject { |value| keys.include?(value) }
+          end
+        end
+
+        def directory(user)
+          File.join('etc', 'ssh', 'users', user)
+        end
+      end
+    end
+  end
+end

data/lib/tapjoy/ldap/key/remove.rb

@@ -0,0 +1,92 @@
+module Tapjoy
+  module LDAP
+    module Key
+      # Remove a user key from user profile
+      class Remove
+        # Remove key from LDAP
+        def remove
+          keys  # Get keys first
+          Tapjoy::LDAP::Key.verify_user(opts[:user], results)
+
+          confirm unless opts[:force]
+          Tapjoy::LDAP::client.replace_attribute(
+            @user_dn, :sshPublicKey, keep_keys)
+        end
+
+        private
+        def opts
+          @opts ||= Trollop::options do
+            # Set help message
+            usage 'key remove [options]'
+            synopsis "\nThis command is for removing a user's SSH key(s)"
+
+            opt :user, 'Specify username to delete key from', type: :string,
+                required: true
+            opt :filename, 'File to load key deletion list from', type: :string
+            opt :force, 'Force delete', short: '-F'
+          end
+        end
+
+        def keys
+          @keys ||= Tapjoy::LDAP::Key.get_keys_from_commandline(opts[:filename])
+        end
+
+        def filter
+          @filter ||= Net::LDAP::Filter.eq('uid', opts[:user])
+        end
+
+        def results
+          @results ||= Tapjoy::LDAP::client.search(['sshPublicKey'], filter)
+        end
+
+        def current_keys
+          @current_keys ||= begin
+            current_keys_array = []
+            results.each do |result|
+              @user_dn = result.dn
+              current_keys_array = result.sshPublicKey
+            end
+
+            current_keys_array
+          end
+        end
+
+        def keep_keys
+          @keep_keys ||= current_keys.flatten - keys.flatten
+        end
+
+        def delete_keys
+          @delete_keys ||= current_keys & keys
+        end
+
+        def keys_not_found
+          @keys_not_found ||= keys - current_keys
+        end
+
+        def confirm
+          puts 'Please confirm the following operations:'
+          puts "Keep these keys:\n\n"
+          print "\t #{ keep_keys }\n\n"
+          puts "Delete these keys:\n\n"
+          print "\t #{ delete_keys }\n\n"
+          puts "Ignore these keys (not found in LDAP for #{ opts[:user]}):\n\n"
+          print "\t #{ keys_not_found }\n\n"
+          get_confirmation
+        end
+
+        def fd
+          @fd ||= IO.sysopen('/dev/tty', 'w+')
+        end
+
+        def get_confirmation
+          print '>'
+          confirm = gets.chomp
+          # IO.open(fd, 'w+')  { |io| confirm = io.gets.chomp }
+          unless confirm.eql?('y') || confirm.eql?('yes')
+            abort("Deletion of #{ opts[:user] } aborted")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tapjoy/ldap/key/show.rb

@@ -0,0 +1,27 @@
+module Tapjoy
+  module LDAP
+    module Key
+      # Show all of a user's keys
+      class Show
+        def show
+          username = opts[:user]
+          keys = Tapjoy::LDAP::Key.get_keys_from_ldap[username]
+          puts "No keys found for #{opts[:user]}" if keys.length? 0
+          puts keys
+        end
+
+        private
+        def opts
+          @opts ||= Trollop::options do
+              # Set help message
+              usage 'key show [options]'
+              synopsis "\nThis command is for showing a specific user's SSH keys"
+
+              opt :user, 'Specify username', type: :string, required: true
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/tapjoy/ldap/version.rb

@@ -2,7 +2,7 @@ module Tapjoy
   module LDAP
     module Version
       MAJOR = 0
-      MINOR = 5
+      MINOR = 6
       PATCH = 0
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ldap_tools
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Ali Tayarani
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-14 00:00:00.000000000 Z
+date: 2016-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trollop
@@ -76,9 +76,6 @@ files:
 - bin/ldaptools
 - lib/tapjoy/ldap.rb
 - lib/tapjoy/ldap/audit.rb
-- lib/tapjoy/ldap/audit/by_group.rb
-- lib/tapjoy/ldap/audit/by_user.rb
-- lib/tapjoy/ldap/audit/raw.rb
 - lib/tapjoy/ldap/base.rb
 - lib/tapjoy/ldap/group.rb
 - lib/tapjoy/ldap/group/add_user.rb
@@ -86,7 +83,7 @@ files:
 - lib/tapjoy/ldap/group/delete.rb
 - lib/tapjoy/ldap/key.rb
 - lib/tapjoy/ldap/key/add.rb
-- lib/tapjoy/ldap/key/list.rb
+- lib/tapjoy/ldap/key/install.rb
 - lib/tapjoy/ldap/key/remove.rb
 - lib/tapjoy/ldap/key/show.rb
 - lib/tapjoy/ldap/user.rb