open_directory_utils 0.1.6 → 0.1.7

data/lib/open_directory_utils/commands_user_create_remove.rb

@@ -1,6 +1,8 @@
 # require "open_directory_utils/dscl"
 require "open_directory_utils/clean_check"
 require "open_directory_utils/commands_base"
+require "open_directory_utils/commands_groups"
+require "open_directory_utils/commands_user_attribs"
 
 module OpenDirectoryUtils
 
@@ -13,350 +15,8 @@ module OpenDirectoryUtils
     # include OpenDirectoryUtils::Dscl
     include OpenDirectoryUtils::CleanCheck
     include OpenDirectoryUtils::CommandsBase
-
-    # GET INFO
-    ##########
-    # get user record -- dscl . -read /Users/<username>
-    # get user value  -- dscl . -read /Users/<username> <key>
-    # search od user  -- dscl . -search /Users RealName "Andrew Garrett"
-    # return as xml   -- dscl -plist . -search /Users RealName "Andrew Garrett"
-    def user_get_info(attribs, dir_info)
-      attribs = user_record_name_alternatives(attribs)
-
-      check_critical_attribute( attribs, :record_name )
-      attribs    = tidy_attribs(attribs)
-
-      command    = {action: 'read', scope: 'Users', attribute: nil, value: nil}
-      user_attrs = attribs.merge(command)
-
-      dscl( user_attrs, dir_info )
-    end
-    alias_method :user_info, :user_get_info
-
-    # get all usernames -- dscl . -list /Users
-    # get all user details -- dscl . -readall /Users
-    def user_exists?(attribs, dir_info)
-      user_get_info(attribs, dir_info)
-    end
-
-    # CHANGE OD
-    ###########
-    # /usr/bin/dscl -u diradmin -P A-B1g-S3cret /LDAPv3/127.0.0.1 -create /Users/$USER RealName "$VALUE"
-    def user_set_real_name(attribs, dir_info)
-      attribs = user_record_name_alternatives(attribs)
-
-      attribs[:value] = attribs[:value] || attribs[:common_name]
-      attribs[:value] = attribs[:value] || attribs[:cn]
-      attribs[:value] = attribs[:value] || attribs[:realname]
-      attribs[:value] = attribs[:value] || attribs[:real_name]
-      attribs[:value] = attribs[:value] || attribs[:fullname]
-      attribs[:value] = attribs[:value] || attribs[:full_name]
-      if attribs[:last_name] or attribs[:first_name]
-        attribs[:value] = attribs[:value] || "#{attribs[:first_name]} #{attribs[:last_name]}"
-      end
-      attribs[:value] = attribs[:value] || attribs[:record_name]
-
-      check_critical_attribute( attribs, :record_name )
-      check_critical_attribute( attribs, :value, :real_name )
-      attribs    = tidy_attribs(attribs)
-
-      command    = {action: 'create', scope: 'Users', attribute: 'RealName'}
-      user_attrs = attribs.merge(command)
-
-      dscl( user_attrs, dir_info )
-    end
-
-    # /usr/bin/dscl -u diradmin -P A-B1g-S3cret /LDAPv3/127.0.0.1 -create /Users/$shortname_USERNAME FirstName "$VALUE"
-    def user_set_first_name(attribs, dir_info)
-      attribs = user_record_name_alternatives(attribs)
-
-      attribs[:value] = attribs[:value] || attribs[:given_name]
-      attribs[:value] = attribs[:value] || attribs[:givenname]
-      attribs[:value] = attribs[:value] || attribs[:first_name]
-      attribs[:value] = attribs[:value] || attribs[:firstname]
-
-      check_critical_attribute( attribs, :record_name )
-      check_critical_attribute( attribs, :value, :first_name )
-      attribs    = tidy_attribs(attribs)
-
-      command    = {action: 'create', scope: 'Users', attribute: 'FirstName'}
-      user_attrs = attribs.merge(command)
-
-      dscl( user_attrs, dir_info )
-    end
-
-    # /usr/bin/dscl -u diradmin -P A-B1g-S3cret /LDAPv3/127.0.0.1 -create /Users/$shortname_USERNAME LastName "$VALUE"
-    def user_set_last_name(attribs, dir_info)
-      attribs = user_record_name_alternatives(attribs)
-
-      attribs[:value] = attribs[:value] || attribs[:sn]
-      attribs[:value] = attribs[:value] || attribs[:surname]
-      attribs[:value] = attribs[:value] || attribs[:lastname]
-      attribs[:value] = attribs[:value] || attribs[:last_name]
-      attribs[:value] = attribs[:value] || attribs[:real_name]
-      attribs[:value] = attribs[:value] || attribs[:realname]
-      attribs[:value] = attribs[:value] || attribs[:short_name]
-      attribs[:value] = attribs[:value] || attribs[:shortname]
-      attribs[:value] = attribs[:value] || attribs[:user_name]
-      attribs[:value] = attribs[:value] || attribs[:username]
-      attribs[:value] = attribs[:value] || attribs[:uid]
-
-      check_critical_attribute( attribs, :record_name )
-      check_critical_attribute( attribs, :value, :last_name )
-      attribs    = tidy_attribs(attribs)
-
-      command    = {action: 'create', scope: 'Users', attribute: 'LastName'}
-      user_attrs = attribs.merge(command)
-
-      dscl( user_attrs, dir_info )
-    end
-
-    # sudo dscl . -create /Users/someuser UniqueID "1010"
-    def user_set_unique_id(attribs, dir_info)
-      attribs = user_record_name_alternatives(attribs)
-      check_critical_attribute( attribs, :record_name )
-
-      attribs[:value] = attribs[:value] || attribs[:uniqueid]
-      attribs[:value] = attribs[:value] || attribs[:unique_id]
-      attribs[:value] = attribs[:value] || attribs[:uid_number]
-      attribs[:value] = attribs[:value] || attribs[:uidnumber]
-      attribs[:value] = attribs[:value] || attribs[:usernumber]
-      attribs[:value] = attribs[:value] || attribs[:user_number]
-
-      check_critical_attribute( attribs, :value, :unique_id )
-      attribs    = tidy_attribs(attribs)
-
-      command    = {action: 'create', scope: 'Users', attribute: 'UniqueID'}
-      user_attrs = attribs.merge(command)
-
-      dscl( user_attrs, dir_info )
-    end
-
-    # /usr/bin/dscl -u diradmin -P A-B1g-S3cret /LDAPv3/127.0.0.1 -create /Users/someuser NFSHomeDirectory /Users/someuser
-    def user_set_nfs_home_directory(attribs, dir_info)
-      attribs = user_record_name_alternatives(attribs)
-
-      attribs[:value] = attribs[:value] || attribs[:home_directory]
-      attribs[:value] = attribs[:value] || attribs[:nfs_home_directory]
-      attribs[:value] = attribs[:value] || '/Volumes/Macintosh HD/Users/someone'
-
-      check_critical_attribute( attribs, :record_name )
-      check_critical_attribute( attribs, :value, :home_directory )
-      attribs    = tidy_attribs(attribs)
-
-      command    = {action: 'create', scope: 'Users', attribute: 'NFSHomeDirectory'}
-      user_attrs = attribs.merge(command)
-
-      dscl( user_attrs, dir_info )
-    end
-
-    # sudo dscl . -create /Users/someuser UserShell /bin/bash
-    def user_set_shell(attribs, dir_info)
-      attribs = user_record_name_alternatives(attribs)
-
-      attribs[:value] = attribs[:value] || attribs[:user_shell]
-      attribs[:value] = attribs[:value] || attribs[:shell]
-      attribs[:value] = attribs[:value] || '/bin/bash'
-
-      check_critical_attribute( attribs, :record_name )
-      check_critical_attribute( attribs, :value, :shell )
-      attribs    = tidy_attribs(attribs)
-
-      command    = {action: 'create', scope: 'Users', attribute: 'UserShell'}
-      user_attrs = attribs.merge(command)
-
-      dscl( user_attrs, dir_info )
-    end
-
-    # /usr/bin/dscl -u diradmin -P A-B1g-S3cret /LDAPv3/127.0.0.1 -create /Users/$shortname_USERNAME mail "$VALUE"
-    # /usr/bin/dscl -u diradmin -P A-B1g-S3cret /LDAPv3/127.0.0.1 -create /Users/$shortname_USERNAME email "$VALUE"
-    # /usr/bin/dscl -u diradmin -P A-B1g-S3cret /LDAPv3/127.0.0.1 -create /Users/$shortname_USERNAME apple-user-mailattribute "$VALUE"
-    def user_set_first_email(attribs, dir_info)
-      attribs = user_record_name_alternatives(attribs)
-
-      attribs[:value] = attribs[:value] || attribs['apple-user-mailattribute']
-      attribs[:value] = attribs[:value] || attribs[:apple_user_mailattribute]
-      attribs[:value] = attribs[:value] || attribs[:email]
-      attribs[:value] = attribs[:value] || attribs[:mail]
-
-      check_critical_attribute( attribs, :record_name )
-      check_critical_attribute( attribs, :value, :email )
-      attribs    = tidy_attribs(attribs)
-
-      answer     = []
-
-      command    = {action: 'create', scope: 'Users', attribute: 'MailAttribute'}
-      user_attrs = attribs.merge(command)
-      answer    << dscl( user_attrs, dir_info )
-
-      command    = {action: 'create', scope: 'Users', attribute: 'EMailAddress'}
-      user_attrs = attribs.merge(command)
-      answer    << dscl( user_attrs, dir_info )
-
-      # command    = {action: 'create', scope: 'Users', attribute: 'apple-user-mailattribute'}
-      # user_attrs = attribs.merge(command)
-      # answer    << dscl( user_attrs, dir_info )
-
-      return answer
-    end
-    alias_method :user_set_email, :user_set_first_email
-
-    def user_append_email(attribs, dir_info)
-      attribs = user_record_name_alternatives(attribs)
-
-      attribs[:value] = attribs[:value] || attribs['apple-user-mailattribute']
-      attribs[:value] = attribs[:value] || attribs[:apple_user_mailattribute]
-      attribs[:value] = attribs[:value] || attribs[:e_mail_attribute]
-      attribs[:value] = attribs[:value] || attribs[:mail_attribute]
-      attribs[:value] = attribs[:value] || attribs[:email]
-      attribs[:value] = attribs[:value] || attribs[:mail]
-
-      check_critical_attribute( attribs, :record_name )
-      check_critical_attribute( attribs, :value, :email )
-      attribs    = tidy_attribs(attribs)
-
-      answer     = []
-
-      # command    = {action: 'append', scope: 'Users', attribute: 'mail'}
-      # user_attrs = attribs.merge(command)
-      # answer    << dscl( user_attrs, dir_info )
-
-      command    = {action: 'append', scope: 'Users', attribute: 'email'}
-      user_attrs = attribs.merge(command)
-      answer    << dscl( user_attrs, dir_info )
-
-      return answer
-    end
-
-    # sudo dscl . -create /Users/someuser PrimaryGroupID 80
-    def user_set_primary_group_id(attribs, dir_info)
-      attribs = user_record_name_alternatives(attribs)
-
-      attribs[:value] = attribs[:value] || attribs[:groupid]
-      attribs[:value] = attribs[:value] || attribs[:group_id]
-      attribs[:value] = attribs[:value] || attribs[:gidnumber]
-      attribs[:value] = attribs[:value] || attribs[:groupnumber]
-      attribs[:value] = attribs[:value] || attribs[:group_number]
-      attribs[:value] = attribs[:value] || attribs[:primarygroupid]
-      attribs[:value] = attribs[:value] || attribs[:primary_group_id]
-
-      check_critical_attribute( attribs, :record_name )
-      check_critical_attribute( attribs, :value, :group_id )
-      attribs    = tidy_attribs(attribs)
-
-      command    = {action: 'create', scope: 'Users', attribute: 'PrimaryGroupID'}
-      user_attrs = attribs.merge(command)
-
-      dscl( user_attrs, dir_info )
-    end
-
-    # /usr/bin/pwpolicy -a diradmin -p "TopSecret" -u username -setpassword "AnotherSecret"
-    # /usr/bin/dscl -plist -u diradmin -P #{adminpw} /LDAPv3/127.0.0.1 -passwd /Users/#{shortname} "#{passwd}"
-    def user_set_password(attribs, dir_info)
-      attribs = user_record_name_alternatives(attribs)
-
-      attribs[:value] = attribs[:value] || attribs[:password]
-      attribs[:value] = attribs[:value] || attribs[:passwd]
-      attribs[:value] = attribs[:value] || '*'
-
-      check_critical_attribute( attribs, :record_name )
-      check_critical_attribute( attribs, :value, :password )
-      attribs    = tidy_attribs(attribs)
-
-      command    = {action: 'passwd', scope: 'Users'}
-      user_attrs = attribs.merge(command)
-
-      dscl( user_attrs, dir_info )
-    end
-    # /usr/bin/dscl /LDAPv3/127.0.0.1 -auth #{shortname} "#{passwd}"
-    def user_password_verified?(attribs, dir_info)
-      attribs = user_record_name_alternatives(attribs)
-
-      attribs[:value] = attribs[:value] || attribs[:password]
-      attribs[:value] = attribs[:value] || attribs[:passwd]
-
-      check_critical_attribute( attribs, :record_name )
-      check_critical_attribute( attribs, :value, :password )
-      attribs    = tidy_attribs(attribs)
-
-      command    = {action: 'auth', scope: 'Users'}
-      user_attrs = attribs.merge(command)
-
-      dscl( user_attrs, dir_info )
-    end
-    alias_method :user_password_ok?, :user_password_verified?
-
-    # /usr/bin/pwpolicy -a diradmin -p A-B1g-S3cret -u $shortname_USERNAME -setpolicy "isDisabled=0"
-    def user_enable_login(attribs, dir_info)
-      attribs = user_record_name_alternatives(attribs)
-
-      check_critical_attribute( attribs, :record_name )
-      attribs    = tidy_attribs(attribs)
-
-      command = {attribute: 'enableuser', value: nil}
-      params  = command.merge(attribs)
-      pwpolicy(params, dir_info)
-    end
-    # /usr/bin/pwpolicy -a diradmin -p A-B1g-S3cret -u $shortname_USERNAME -setpolicy "isDisabled=1"
-    def user_disable_login(attribs, dir_info)
-      attribs = user_record_name_alternatives(attribs)
-
-      check_critical_attribute( attribs, :record_name )
-      attribs    = tidy_attribs(attribs)
-
-      command = {attribute: 'disableuser', value: nil}
-      params  = command.merge(attribs)
-      pwpolicy(params, dir_info)
-    end
-
-    def user_add_to_group(attribs, dir_info)
-      attribs = user_record_name_alternatives(attribs)
-
-      attribs[:value] = attribs[:group_membership]
-      attribs[:value] = attribs[:value] || attribs[:groupmembership]
-      attribs[:value] = attribs[:value] || attribs[:group_name]
-      attribs[:value] = attribs[:value] || attribs[:groupname]
-      attribs[:value] = attribs[:value] || attribs[:gid]
-
-      check_critical_attribute( attribs, :record_name, :username )
-      check_critical_attribute( attribs, :value, :groupname )
-      attribs    = tidy_attribs(attribs)
-      command    = { operation: 'edit', action: 'add', type: 'user'}
-      user_attrs  = attribs.merge(command)
-
-      dseditgroup( user_attrs, dir_info )
-    end
-
-    def user_remove_from_group(attribs, dir_info)
-      attribs = user_record_name_alternatives(attribs)
-
-      attribs[:value] = attribs[:group_membership]
-      attribs[:value] = attribs[:value] || attribs[:groupmembership]
-      attribs[:value] = attribs[:value] || attribs[:group_name]
-      attribs[:value] = attribs[:value] || attribs[:groupname]
-      attribs[:value] = attribs[:value] || attribs[:gid]
-
-      check_critical_attribute( attribs, :record_name, :username )
-      check_critical_attribute( attribs, :value, :groupname )
-      attribs    = tidy_attribs(attribs)
-      command    = { operation: 'edit', action: 'delete', type: 'user'}
-      user_attrs  = attribs.merge(command)
-
-      dseditgroup( user_attrs, dir_info )
-    end
-
-    # /usr/bin/pwpolicy -a diradmin -p A-B1g-S3cret -u $shortname_USERNAME -getpolicy
-    def user_get_policy(attribs, dir_info)
-      attribs = user_record_name_alternatives(attribs)
-
-      check_critical_attribute( attribs, :record_name )
-      attribs    = tidy_attribs(attribs)
-
-      command = {attribute: 'getpolicy', value: nil}
-      params  = command.merge(attribs)
-      pwpolicy(params, dir_info)
-    end
-    alias_method :user_login_enabled?,  :user_get_policy
+    include OpenDirectoryUtils::CommandsGroups
+    include OpenDirectoryUtils::CommandsUserAttribs
 
     # https://images.apple.com/server/docs/Command_Line.pdf
     # https://serverfault.com/questions/20702/how-do-i-create-user-accounts-from-the-terminal-in-mac-os-x-10-5?utm_medium=organic&utm_source=google_rich_qa&utm_campaign=google_rich_qa
