# class Chef::Provider::User::Dscl

### Constants

AUTHENTICATION_AUTHORITY
NFS_HOME_DIRECTORY

### Public Instance Methods

check_lock() click to toggle source

    # File lib/chef/provider/user/dscl.rb, line 232
    def check_lock
      return @locked = locked?
    end

create_user() click to toggle source

    # File lib/chef/provider/user/dscl.rb, line 153
    def create_user
      dscl_create_user
      dscl_create_comment
      set_uid
      dscl_set_gid
      modify_home
      dscl_set_shell
      modify_password
    end

current_home_exists?() click to toggle source

    # File lib/chef/provider/user/dscl.rb, line 252
    def current_home_exists?
      ::File.exist?("#{@current_resource.home}")
    end

ditto_home() click to toggle source

    # File lib/chef/provider/user/dscl.rb, line 260
    def ditto_home
      skel = "/System/Library/User Template/English.lproj"
      raise(Chef::Exceptions::User,"can't find skel at: #{skel}") unless ::File.exists?(skel)
      shell_out! "ditto '#{skel}' '#{@new_resource.home}'"
      ::FileUtils.chown_R(@new_resource.username,@new_resource.gid.to_s,@new_resource.home)
    end

diverged?(parameter) click to toggle source

    # File lib/chef/provider/user/dscl.rb, line 278
    def diverged?(parameter)
      parameter_updated?(parameter) && (not @new_resource.send(parameter).nil?)
    end

dscl(*args) click to toggle source

    # File lib/chef/provider/user/dscl.rb, line 32
    def dscl(*args)
      shell_out("dscl . -#{args.join(' ')}")
    end

dscl_create_comment() click to toggle source

    # File lib/chef/provider/user/dscl.rb, line 177
    def dscl_create_comment
      safe_dscl("create /Users/#{@new_resource.username} RealName '#{@new_resource.comment}'")
    end

dscl_create_user() click to toggle source

    # File lib/chef/provider/user/dscl.rb, line 173
    def dscl_create_user
      safe_dscl("create /Users/#{@new_resource.username}")
    end

dscl_set_gid() click to toggle source

    # File lib/chef/provider/user/dscl.rb, line 181
    def dscl_set_gid
      unless @new_resource.gid && @new_resource.gid.to_s.match(/^\d+$/)
        begin
          possible_gid = safe_dscl("read /Groups/#{@new_resource.gid} PrimaryGroupID").split(" ").last
        rescue Chef::Exceptions::DsclCommandFailed => e
          raise Chef::Exceptions::GroupIDNotFound.new("Group not found for #{@new_resource.gid} when creating user #{@new_resource.username}")
        end
        @new_resource.gid(possible_gid) if possible_gid && possible_gid.match(/^\d+$/)
      end
      safe_dscl("create /Users/#{@new_resource.username} PrimaryGroupID '#{@new_resource.gid}'")
    end

dscl_set_shell() click to toggle source

    # File lib/chef/provider/user/dscl.rb, line 193
    def dscl_set_shell
      if @new_resource.password || ::File.exists?("#{@new_resource.shell}")
        safe_dscl("create /Users/#{@new_resource.username} UserShell '#{@new_resource.shell}'")
      else
        safe_dscl("create /Users/#{@new_resource.username} UserShell '/usr/bin/false'")
      end
    end

get_free_uid(search_limit=1000) click to toggle source

get a free UID greater than 200

    # File lib/chef/provider/user/dscl.rb, line 51
    def get_free_uid(search_limit=1000)
      uid = nil; next_uid_guess = 200
      users_uids = safe_dscl("list /Users uid")
      while(next_uid_guess < search_limit + 200)
        if users_uids =~ Regexp.new("#{Regexp.escape(next_uid_guess.to_s)}\n")
          next_uid_guess += 1
        else
          uid = next_uid_guess
          break
        end
      end
      return uid || raise("uid not found. Exhausted. Searched #{search_limit} times")
    end

guid() click to toggle source

    # File lib/chef/provider/user/dscl.rb, line 103
    def guid
      safe_dscl("read /Users/#{@new_resource.username} GeneratedUID").gsub(/GeneratedUID: /,"").strip
    end

