Class: Chef::Provider::User::Linux

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

Instance Attribute Summary

Attributes inherited from Chef::Provider::User

#locked, #user_exists

Attributes inherited from Chef::Provider

#action, #cookbook_name, #current_resource, #new_resource, #recipe_name, #run_context

Instance Method Summary collapse

Methods inherited from Chef::Provider::User

#action_create, #action_lock, #action_manage, #action_modify, #action_remove, #action_unlock, #compare_user, #convert_group_name, #define_resource_requirements, #initialize, #load_current_resource

Methods inherited from Chef::Provider

action, #action_nothing, #check_resource_semantics!, #cleanup_after_converge, #compile_and_converge_action, #converge_by, #converge_if_changed, #define_resource_requirements, #events, include_resource_dsl?, include_resource_dsl_module, #initialize, #load_current_resource, #node, #process_resource_requirements, provides, provides?, #requirements, #resource_collection, #resource_updated?, #run_action, #set_updated_status, supports?, use_inline_resources, #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::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!, #with_run_context

Methods included from Mixin::ShellOut

#a_to_s, #clean_array, #shell_out, #shell_out!, #shell_out_compact, #shell_out_compact!, #shell_out_compact_timeout, #shell_out_compact_timeout!, #shell_out_with_systems_locale, #shell_out_with_systems_locale!

Methods included from Mixin::PathSanity

#enforce_path_sanity, #sanitized_path

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::PlatformIntrospection

#docker?, #platform?, #platform_family?, #value_for_platform, #value_for_platform_family

Constructor Details

This class inherits a constructor from Chef::Provider::User

Instance Method Details

#check_lockObject


98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
# File 'lib/chef/provider/user/linux.rb', line 98

def check_lock
  # there's an old bug in rhel (https://bugzilla.redhat.com/show_bug.cgi?id=578534)
  # which means that both 0 and 1 can be success.
  passwd_s = shell_out_compact("passwd", "-S", new_resource.username, returns: [ 0, 1 ])

  # checking "does not exist" has to come before exit code handling since centos and ubuntu differ in exit codes
  if passwd_s.stderr =~ /does not exist/
    return false if whyrun_mode?
    raise Chef::Exceptions::User, "User #{new_resource.username} does not exist when checking lock status for #{new_resource}"
  end

  # now raise if we didn't get a 0 or 1 (see above)
  passwd_s.error!

  # now the actual output parsing
  @locked = nil
  status_line = passwd_s.stdout.split(" ")
  @locked = false if status_line[1] =~ /^[PN]/
  @locked = true if status_line[1] =~ /^L/

  raise Chef::Exceptions::User, "Cannot determine if user #{new_resource.username} is locked for #{new_resource}" if @locked.nil?

  # FIXME: should probably go on the current_resource
  @locked
end

#create_userObject


26
27
28
# File 'lib/chef/provider/user/linux.rb', line 26

def create_user
  shell_out_compact!("useradd", universal_options, useradd_options, new_resource.username)
end

#lock_userObject


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

def lock_user
  shell_out_compact!("usermod", "-L", new_resource.username)
end

#manage_userObject


30
31
32
# File 'lib/chef/provider/user/linux.rb', line 30

def manage_user
  shell_out_compact!("usermod", universal_options, usermod_options, new_resource.username)
end

#remove_userObject


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

def remove_user
  shell_out_compact!("userdel", userdel_options, new_resource.username)
end

#should_set?(sym) ⇒ Boolean


88
89
90
# File 'lib/chef/provider/user/linux.rb', line 88

def should_set?(sym)
  current_resource.send(sym).to_s != new_resource.send(sym).to_s && new_resource.send(sym)
end

#universal_optionsObject

common to usermod and useradd


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

def universal_options
  opts = []
  opts << "-c" << new_resource.comment if should_set?(:comment)
  opts << "-g" << new_resource.gid if should_set?(:gid)
  opts << "-p" << new_resource.password if should_set?(:password)
  opts << "-s" << new_resource.shell if should_set?(:shell)
  opts << "-u" << new_resource.uid if should_set?(:uid)
  opts << "-d" << new_resource.home if updating_home?
  opts << "-o" if new_resource.non_unique
  opts
end

#unlock_userObject


42
43
44
# File 'lib/chef/provider/user/linux.rb', line 42

def unlock_user
  shell_out_compact!("usermod", "-U", new_resource.username)
end

#updating_home?Boolean


92
93
94
95
96
# File 'lib/chef/provider/user/linux.rb', line 92

def updating_home?
  return false unless new_resource.home
  return true unless current_resource.home
  new_resource.home && Pathname.new(current_resource.home).cleanpath != Pathname.new(new_resource.home).cleanpath
end

#useradd_optionsObject


70
71
72
73
74
75
76
77
78
79
# File 'lib/chef/provider/user/linux.rb', line 70

def useradd_options
  opts = []
  opts << "-r" if new_resource.system
  opts << if new_resource.manage_home
            "-m"
          else
            "-M"
          end
  opts
end

#userdel_optionsObject


81
82
83
84
85
86
# File 'lib/chef/provider/user/linux.rb', line 81

def userdel_options
  opts = []
  opts << "-r" if new_resource.manage_home
  opts << "-f" if new_resource.force
  opts
end

#usermod_optionsObject


59
60
61
62
63
64
65
66
67
68
# File 'lib/chef/provider/user/linux.rb', line 59

def usermod_options
  opts = []
  opts += [ "-u", new_resource.uid ] if new_resource.non_unique
  if updating_home?
    if new_resource.manage_home
      opts << "-m"
    end
  end
  opts
end