@@ -415,15 +75,77 @@ module OpenDirectoryUtils
         attribs[:value] = nil
         answer         << user_set_first_name(attribs, dir_info)
       end
-      # skip email if non-sent
       if attribs[:email] or attribs[:mail] or attribs[:apple_user_mailattribute]
         attribs[:value] = nil
         answer         << user_set_email(attribs, dir_info)
       end
-      # TODO add to groups without error - if group present
-      # "<main> attribute status: eDSSchemaError\n" +
-      # "<dscl_cmd> DS Error: -14142 (eDSSchemaError)"]
-      # # enroll in a group membership if info present
+      if attribs[:relations] or attribs[:relationships]
+        attribs[:value] = nil
+        answer         << user_set_relationships(attribs, dir_info)
+      end
+      if attribs[:org_info] or attribs[:organization_info]
+        attribs[:value] = nil
+        answer         << user_set_organization_info(attribs, dir_info)
+      end
+      if attribs[:group_name] or attribs[:groupname] or attribs[:gid] or
+                        attribs[:group_membership] or attribs[:groupmembership]
+        attribs[:value] = nil
+        answer         << user_add_to_group(attribs, dir_info)
+      end
+
+      return answer.flatten
+    end
+
+    def user_update(attribs, dir_info)
+      attribs = user_record_name_alternatives(attribs)
+
+      check_critical_attribute( attribs, :record_name )
+      # attribs           = tidy_attribs(attribs).dup
+      attribs           = tidy_attribs(attribs)
+
+      answer            = []
+      if attribs[:shell]
+        attribs[:value] = nil
+        answer         << user_set_shell(attribs, dir_info)
+      end
+      if attribs[:last_name] or attribs[:lastname] or attribs[:surname] or attribs[:sn]
+        attribs[:value] = nil
+        answer         << user_set_last_name(attribs, dir_info)
+      end
+      if attribs[:real_name] or attribs[:realname] or attribs[:fullname]
+        attribs[:value] = nil
+        answer         << user_set_real_name(attribs, dir_info)
+      end
+      if attribs[:unique_id] or attribs[:uniqueid] or attribs[:uidnumber]
+        attribs[:value] = nil
+        answer         << user_set_unique_id(attribs, dir_info)
+      end
+      if attribs[:primary_group_id] or attribs[:primarygroupid] or
+          attribs[:group_id] or attribs[:groupid] or attribs[:gidnumber]
+        attribs[:value] = nil
+        answer         << user_set_primary_group_id(attribs, dir_info)
+      end
+      if attribs[:nfs_home_directory] or attribs[:home_directory]
+        attribs[:value] = nil
+        answer         << user_set_nfs_home_directory(attribs, dir_info)
+      end
+      if attribs[:first_name] or attribs[:firstname] or attribs[:given_name] or
+                          attribs[:givenname]
+        attribs[:value] = nil
+        answer         << user_set_first_name(attribs, dir_info)
+      end
+      if attribs[:email] or attribs[:mail]
+        attribs[:value] = nil
+        answer         << user_set_email(attribs, dir_info)
+      end
+      if attribs[:relations] or attribs[:relationships]
+        attribs[:value] = nil
+        answer         << user_set_relationships(attribs, dir_info)
+      end
+      if attribs[:org_info] or attribs[:organization_info]
+        attribs[:value] = nil
+        answer         << user_set_organization_info(attribs, dir_info)
+      end
       if attribs[:group_name] or attribs[:groupname] or attribs[:gid] or
                         attribs[:group_membership] or attribs[:groupmembership]
         attribs[:value] = nil