load_current_resource() click to toggle source
Calls superclass method Chef::Provider::User#load_current_resource

    # File lib/chef/provider/user/dscl.rb, line 148
    def load_current_resource
      super
      raise Chef::Exceptions::User, "Could not find binary /usr/bin/dscl for #{@new_resource}" unless ::File.exists?("/usr/bin/dscl")
    end

lock_user() click to toggle source

    # File lib/chef/provider/user/dscl.rb, line 236
    def lock_user
      safe_dscl("append /Users/#{@new_resource.username} AuthenticationAuthority ';DisabledUser;'")
    end

locked?() click to toggle source

    # File lib/chef/provider/user/dscl.rb, line 223
    def locked?
      user_info = safe_dscl("read /Users/#{@new_resource.username}")
      if auth_authority_md = AUTHENTICATION_AUTHORITY.match(user_info)
        !!(auth_authority_md[1] =~ /DisabledUser/ )
      else
        false
      end
    end

manage_user() click to toggle source

    # File lib/chef/provider/user/dscl.rb, line 163
    def manage_user
      dscl_create_user    if diverged?(:username)
      dscl_create_comment if diverged?(:comment)
      set_uid             if diverged?(:uid)
      dscl_set_gid        if diverged?(:gid)
      modify_home         if diverged?(:home)
      dscl_set_shell      if diverged?(:shell)
      modify_password     if diverged?(:password)
    end

modify_home() click to toggle source

    # File lib/chef/provider/user/dscl.rb, line 79
    def modify_home
      return safe_dscl("delete /Users/#{@new_resource.username} NFSHomeDirectory") if (@new_resource.home.nil? || @new_resource.home.empty?)
      if @new_resource.supports[:manage_home]
        validate_home_dir_specification!

        if (@current_resource.home == @new_resource.home) && !new_home_exists?
          ditto_home
        elsif !current_home_exists? && !new_home_exists?
          ditto_home
        elsif current_home_exists?
          move_home
        end
      end
      safe_dscl("create /Users/#{@new_resource.username} NFSHomeDirectory '#{@new_resource.home}'")
    end

modify_password() click to toggle source

    # File lib/chef/provider/user/dscl.rb, line 116
    def modify_password
      if @new_resource.password
        shadow_hash = nil

        Chef::Log.debug("#{new_resource} updating password")
        if osx_shadow_hash?(@new_resource.password)
          shadow_hash = @new_resource.password.upcase
        else
          if osx_salted_sha1?(@new_resource.password)
            salted_sha1 = @new_resource.password.upcase
          else
            hex_salt = ""
            OpenSSL::Random.random_bytes(10).each_byte { |b| hex_salt << b.to_i.to_s(16) }
            hex_salt = hex_salt.slice(0...8)
            salt = [hex_salt].pack("H*")
            sha1 = ::OpenSSL::Digest::SHA1.hexdigest(salt+@new_resource.password)
            salted_sha1 = (hex_salt+sha1).upcase
          end
          shadow_hash = String.new("00000000"*155)
          shadow_hash[168] = salted_sha1
        end

        ::File.open("/var/db/shadow/hash/#{guid}",'w',0600) do |output|
          output.puts shadow_hash
        end

        unless shadow_hash_set?
          safe_dscl("append /Users/#{@new_resource.username} AuthenticationAuthority ';ShadowHash;'")
        end
      end
    end

move_home() click to toggle source

    # File lib/chef/provider/user/dscl.rb, line 267
    def move_home
      Chef::Log.debug("#{@new_resource} moving #{self} home from #{@current_resource.home} to #{@new_resource.home}")

      src = @current_resource.home
      FileUtils.mkdir_p(@new_resource.home)
      files = ::Dir.glob("#{src}/*", ::File::FNM_DOTMATCH) - ["#{src}/.","#{src}/.."]
      ::FileUtils.mv(files,@new_resource.home, :force => true)
      ::FileUtils.rmdir(src)
      ::FileUtils.chown_R(@new_resource.username,@new_resource.gid.to_s,@new_resource.home)
    end

new_home_exists?() click to toggle source

    # File lib/chef/provider/user/dscl.rb, line 256
    def new_home_exists?
      ::File.exist?("#{@new_resource.home}")
    end

