Class: Chef::Provider::User::Dscl
- Inherits:
-
Chef::Provider::User
- Object
- Chef::Provider
- Chef::Provider::User
- Chef::Provider::User::Dscl
- Defined in:
- lib/chef/provider/user/dscl.rb
Overview
The most tricky bit of this provider is the way it deals with user passwords. macOS has different password shadow calculations based on the version. < 10.7 => password shadow calculation format SALTED-SHA1
=> stored in: /var/db/shadow/hash/#{guid}
=> shadow binary length 68 bytes
=> First 4 bytes salt / Next 64 bytes shadow value
10.7 => password shadow calculation format SALTED-SHA512
=> stored in: /var/db/dslocal/nodes/Default/users/#{name}.plist
=> shadow binary length 68 bytes
=> First 4 bytes salt / Next 64 bytes shadow value
> 10.7 => password shadow calculation format SALTED-SHA512-PBKDF2
=> stored in: /var/db/dslocal/nodes/Default/users/#{name}.plist
=> shadow binary length 128 bytes
=> Salt / Iterations are stored separately in the same file
This provider only supports macOS versions 10.7 to 10.13
Constant Summary collapse
- STAFF_GROUP_ID =
Just-in-case a recipe calls the user dscl provider without specifying a gid property. Avoids chown issues in move_home when the manage_home property is in use. #5393
20
- DSCL_PROPERTY_MAP =
A simple map of Chef’s terms to DSCL’s terms.
{ uid: "uid", gid: "gid", home: "home", shell: "shell", comment: "realname", password: "passwd", auth_authority: "authentication_authority", shadow_hash: "ShadowHashData", }.freeze
- USER_PLIST_DIRECTORY =
Directory where the user plist files are stored for versions 10.7 and above
"/var/db/dslocal/nodes/Default/users".freeze
Instance Attribute Summary collapse
-
#authentication_authority ⇒ Object
Returns the value of attribute authentication_authority.
-
#password_shadow_conversion_algorithm ⇒ Object
Returns the value of attribute password_shadow_conversion_algorithm.
-
#user_info ⇒ Object
Returns the value of attribute user_info.
Attributes inherited from Chef::Provider::User
#change_desc, #locked, #user_exists
Attributes inherited from Chef::Provider
#action, #after_resource, #current_resource, #logger, #new_resource, #run_context
Instance Method Summary collapse
-
#check_lock ⇒ Object
This is the interface base User provider requires to provide idempotency.
- #convert_binary_plist_to_xml(binary_plist_string) ⇒ Object
- #convert_to_binary(string) ⇒ Object
-
#create_user ⇒ Object
Provider Actions.
- #current_home_exists? ⇒ Boolean
- #define_resource_requirements ⇒ Object
- #ditto_home ⇒ Object
-
#diverged?(parameter) ⇒ Boolean
Returns true if the system state and desired state is different for given attribute.
-
#diverged_password? ⇒ Boolean
We need a special check function for password since we support both plain text and shadow hash data.
-
#dscl_create_comment ⇒ Object
Saves the specified Chef user ‘comment` into RealName attribute of Mac user.
-
#dscl_create_user ⇒ Object
Create a user using dscl.
-
#dscl_get(user_hash, key) ⇒ Object
Gets a value from user information hash using Chef attributes as keys.
-
#dscl_set(user_hash, key, value) ⇒ Object
Sets a value in user information hash using Chef attributes as keys.
-
#dscl_set_gid ⇒ Object
Sets the group id for the user using dscl.
-
#dscl_set_home ⇒ Object
Sets the home directory for the user.
-
#dscl_set_shell ⇒ Object
Sets the shell for the user using dscl.
-
#dscl_set_uid ⇒ Object
Sets the user id for the user using dscl.
-
#get_free_uid(search_limit = 1000) ⇒ Object
Find the next available uid on the system.
- #load_current_resource ⇒ Object
-
#lock_user ⇒ Object
Locks the user.
-
#locked? ⇒ Boolean
Returns true if the user is locked, false otherwise.
- #manage_user ⇒ Object
-
#member_of_group?(group_name) ⇒ Boolean
Returns true if user is member of the specified group, false otherwise.
- #move_home ⇒ Object
- #new_home_exists? ⇒ Boolean
- #parameter_updated?(parameter) ⇒ Boolean
-
#prepare_password_shadow_info ⇒ Object
Prepares the password shadow info based on the platform version.
-
#read_user_info ⇒ Object
Reads the user plist and returns a hash keyed with DSCL properties specified in DSCL_PROPERTY_MAP.
-
#remove_user ⇒ Object
Removes the user from the system after removing user from his groups and deleting home directory if needed.
-
#run_dscl(*args) ⇒ Object
System Helpers.
- #run_plutil(*args) ⇒ Object
- #salted_sha512?(string) ⇒ Boolean
- #salted_sha512_pbkdf2?(string) ⇒ Boolean
- #salted_sha512_pbkdf2_password_match? ⇒ Boolean
-
#save_user_info(user_info) ⇒ Object
Saves the given hash keyed with DSCL properties specified in DSCL_PROPERTY_MAP to the disk.
-
#set_password ⇒ Object
Sets the password for the user based on given password parameters.
-
#uid_used?(uid) ⇒ Boolean
Returns true if uid is in use by a different account, false otherwise.
-
#unlock_user ⇒ Object
Unlocks the user.
- #validate_home_dir_specification! ⇒ Object
Methods inherited from Chef::Provider::User
#compare_user, #convert_group_name, #initialize, #load_shadow_options, #supports_ruby_shadow?
Methods inherited from Chef::Provider
action, action_description, action_descriptions, #action_nothing, #check_resource_semantics!, #cleanup_after_converge, #compile_and_converge_action, #converge_by, #converge_if_changed, #cookbook_name, #description, #events, include_resource_dsl?, include_resource_dsl_module, #initialize, #introduced, #load_after_resource, #node, #process_resource_requirements, provides, provides?, #recipe_name, #requirements, #resource_collection, #resource_updated?, #run_action, #set_updated_status, supports?, use, use_inline_resources, #validate_required_properties!, #whyrun_mode?, #whyrun_supported?
Methods included from Mixin::Provides
#provided_as, #provides, #provides?
Methods included from Mixin::DescendantsTracker
#descendants, descendants, direct_descendants, #direct_descendants, find_descendants_by_name, #find_descendants_by_name, #inherited, store_inherited
Methods included from Mixin::LazyModuleInclude
#descendants, #include, #included
Methods included from Mixin::PowershellOut
#powershell_out, #powershell_out!
Methods included from Mixin::WindowsArchitectureHelper
#assert_valid_windows_architecture!, #disable_wow64_file_redirection, #forced_32bit_override_required?, #is_i386_process_on_x86_64_windows?, #node_supports_windows_architecture?, #node_windows_architecture, #restore_wow64_file_redirection, #valid_windows_architecture?, #with_os_architecture, #wow64_architecture_override_required?, #wow64_directory
Methods included from DSL::Secret
#default_secret_config, #default_secret_service, #secret, #with_secret_config, #with_secret_service
Methods included from DSL::RenderHelpers
#render_json, #render_toml, #render_yaml
Methods included from DSL::ReaderHelpers
#parse_file, #parse_json, #parse_toml, #parse_yaml
Methods included from DSL::Powershell
Methods included from DSL::RegistryHelper
#registry_data_exists?, #registry_get_subkeys, #registry_get_values, #registry_has_subkeys?, #registry_key_exists?, #registry_value_exists?
Methods included from DSL::ChefVault
#chef_vault, #chef_vault_item, #chef_vault_item_for_environment
Methods included from DSL::DataQuery
#data_bag, #data_bag_item, #search, #tagged?
Methods included from EncryptedDataBagItem::CheckEncrypted
Methods included from DSL::PlatformIntrospection
#older_than_win_2012_or_8?, #platform?, #platform_family?, #value_for_platform, #value_for_platform_family
Methods included from DSL::Recipe
#exec, #have_resource_class_for?, #resource_class_for
Methods included from DSL::Definitions
add_definition, #evaluate_resource_definition, #has_resource_definition?
Methods included from DSL::Resources
add_resource_dsl, remove_resource_dsl
Methods included from DSL::Cheffish
Methods included from DSL::RebootPending
Methods included from DSL::IncludeRecipe
Methods included from Mixin::NotifyingBlock
#notifying_block, #subcontext_block
Methods included from DSL::DeclareResource
#build_resource, #declare_resource, #delete_resource, #delete_resource!, #edit_resource, #edit_resource!, #find_resource, #find_resource!, #resources, #with_run_context
Methods included from DSL::Compliance
#include_input, #include_profile, #include_waiver
Constructor Details
This class inherits a constructor from Chef::Provider::User
Instance Attribute Details
#authentication_authority ⇒ Object
Returns the value of attribute authentication_authority.
49 50 51 |
# File 'lib/chef/provider/user/dscl.rb', line 49 def @authentication_authority end |
#password_shadow_conversion_algorithm ⇒ Object
Returns the value of attribute password_shadow_conversion_algorithm.
50 51 52 |
# File 'lib/chef/provider/user/dscl.rb', line 50 def password_shadow_conversion_algorithm @password_shadow_conversion_algorithm end |
#user_info ⇒ Object
Returns the value of attribute user_info.
48 49 50 |
# File 'lib/chef/provider/user/dscl.rb', line 48 def user_info @user_info end |
Instance Method Details
#check_lock ⇒ Object
This is the interface base User provider requires to provide idempotency.
450 451 452 |
# File 'lib/chef/provider/user/dscl.rb', line 450 def check_lock @locked = locked? end |
#convert_binary_plist_to_xml(binary_plist_string) ⇒ Object
606 607 608 |
# File 'lib/chef/provider/user/dscl.rb', line 606 def convert_binary_plist_to_xml(binary_plist_string) shell_out("plutil", "-convert", "xml1", "-o", "-", "-", input: binary_plist_string).stdout end |
#convert_to_binary(string) ⇒ Object
610 611 612 |
# File 'lib/chef/provider/user/dscl.rb', line 610 def convert_to_binary(string) string.unpack("a2" * (string.size / 2)).collect { |i| i.hex.chr }.join end |
#create_user ⇒ Object
Provider Actions
148 149 150 151 152 153 154 155 156 157 158 |
# File 'lib/chef/provider/user/dscl.rb', line 148 def create_user dscl_create_user # set_password modifies the plist file of the user directly. So update # the password first before making any modifications to the user. set_password dscl_create_comment dscl_set_uid dscl_set_gid dscl_set_home dscl_set_shell end |
#current_home_exists? ⇒ Boolean
299 300 301 |
# File 'lib/chef/provider/user/dscl.rb', line 299 def current_home_exists? !!current_resource.home && ::File.exist?(current_resource.home) end |
#define_resource_requirements ⇒ Object
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 |
# File 'lib/chef/provider/user/dscl.rb', line 60 def define_resource_requirements super requirements.assert(:all_actions) do |a| a.assertion { ::File.exist?("/usr/bin/dscl") } a.(Chef::Exceptions::User, "Cannot find binary '/usr/bin/dscl' on the system for #{new_resource}!") end requirements.assert(:all_actions) do |a| a.assertion { ::File.exist?("/usr/bin/plutil") } a.(Chef::Exceptions::User, "Cannot find binary '/usr/bin/plutil' on the system for #{new_resource}!") end requirements.assert(:create, :modify, :manage) do |a| a.assertion do if new_resource.password # SALTED-SHA512 password shadow hashes are not supported on 10.8 and above. !salted_sha512?(new_resource.password) else true end end a.(Chef::Exceptions::User, "SALTED-SHA512 passwords are not supported on Mac 10.8 and above. \ If you want to set the user password using shadow info make sure you specify a SALTED-SHA512-PBKDF2 shadow hash \ in 'password', with the associated 'salt' and 'iterations'.") end requirements.assert(:create, :modify, :manage) do |a| a.assertion do if new_resource.password && salted_sha512_pbkdf2?(new_resource.password) # salt and iterations should be specified when # SALTED-SHA512-PBKDF2 password shadow hash is given !new_resource.salt.nil? && !new_resource.iterations.nil? else true end end a.(Chef::Exceptions::User, "SALTED-SHA512-PBKDF2 shadow hash is given without associated \ 'salt' and 'iterations'. Please specify 'salt' and 'iterations' in order to set the user password using shadow hash.") end end |
#ditto_home ⇒ Object
307 308 309 |
# File 'lib/chef/provider/user/dscl.rb', line 307 def ditto_home shell_out!("/usr/sbin/createhomedir", "-c", "-u", (new_resource.username).to_s) end |
#diverged?(parameter) ⇒ Boolean
Returns true if the system state and desired state is different for given attribute.
462 463 464 |
# File 'lib/chef/provider/user/dscl.rb', line 462 def diverged?(parameter) parameter_updated?(parameter) && !new_resource.send(parameter).nil? end |
#diverged_password? ⇒ Boolean
We need a special check function for password since we support both plain text and shadow hash data.
Checks if password needs update based on platform version and the type of the password specified.
477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 |
# File 'lib/chef/provider/user/dscl.rb', line 477 def diverged_password? return false if new_resource.password.nil? # Dscl provider supports both plain text passwords and shadow hashes. # # Some system users don't have salts; this can happen if the system is # upgraded and the user hasn't logged in yet. In this case, we will force # the password to be updated. return true if current_resource.salt.nil? if salted_sha512_pbkdf2?(new_resource.password) diverged?(:password) || diverged?(:salt) || diverged?(:iterations) else !salted_sha512_pbkdf2_password_match? end end |
#dscl_create_comment ⇒ Object
Saves the specified Chef user ‘comment` into RealName attribute of Mac user. If `comment` is not specified, it takes `username` value.
187 188 189 190 |
# File 'lib/chef/provider/user/dscl.rb', line 187 def dscl_create_comment comment = new_resource.comment || new_resource.username run_dscl("create", "/Users/#{new_resource.username}", "RealName", comment) end |
#dscl_create_user ⇒ Object
Create a user using dscl
179 180 181 |
# File 'lib/chef/provider/user/dscl.rb', line 179 def dscl_create_user run_dscl("create", "/Users/#{new_resource.username}") end |
#dscl_get(user_hash, key) ⇒ Object
Gets a value from user information hash using Chef attributes as keys.
574 575 576 577 578 579 580 |
# File 'lib/chef/provider/user/dscl.rb', line 574 def dscl_get(user_hash, key) raise "Unknown dscl key #{key}" unless DSCL_PROPERTY_MAP.key?(key) # DSCL values are set as arrays value = user_hash[DSCL_PROPERTY_MAP[key]] value.nil? ? value : value.first end |
#dscl_set(user_hash, key, value) ⇒ Object
Sets a value in user information hash using Chef attributes as keys.
564 565 566 567 568 569 |
# File 'lib/chef/provider/user/dscl.rb', line 564 def dscl_set(user_hash, key, value) raise "Unknown dscl key #{key}" unless DSCL_PROPERTY_MAP.key?(key) user_hash[DSCL_PROPERTY_MAP[key]] = [ value ] user_hash end |
#dscl_set_gid ⇒ Object
Sets the group id for the user using dscl. Fails if a group doesn’t exist on the system with given group id. If ‘gid` is not specified, it sets a default Mac user group “staff”, with id 20 using the CONSTANT
253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 |
# File 'lib/chef/provider/user/dscl.rb', line 253 def dscl_set_gid if new_resource.gid.nil? # XXX: mutates the new resource new_resource.gid(STAFF_GROUP_ID) elsif !new_resource.gid.to_s.match(/^\d+$/) begin possible_gid = run_dscl("read", "/Groups/#{new_resource.gid}", "PrimaryGroupID").split(" ").last rescue Chef::Exceptions::DsclCommandFailed raise Chef::Exceptions::GroupIDNotFound, "Group not found for #{new_resource.gid} when creating user #{new_resource.username}" end # XXX: mutates the new resource new_resource.gid(possible_gid) if possible_gid && possible_gid.match(/^\d+$/) end run_dscl("create", "/Users/#{new_resource.username}", "PrimaryGroupID", new_resource.gid) end |
#dscl_set_home ⇒ Object
Sets the home directory for the user. If ‘:manage_home` is set home directory is managed (moved / created) for the user.
273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 |
# File 'lib/chef/provider/user/dscl.rb', line 273 def dscl_set_home if new_resource.home.nil? || new_resource.home.empty? run_dscl("delete", "/Users/#{new_resource.username}", "NFSHomeDirectory") return end if new_resource.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 run_dscl("create", "/Users/#{new_resource.username}", "NFSHomeDirectory", new_resource.home) end |
#dscl_set_shell ⇒ Object
Sets the shell for the user using dscl.
325 326 327 328 329 330 331 |
# File 'lib/chef/provider/user/dscl.rb', line 325 def dscl_set_shell if new_resource.shell run_dscl("create", "/Users/#{new_resource.username}", "UserShell", new_resource.shell) else run_dscl("create", "/Users/#{new_resource.username}", "UserShell", "/usr/bin/false") end end |
#dscl_set_uid ⇒ Object
Sets the user id for the user using dscl. If a ‘uid` is not specified, it finds the next available one starting from 200 if `system` is set, 501 otherwise.
197 198 199 200 201 202 203 204 205 206 |
# File 'lib/chef/provider/user/dscl.rb', line 197 def dscl_set_uid # XXX: mutates the new resource 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 run_dscl("create", "/Users/#{new_resource.username}", "UniqueID", new_resource.uid) end |
#get_free_uid(search_limit = 1000) ⇒ Object
Find the next available uid on the system. starting with 200 if ‘system` is set, 501 otherwise.
212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 |
# File 'lib/chef/provider/user/dscl.rb', line 212 def get_free_uid(search_limit = 1000) uid = nil base_uid = new_resource.system ? 200 : 501 next_uid_guess = base_uid users_uids = run_dscl("list", "/Users", "uid") while next_uid_guess < search_limit + base_uid if users_uids&.match?(Regexp.new("#{Regexp.escape(next_uid_guess.to_s)}\n")) next_uid_guess += 1 else uid = next_uid_guess break end end uid || raise("uid not found. Exhausted. Searched #{search_limit} times") end |
#load_current_resource ⇒ Object
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 |
# File 'lib/chef/provider/user/dscl.rb', line 102 def load_current_resource @current_resource = Chef::Resource::User::DsclUser.new(new_resource.username) current_resource.username(new_resource.username) @user_info = read_user_info if user_info current_resource.uid(dscl_get(user_info, :uid)) current_resource.gid(dscl_get(user_info, :gid)) current_resource.home(dscl_get(user_info, :home)) current_resource.shell(dscl_get(user_info, :shell)) current_resource.comment(dscl_get(user_info, :comment)) @authentication_authority = dscl_get(user_info, :auth_authority) if new_resource.password && dscl_get(user_info, :password) == "********" # A password is set. Let's get the password information from shadow file shadow_hash_binary = dscl_get(user_info, :shadow_hash) # Calling shell_out directly since we want to give an input stream shadow_hash_xml = convert_binary_plist_to_xml(shadow_hash_binary.string) shadow_hash = ::Plist.parse_xml(shadow_hash_xml) if shadow_hash["SALTED-SHA512-PBKDF2"] # 10.7+ contains this, but we retain the check in case it goes away in the future @password_shadow_conversion_algorithm = "SALTED-SHA512-PBKDF2" # Convert the entropy from Base64 encoding to hex before consuming them current_resource.password(shadow_hash["SALTED-SHA512-PBKDF2"]["entropy"].string.unpack("H*").first) current_resource.iterations(shadow_hash["SALTED-SHA512-PBKDF2"]["iterations"]) # Convert the salt from Base64 encoding to hex before consuming them current_resource.salt(shadow_hash["SALTED-SHA512-PBKDF2"]["salt"].string.unpack("H*").first) else raise(Chef::Exceptions::User, "Unknown shadow_hash format: #{shadow_hash.keys.join(" ")}") end end convert_group_name if new_resource.gid else @user_exists = false logger.trace("#{new_resource} user does not exist") end current_resource end |
#lock_user ⇒ Object
Locks the user.
424 425 426 |
# File 'lib/chef/provider/user/dscl.rb', line 424 def lock_user run_dscl("append", "/Users/#{new_resource.username}", "AuthenticationAuthority", ";DisabledUser;") end |
#locked? ⇒ Boolean
Returns true if the user is locked, false otherwise.
439 440 441 442 443 444 445 |
# File 'lib/chef/provider/user/dscl.rb', line 439 def locked? if !!(.include?("DisabledUser")) else false end end |
#manage_user ⇒ Object
160 161 162 163 164 165 166 167 168 169 170 |
# File 'lib/chef/provider/user/dscl.rb', line 160 def manage_user # set_password modifies the plist file of the user directly. So update # the password first before making any modifications to the user. set_password if diverged_password? dscl_create_user if diverged?(:username) dscl_create_comment if diverged?(:comment) dscl_set_uid if diverged?(:uid) dscl_set_gid if diverged?(:gid) dscl_set_home if diverged?(:home) dscl_set_shell if diverged?(:shell) end |
#member_of_group?(group_name) ⇒ Boolean
Returns true if user is member of the specified group, false otherwise.
497 498 499 500 501 502 503 504 505 506 507 508 509 |
# File 'lib/chef/provider/user/dscl.rb', line 497 def member_of_group?(group_name) membership_info = "" begin membership_info = run_dscl("read", "/Groups/#{group_name}") rescue Chef::Exceptions::DsclCommandFailed # Raised if the group doesn't contain any members end # Output is something like: # GroupMembership: root admin etc members = membership_info.split(" ") members.shift # Get rid of GroupMembership: string members.include?(new_resource.username) end |
#move_home ⇒ Object
311 312 313 314 315 316 317 318 319 320 |
# File 'lib/chef/provider/user/dscl.rb', line 311 def move_home logger.trace("#{new_resource} moving #{self} home from #{current_resource.home} to #{new_resource.home}") new_resource.gid(STAFF_GROUP_ID) if new_resource.gid.nil? src = current_resource.home FileUtils.mkdir_p(new_resource.home) files = ::Dir.glob("#{Chef::Util::PathHelper.escape_glob_dir(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? ⇒ Boolean
303 304 305 |
# File 'lib/chef/provider/user/dscl.rb', line 303 def new_home_exists? ::File.exist?(new_resource.home) end |
#parameter_updated?(parameter) ⇒ Boolean
466 467 468 |
# File 'lib/chef/provider/user/dscl.rb', line 466 def parameter_updated?(parameter) !(new_resource.send(parameter) == current_resource.send(parameter)) end |
#prepare_password_shadow_info ⇒ Object
Prepares the password shadow info based on the platform version.
366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 |
# File 'lib/chef/provider/user/dscl.rb', line 366 def prepare_password_shadow_info shadow_info = {} entropy = nil salt = nil iterations = nil if salted_sha512_pbkdf2?(new_resource.password) entropy = convert_to_binary(new_resource.password) salt = convert_to_binary(new_resource.salt) iterations = new_resource.iterations else salt = OpenSSL::Random.random_bytes(32) iterations = new_resource.iterations # Use the default if not specified by the user entropy = OpenSSL::PKCS5.pbkdf2_hmac( new_resource.password, salt, iterations, 128, OpenSSL::Digest.new("SHA512") ) end pbkdf_info = {} pbkdf_info["entropy"] = StringIO.new pbkdf_info["entropy"].string = entropy pbkdf_info["salt"] = StringIO.new pbkdf_info["salt"].string = salt pbkdf_info["iterations"] = iterations shadow_info["SALTED-SHA512-PBKDF2"] = pbkdf_info shadow_info end |
#read_user_info ⇒ Object
Reads the user plist and returns a hash keyed with DSCL properties specified in DSCL_PROPERTY_MAP. Return nil if the user is not found.
534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 |
# File 'lib/chef/provider/user/dscl.rb', line 534 def read_user_info user_info = nil # We flush the cache here in order to make sure that we read fresh information # for the user. shell_out("dscacheutil", "-flushcache") # FIXME: this is macOS version dependent begin user_plist_file = "#{USER_PLIST_DIRECTORY}/#{new_resource.username}.plist" user_plist_info = run_plutil("convert", "xml1", "-o", "-", user_plist_file) user_info = ::Plist.parse_xml(user_plist_info) rescue Chef::Exceptions::PlistUtilCommandFailed end user_info end |
#remove_user ⇒ Object
Removes the user from the system after removing user from his groups and deleting home directory if needed.
404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 |
# File 'lib/chef/provider/user/dscl.rb', line 404 def remove_user if new_resource.manage_home # Remove home directory FileUtils.rm_rf(current_resource.home) end # Remove the user from its groups run_dscl("list", "/Groups").each_line do |group| if member_of_group?(group.chomp) run_dscl("delete", "/Groups/#{group.chomp}", "GroupMembership", new_resource.username) end end # Remove user account run_dscl("delete", "/Users/#{new_resource.username}") end |
#run_dscl(*args) ⇒ Object
System Helpers
586 587 588 589 590 591 592 593 |
# File 'lib/chef/provider/user/dscl.rb', line 586 def run_dscl(*args) result = shell_out("dscl", ".", "-#{args[0]}", args[1..]) 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.include?("No such key: ") result.stdout end |
#run_plutil(*args) ⇒ Object
595 596 597 598 599 600 601 602 603 604 |
# File 'lib/chef/provider/user/dscl.rb', line 595 def run_plutil(*args) result = shell_out("plutil", "-#{args[0]}", args[1..]) raise(Chef::Exceptions::PlistUtilCommandFailed, "plutil error: #{result.inspect}") unless result.exitstatus == 0 if result.stdout.encoding == Encoding::ASCII_8BIT result.stdout.encode("utf-8", "binary", undef: :replace, invalid: :replace, replace: "?") else result.stdout end end |
#salted_sha512?(string) ⇒ Boolean
614 615 616 |
# File 'lib/chef/provider/user/dscl.rb', line 614 def salted_sha512?(string) !!(string =~ /^[[:xdigit:]]{136}$/) end |
#salted_sha512_pbkdf2?(string) ⇒ Boolean
618 619 620 |
# File 'lib/chef/provider/user/dscl.rb', line 618 def salted_sha512_pbkdf2?(string) !!(string =~ /^[[:xdigit:]]{256}$/) end |
#salted_sha512_pbkdf2_password_match? ⇒ Boolean
622 623 624 625 626 627 628 629 630 631 632 |
# File 'lib/chef/provider/user/dscl.rb', line 622 def salted_sha512_pbkdf2_password_match? salt = convert_to_binary(current_resource.salt) OpenSSL::PKCS5.pbkdf2_hmac( new_resource.password, salt, current_resource.iterations, 128, OpenSSL::Digest.new("SHA512") ).unpack("H*").first == current_resource.password end |
#save_user_info(user_info) ⇒ Object
Saves the given hash keyed with DSCL properties specified in DSCL_PROPERTY_MAP to the disk.
555 556 557 558 559 |
# File 'lib/chef/provider/user/dscl.rb', line 555 def save_user_info(user_info) user_plist_file = "#{USER_PLIST_DIRECTORY}/#{new_resource.username}.plist" ::Plist::Emit.save_plist(user_info, user_plist_file) run_plutil("convert", "binary1", user_plist_file) end |
#set_password ⇒ Object
Sets the password for the user based on given password parameters. Chef supports specifying plain-text passwords and password shadow hash data.
338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 |
# File 'lib/chef/provider/user/dscl.rb', line 338 def set_password # Return if there is no password to set return if new_resource.password.nil? shadow_info = prepare_password_shadow_info # Shadow info is saved as binary plist. Convert the info to binary plist. shadow_info_binary = StringIO.new shell_out("plutil", "-convert", "binary1", "-o", "-", "-", input: shadow_info.to_plist, live_stream: shadow_info_binary) if user_info.nil? # User is just created. read_user_info() will read the fresh information # for the user with a cache flush. However with experimentation we've seen # that dscl cache is not immediately updated after the creation of the user # This is odd and needs to be investigated further. sleep 3 @user_info = read_user_info end # Replace the shadow info in user's plist dscl_set(user_info, :shadow_hash, shadow_info_binary) save_user_info(user_info) end |
#uid_used?(uid) ⇒ Boolean
Returns true if uid is in use by a different account, false otherwise.
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 |
# File 'lib/chef/provider/user/dscl.rb', line 231 def uid_used?(uid) return false unless uid users_uids = run_dscl("list", "/Users", "uid").split("\n") uid_map = users_uids.each_with_object({}) do |tuid, tmap| x = tuid.split tmap[x[1]] = x[0] tmap end if uid_map[uid.to_s] unless uid_map[uid.to_s] == new_resource.username return true end end false end |
#unlock_user ⇒ Object
Unlocks the user
431 432 433 434 |
# File 'lib/chef/provider/user/dscl.rb', line 431 def unlock_user auth_string = .gsub(/AuthenticationAuthority: /, "").gsub(/;DisabledUser;/, "").strip run_dscl("create", "/Users/#{new_resource.username}", "AuthenticationAuthority", auth_string) end |
#validate_home_dir_specification! ⇒ Object
293 294 295 296 297 |
# File 'lib/chef/provider/user/dscl.rb', line 293 def validate_home_dir_specification! unless %r{^/}.match?(new_resource.home) raise(Chef::Exceptions::InvalidHomeDirectory, "invalid path spec for User: '#{new_resource.username}', home directory: '#{new_resource.home}'") end end |