data/lib/open_directory_utils/connection.rb

@@ -1,10 +1,9 @@
 require 'net/ssh'
 require "open_directory_utils/version"
 require "open_directory_utils/commands_base"
+require "open_directory_utils/commands_groups"
 require "open_directory_utils/commands_user_attribs"
-# require "open_directory_utils/commands_user_attribs_ldap"
 require "open_directory_utils/commands_user_create_remove"
-require "open_directory_utils/commands_group_create_remove"
 
 module OpenDirectoryUtils
   class Connection
@@ -13,10 +12,9 @@ module OpenDirectoryUtils
 
     include OpenDirectoryUtils::Version
     include OpenDirectoryUtils::CommandsBase
+    include OpenDirectoryUtils::CommandsGroups
     include OpenDirectoryUtils::CommandsUserAttribs
-    # include OpenDirectoryUtils::CommandsUserAttribsLdap
     include OpenDirectoryUtils::CommandsUserCreateRemove
-    include OpenDirectoryUtils::CommandsGroupCreateRemove
 
     # configure connection with ENV_VARS (or parameters)
     # @params [Hash] - reqiured info includes: srv_hostname:, srv_username: (password: if not using ssh-keys)
@@ -59,6 +57,7 @@ module OpenDirectoryUtils
       results   = send_cmds_to_od_server(ssh_cmds)
       # pp results
       answer = process_results(results, command, params, ssh_cmds )
+      params[:value] = nil
       return answer
       rescue ArgumentError, NoMethodError => error
         format_results(error.message, command, params, ssh_cmds, 'error')

data/lib/open_directory_utils/version.rb

@@ -1,5 +1,5 @@
 module OpenDirectoryUtils
   module Version
-    VERSION = "0.1.6"
+    VERSION = "0.1.7"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: open_directory_utils
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Bill Tihen
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-18 00:00:00.000000000 Z
+date: 2018-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh
@@ -88,11 +88,13 @@ files:
 - bin/setup
 - examples/connection-sample.yml
 - examples/create_od_users.rb
+- examples/relations.yml
+- examples/update_relationship.rb
 - examples/users-sample.yml
 - lib/open_directory_utils.rb
 - lib/open_directory_utils/clean_check.rb
 - lib/open_directory_utils/commands_base.rb
-- lib/open_directory_utils/commands_group_create_remove.rb
+- lib/open_directory_utils/commands_groups.rb
 - lib/open_directory_utils/commands_user_attribs.rb
 - lib/open_directory_utils/commands_user_create_remove.rb
 - lib/open_directory_utils/connection.rb