Class: Chef::Provider::User::Pw

Inherits:
Chef::Provider::User show all
Defined in:
lib/chef/provider/user/pw.rb

Instance Attribute Summary

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

Methods inherited from Chef::Provider::User

#compare_user, #convert_group_name, #define_resource_requirements, #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, #define_resource_requirements, #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

#ps_credential

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

#encrypted?

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

load_cheffish

Methods included from DSL::RebootPending

#reboot_pending?

Methods included from DSL::IncludeRecipe

#include_recipe, #load_recipe

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 Method Details

#check_lock ⇒ Object 



49
50
51
52
53
54
55
56
57
 
# File 'lib/chef/provider/user/pw.rb', line 49

def check_lock
  @locked = case current_resource.password
            when /^\*LOCKED\*/
              true
            else
              false
            end
  @locked
end

#create_user ⇒ Object 



33
34
35
36
 
# File 'lib/chef/provider/user/pw.rb', line 33

def create_user
  shell_out!("pw", "useradd", set_options)
  modify_password
end

#load_current_resource ⇒ Object

Raises:



28
29
30
31
 
# File 'lib/chef/provider/user/pw.rb', line 28

def load_current_resource
  super
  raise Chef::Exceptions::User, "Could not find binary /usr/sbin/pw for #{new_resource}" unless ::TargetIO::File.exist?("/usr/sbin/pw")
end

#lock_user ⇒ Object 



59
60
61
 
# File 'lib/chef/provider/user/pw.rb', line 59

def lock_user
  shell_out!("pw", "lock", new_resource.username)
end

#manage_user ⇒ Object 



38
39
40
41
 
# File 'lib/chef/provider/user/pw.rb', line 38

def manage_user
  shell_out!("pw", "usermod", set_options)
  modify_password
end

#modify_password ⇒ Object 



94
95
96
97
98
99
100
101
102
 
# File 'lib/chef/provider/user/pw.rb', line 94

def modify_password
  if !new_resource.password.nil? && (current_resource.password != new_resource.password)
    logger.trace("#{new_resource} updating password")
    command = "pw usermod #{new_resource.username} -H 0"
    shell_out!(command, input: new_resource.password.to_s)
  else
    logger.debug("#{new_resource} no change needed to password")
  end
end

#remove_user ⇒ Object 



43
44
45
46
47
 
# File 'lib/chef/provider/user/pw.rb', line 43

def remove_user
  command = [ "pw", "userdel", new_resource.username ]
  command << "-r" if new_resource.manage_home
  shell_out!(command)
end

#set_options ⇒ Object 



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
 
# File 'lib/chef/provider/user/pw.rb', line 67

def set_options
  opts = [ new_resource.username ]

  field_list = {
    "comment" => "-c",
    "home" => "-d",
    "gid" => "-g",
    "uid" => "-u",
    "shell" => "-s",
  }
  field_list.sort_by { |a| a[0] }.each do |field, option|
    field_symbol = field.to_sym
    next unless current_resource.send(field_symbol) != new_resource.send(field_symbol)

    if new_resource.send(field_symbol)
      logger.trace("#{new_resource} setting #{field} to #{new_resource.send(field_symbol)}")
      opts << option
      opts << new_resource.send(field_symbol)
    end
  end
  if new_resource.manage_home
    logger.trace("#{new_resource} is managing the users home directory")
    opts << "-m"
  end
  opts
end

#unlock_user ⇒ Object 



63
64
65
 
# File 'lib/chef/provider/user/pw.rb', line 63

def unlock_user
  shell_out!("pw", "unlock", new_resource.username)
end