osx_salted_sha1?(string) click to toggle source

    # File lib/chef/provider/user/dscl.rb, line 99
    def osx_salted_sha1?(string)
      return !! ( string =~ /^[[:xdigit:]]{48}$/ )
    end

osx_shadow_hash?(string) click to toggle source

    # File lib/chef/provider/user/dscl.rb, line 95
    def osx_shadow_hash?(string)
      return !! ( string =~ /^[[:xdigit:]]{1240}$/ )
    end

parameter_updated?(parameter) click to toggle source

    # File lib/chef/provider/user/dscl.rb, line 282
    def parameter_updated?(parameter)
      not (@new_resource.send(parameter) == @current_resource.send(parameter))
    end

remove_user() click to toggle source

    # File lib/chef/provider/user/dscl.rb, line 201
    def remove_user
      if @new_resource.supports[:manage_home]
        user_info = safe_dscl("read /Users/#{@new_resource.username}")
        if nfs_home_match = user_info.match(NFS_HOME_DIRECTORY)
          #nfs_home = safe_dscl("read /Users/#{@new_resource.username} NFSHomeDirectory")
          #nfs_home.gsub!(/NFSHomeDirectory: /,"").gsub!(/\n$/,"")
          nfs_home = nfs_home_match[1]
          FileUtils.rm_rf(nfs_home)
        end
      end
      # remove the user from its groups
      groups = []
      Etc.group do |group|
        groups << group.name if group.mem.include?(@new_resource.username)
      end
      groups.each do |group_name|
        safe_dscl("delete /Groups/#{group_name} GroupMembership '#{@new_resource.username}'")
      end
      # remove user account
      safe_dscl("delete /Users/#{@new_resource.username}")
    end

safe_dscl(*args) click to toggle source

    # File lib/chef/provider/user/dscl.rb, line 36
    def safe_dscl(*args)
      result = dscl(*args)
      return "" if ( args.first =~ /^delete/ ) && ( result.exitstatus != 0 )
      raise(Chef::Exceptions::DsclCommandFailed,"dscl error: #{result.inspect}") unless result.exitstatus == 0
      raise(Chef::Exceptions::DsclCommandFailed,"dscl error: #{result.inspect}") if result.stdout =~ /No such key: /
      return result.stdout
    end

set_uid() click to toggle source

    # File lib/chef/provider/user/dscl.rb, line 71
    def set_uid
      @new_resource.uid(get_free_uid) if (@new_resource.uid.nil? || @new_resource.uid == '')
      if uid_used?(@new_resource.uid)
        raise(Chef::Exceptions::RequestedUIDUnavailable, "uid #{@new_resource.uid} is already in use")
      end
      safe_dscl("create /Users/#{@new_resource.username} UniqueID #{@new_resource.uid}")
    end

shadow_hash_set?() click to toggle source

    # File lib/chef/provider/user/dscl.rb, line 107
    def shadow_hash_set?
      user_data = safe_dscl("read /Users/#{@new_resource.username}")
      if user_data =~ /AuthenticationAuthority: / && user_data =~ /ShadowHash/
        true
      else
        false
      end
    end

uid_used?(uid) click to toggle source

    # File lib/chef/provider/user/dscl.rb, line 65
    def uid_used?(uid)
      return false unless uid
      users_uids = safe_dscl("list /Users uid")
      !! ( users_uids =~ Regexp.new("#{Regexp.escape(uid.to_s)}\n") )
    end

unlock_user() click to toggle source

    # File lib/chef/provider/user/dscl.rb, line 240
    def unlock_user
      auth_info = safe_dscl("read /Users/#{@new_resource.username} AuthenticationAuthority")
      auth_string = auth_info.gsub(/AuthenticationAuthority: /,"").gsub(/;DisabledUser;/,"").strip#.gsub!(/[; ]*$/,"")
      safe_dscl("create /Users/#{@new_resource.username} AuthenticationAuthority '#{auth_string}'")
    end

validate_home_dir_specification!() click to toggle source

    # File lib/chef/provider/user/dscl.rb, line 246
    def validate_home_dir_specification!
      unless @new_resource.home =~ /^\//
        raise(Chef::Exceptions::InvalidHomeDirectory,"invalid path spec for User: '#{@new_resource.username}', home directory: '#{@new_resource.home}'")
      end
    end