open_directory_utils 0.1.2 → 0.1.3

data/lib/open_directory_utils/commands_user_attribs_ldap.rb

@@ -1,281 +0,0 @@
-require "open_directory_utils/dscl"
-require "open_directory_utils/clean_check"
-require "open_directory_utils/commands_base"
-
-module OpenDirectoryUtils
-
-  # this is a long list of pre-built dscl commands affecting users to accomplish common actions
-  # @note - these commands were derived from the following resrouces:
-  # * https://developer.apple.com/legacy/library/documentation/Darwin/Reference/ManPages/man1/dscl.1.html
-  # * https://superuser.com/questions/592921/mac-osx-users-vs-dscl-command-to-list-user/621055?utm_medium=organic&utm_source=google_rich_qa&utm_campaign=google_rich_qa
-  module CommandsUserAttribsLdap
-
-    # include OpenDirectoryUtils::Dscl
-    include OpenDirectoryUtils::CleanCheck
-    include OpenDirectoryUtils::CommandsBase
-
-    # /usr/bin/dscl -u diradmin -P A-B1g-S3cret /LDAPv3/127.0.0.1 -create /Users/$USER cn "$NAME"
-    def user_set_common_name(attribs, dir_info)
-      attribs = user_record_name_alternatives(attribs)
-
-      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]
-      attribs[:value] = attribs[:value] || "#{attribs[:first_name]} #{attribs[:last_name]}"
-
-      check_critical_attribute( attribs, :record_name )
-      check_critical_attribute( attribs, :value, :common_name )
-      attribs    = tidy_attribs(attribs)
-
-      command    = {action: 'create', scope: 'Users', attribute: 'cn'}
-      user_attrs = attribs.merge(command)
-
-      dscl( user_attrs, dir_info )
-    end
-    alias_method :user_set_cn, :user_set_common_name
-
-    # /usr/bin/dscl -u diradmin -P A-B1g-S3cret /LDAPv3/127.0.0.1 -create /Users/$shortname_USERNAME givenName "$VALUE"
-    def user_set_given_name(attribs, dir_info)
-      attribs = user_record_name_alternatives(attribs)
-
-      attribs[:value] = attribs[:value] || attribs[:given_name]
-      attribs[:value] = attribs[:value] || attribs[:first_name]
-
-      check_critical_attribute( attribs, :record_name )
-      check_critical_attribute( attribs, :value, :given_name )
-      attribs    = tidy_attribs(attribs)
-
-      command    = {action: 'create', scope: 'Users', attribute: 'givenName'}
-      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 sn "$VALUE"
-    def user_set_surname(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[:last_name]
-
-      check_critical_attribute( attribs, :record_name )
-      check_critical_attribute( attribs, :value, :surname )
-      attribs    = tidy_attribs(attribs)
-
-      command    = {action: 'create', scope: 'Users', attribute: 'sn'}
-      user_attrs = attribs.merge(command)
-
-      dscl( user_attrs, dir_info )
-    end
-    alias_method :user_set_sn, :user_set_surname
-
-    # # sudo dscl . -create /Users/someuser uidnumber "1010"
-    def user_set_uidnumber(attribs, dir_info)
-      attribs = user_record_name_alternatives(attribs)
-
-      attribs[:value] = attribs[:value] || attribs[:uniqueid]
-      attribs[:value] = attribs[:value] || attribs[:unique_id]
-      attribs[:value] = attribs[:value] || attribs[:uidnumber]
-
-      check_critical_attribute( attribs, :record_name )
-      check_critical_attribute( attribs, :value, :unique_id )
-      attribs    = tidy_attribs(attribs)
-
-      command    = {action: 'create', scope: 'Users', attribute: 'uidnumber'}
-      user_attrs = attribs.merge(command)
-
-      dscl( user_attrs, dir_info )
-    end
-
-    # sudo dscl . -create /Users/someuser PrimaryGroupID 80
-    def user_set_gidnumber(attribs, dir_info)
-      attribs = user_record_name_alternatives(attribs)
-
-      attribs[:value] = attribs[:value] || attribs[:group_id]
-      attribs[:value] = attribs[:value] || attribs[:gidnumber]
-      attribs[:value] = attribs[:value] || attribs[:group_number]
-      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: 'gidnumber'}
-      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 homedirectory "$VALUE"
-    def user_set_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'
-
-      command = {action: 'create', scope: 'Users', attribute: 'homedirectory'}
-      attribs = attribs.merge(command)
-
-      check_critical_attribute( attribs, :record_name )
-      check_critical_attribute( attribs, :value, :home_directory )
-      user_attrs = tidy_attribs(attribs)
-
-      dscl( user_attrs, dir_info )
-    end
-
-    # /usr/bin/dscl -u diradmin -P A-B1g-S3cret /LDAPv3/127.0.0.1 -create /Users/$shortname_USERNAME loginShell "$VALUE"
-    def user_set_login_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: 'loginShell'}
-      user_attrs  = attribs.merge(command)
-
-      dscl( user_attrs, dir_info )
-    end
-
-
-    # OTHER FIELDS
-    #####################
-    # /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: 'mail'}
-      user_attrs = attribs.merge(command)
-      answer    << dscl( user_attrs, dir_info )
-
-      command    = {action: 'create', scope: 'Users', attribute: 'email'}
-      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[: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
-
-    # dscl . -delete /Users/yourUserName
-    # https://tutorialforlinux.com/2011/09/15/delete-users-and-groups-from-terminal/
-    def user_delete(attribs, dir_info)
-      attribs = user_record_name_alternatives(attribs)
-
-      check_critical_attribute( attribs, :record_name )
-      attribs    = tidy_attribs(attribs)
-
-      command    = {action: 'delete', scope: 'Users', value: nil, attribute: nil}
-      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 mobile "$VALUE"
-    def user_set_mobile_phone
-    end
-
-    # /usr/bin/dscl -u diradmin -P A-B1g-S3cret /LDAPv3/127.0.0.1 -create /Users/$shortname_USERNAME telephoneNumber "$VALUE"
-    def user_set_work_phone
-    end
-
-    # /usr/bin/dscl -u diradmin -P A-B1g-S3cret /LDAPv3/127.0.0.1 -create /Users/$shortname_USERNAME homePhone "$VALUE"
-    def user_set_home_phone
-    end
-
-    # /usr/bin/dscl -u diradmin -P A-B1g-S3cret /LDAPv3/127.0.0.1 -create /Users/$shortname_USERNAME title "$VALUE"
-    def user_set_title
-    end
-
-    # /usr/bin/dscl -u diradmin -P A-B1g-S3cret /LDAPv3/127.0.0.1 -create /Users/$shortname_USERNAME departmentNumber "$VALUE"
-    def user_set_department
-    end
-
-    # /usr/bin/dscl -u diradmin -P A-B1g-S3cret /LDAPv3/127.0.0.1 -create /Users/$shortname_USERNAME street "$VALUE"
-    def user_set_street
-    end
-    alias_method :las_set_dorm, :user_set_street
-    alias_method :las_set_housing, :user_set_street
-
-    # /usr/bin/dscl -u diradmin -P A-B1g-S3cret /LDAPv3/127.0.0.1 -create /Users/$shortname l "$VALUE"
-    def user_set_city
-    end
-    alias_method :las_, :user_set_city
-
-    # /usr/bin/dscl -u diradmin -P A-B1g-S3cret /LDAPv3/127.0.0.1 -create /Users/$shortname_USERNAME st "$VALUE"
-    def user_set_state
-    end
-    alias_method :las_cultural_trip, :user_set_state
-
-    # /usr/bin/dscl -u diradmin -P A-B1g-S3cret /LDAPv3/127.0.0.1 -create /Users/$shortname_USERNAME postalCode "$VALUE"
-    def user_set_postcode
-    end
-    alias_method :las_faculty_family, :user_set_postcode
-
-    #  /usr/bin/dscl -u diradmin -P A-B1g-S3cret /LDAPv3/127.0.0.1 -create /Users/$USER c "$VALUE"
-    def user_set_country
-    end
-
-    # /usr/bin/dscl -u diradmin -P A-B1g-S3cret /LDAPv3/127.0.0.1 -create /Users/$shortname_USERNAME labeledURI "$VALUE"
-    def user_set_homepage
-    end
-    alias_method :user_set_webpage, :user_set_homepage
-    alias_method :las_enrollment_date, :user_set_homepage
-    alias_method :las_begin_date, :user_set_homepage
-
-    # /usr/bin/dscl -u diradmin -P A-B1g-S3cret /LDAPv3/127.0.0.1 -create /Users/$USER description "$NAME"
-    def user_set_comments
-    end
-    alias_method :user_set_description, :user_set_comments
-
-  end
-end

data/lib/open_directory_utils/dscl.rb

@@ -1,53 +0,0 @@
-require "open_directory_utils/clean_check"
-
-module OpenDirectoryUtils
-
-  # https://developer.apple.com/legacy/library/documentation/Darwin/Reference/ManPages/man1/dscl.1.html
-  # https://superuser.com/questions/592921/mac-osx-users-vs-dscl-command-to-list-user/621055?utm_medium=organic&utm_source=google_rich_qa&utm_campaign=google_rich_qa
-  module Dscl
-
-    include OpenDirectoryUtils::CleanCheck
-
-    # builds the dscl command (with complete flexibility)
-    # attribs [Hash] - required - :record_name (the resource to affect), :action (create, append, delete, passwd, etc), attribute: (resource attribute to change), value: (value to add to attribute)
-    # dir_info [Hash] - usually configured in the connection initializer and then passed to dscl to build command correctly
-    def dscl(attribs, dir_info)
-      check_critical_attribute( attribs, :record_name )
-      check_critical_attribute( attribs, :action )
-      check_critical_attribute( attribs, :scope )
-      tidy_attribs = tidy_attribs(attribs)
-      build_dscl_command( tidy_attribs, dir_info )
-    end
-
-    # TODO: switch to template pattern
-    def build_dscl_command(attribs, dir_info)
-      # allow :recordname to be passed-in if using dscl directly
-      attribs[:record_name] = attribs[:record_name] || attribs[:recordname]
-      # /usr/bin/dscl -u diradmin -P "BigSecret" /LDAPv3/127.0.0.1 -append /Users/$UID_USERNAME apple-keyword "$VALUE"
-      # "/usr/bin/dscl -plist -u #{od_username} -P #{od_password} #{od_dsclpath} -#{command} #{resource} #{params}"
-      ans  = "#{dir_info[:dscl]}"
-      unless attribs[:format].nil?
-        ans += ' -plist'                           if attribs[:format].eql? 'plist' or
-                                                      attribs[:format].eql? 'xml'
-      end
-      ans += " -u #{dir_info[:username]}"      unless dir_info[:username].nil? or
-                                                      dir_info[:username].empty? or
-                                                      attribs[:action].eql? 'auth'
-      ans += %Q[ -P "#{dir_info[:password]}"]    unless dir_info[:password].nil? or
-                                                      dir_info[:password].empty? or
-                                                      attribs[:action].eql? 'auth'
-      ans += " #{dir_info[:data_path]}"
-
-      ans += %Q[ -#{attribs[:action]}]
-      ans += %Q[ #{attribs[:record_name]}]         if attribs[:action].eql? 'auth'
-      ans += %Q[ /#{attribs[:scope]}/#{attribs[:record_name]}] unless
-                                                      attribs[:action].eql? 'auth'
-      ans += %Q[ #{attribs[:attribute]}]       unless attribs[:attribute].nil? or
-                                                      attribs[:attribute].empty?
-      ans += %Q[ "#{attribs[:value]}"]         unless attribs[:value].nil? or
-                                                      attribs[:value].empty?
-      return ans
-    end
-
-  end
-end

data/lib/open_directory_utils/pwpolicy.rb

@@ -1,48 +0,0 @@
-require "open_directory_utils/clean_check"
-
-module OpenDirectoryUtils
-
-  # https://developer.apple.com/legacy/library/documentation/Darwin/Reference/ManPages/man1/dscl.1.html
-  # https://superuser.com/questions/592921/mac-osx-users-vs-dscl-command-to-list-user/621055?utm_medium=organic&utm_source=google_rich_qa&utm_campaign=google_rich_qa
-  module Pwpolicy
-
-    include OpenDirectoryUtils::CleanCheck
-
-    def build_pwpolicy_command(params, dir_info)
-      # /usr/bin/pwpolicy -a diradmin -p "BigSecret" -u username -setpolicy "isDisabled=0"
-      ans  = "#{dir_info[:pwpol]}"
-      ans += " -a #{dir_info[:diradmin]}"      unless dir_info[:diradmin].nil? or
-                                                      dir_info[:diradmin].empty?
-      ans += %Q[ -p "#{dir_info[:password]}"]  unless dir_info[:password].nil? or
-                                                      dir_info[:password].empty?
-      ans += %Q[ -u #{params[:record_name]}]
-      ans += %Q[ -#{params[:attribute]}]
-      ans += %Q[ "#{params[:value]}"]          unless params[:value].nil? or
-                                                      params[:value].empty?
-      return ans
-    end
-
-    def pwpolicy(params, dir_info)
-      check_critical_attribute( params, :record_name )
-      cmd_params = tidy_attribs(params)
-
-      build_pwpolicy_command( cmd_params, dir_info )
-    end
-
-    ## PRE-BUILT commands
-    #####################
-    # /usr/bin/pwpolicy -a diradmin -p A-B1g-S3cret -u $shortname_USERNAME -setpolicy "isDisabled=0"
-    def user_enable_login(params, dir_info)
-      command = {attribute: 'enableuser'}
-      params  = command.merge(params)
-      pwpolicy(params, dir_info)
-    end
-    # /usr/bin/pwpolicy -a diradmin -p A-B1g-S3cret -u $shortname_USERNAME -setpolicy "isDisabled=1"
-    def user_disable_login(params, dir_info)
-      command = {attribute: 'disableuser'}
-      params  = command.merge(params)
-      pwpolicy(params, dir_info)
-    end
-
-  end
-end