Class: Chef::Provider::User

Inherits:
Chef::Provider show all
Defined in:
lib/chef/provider/user.rb,
lib/chef/provider/user/pw.rb,
lib/chef/provider/user/aix.rb,
lib/chef/provider/user/dscl.rb,
lib/chef/provider/user/linux.rb,
lib/chef/provider/user/solaris.rb,
lib/chef/provider/user/useradd.rb,
lib/chef/provider/user/windows.rb

Direct Known Subclasses

Dscl, Linux, Pw, Useradd, Windows

Defined Under Namespace

Classes: Aix, Dscl, Linux, Pw, Solaris, Useradd, Windows

Instance Attribute Summary collapse

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

action, #action_nothing, #check_resource_semantics!, #cleanup_after_converge, #compile_and_converge_action, #converge_by, #converge_if_changed, #events, include_resource_dsl?, include_resource_dsl_module, #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

#initialize(new_resource, run_context) ⇒ User


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

def initialize(new_resource, run_context)
  super
  @user_exists = true
  @locked = nil
  @shadow_lib_ok = true
  @group_name_resolved = true
end

Instance Attribute Details

#lockedObject

Returns the value of attribute locked


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

def locked
  @locked
end

#user_existsObject

Returns the value of attribute user_exists


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

def user_exists
  @user_exists
end

Instance Method Details

#action_createObject


119
120
121
122
123
124
125
126
127
128
129
130
131
# File 'lib/chef/provider/user.rb', line 119

def action_create
  if !@user_exists
    converge_by("create user #{new_resource.username}") do
      create_user
      Chef::Log.info("#{new_resource} created")
    end
  elsif compare_user
    converge_by("alter user #{new_resource.username}") do
      manage_user
      Chef::Log.info("#{new_resource} altered")
    end
  end
end

#action_lockObject


157
158
159
160
161
162
163
164
165
166
# File 'lib/chef/provider/user.rb', line 157

def action_lock
  if check_lock == false
    converge_by("lock the user #{new_resource.username}") do
      lock_user
      Chef::Log.info("#{new_resource} locked")
    end
  else
    Chef::Log.debug("#{new_resource} already locked - nothing to do")
  end
end

#action_manageObject


141
142
143
144
145
146
147
# File 'lib/chef/provider/user.rb', line 141

def action_manage
  return unless @user_exists && compare_user
  converge_by("manage user #{new_resource.username}") do
    manage_user
    Chef::Log.info("#{new_resource} managed")
  end
end

#action_modifyObject


149
150
151
152
153
154
155
# File 'lib/chef/provider/user.rb', line 149

def action_modify
  return unless compare_user
  converge_by("modify user #{new_resource.username}") do
    manage_user
    Chef::Log.info("#{new_resource} modified")
  end
end

#action_removeObject


133
134
135
136
137
138
139
# File 'lib/chef/provider/user.rb', line 133

def action_remove
  return unless @user_exists
  converge_by("remove user #{new_resource.username}") do
    remove_user
    Chef::Log.info("#{new_resource} removed")
  end
end

#action_unlockObject


168
169
170
171
172
173
174
175
176
177
# File 'lib/chef/provider/user.rb', line 168

def action_unlock
  if check_lock == true
    converge_by("unlock user #{new_resource.username}") do
      unlock_user
      Chef::Log.info("#{new_resource} unlocked")
    end
  else
    Chef::Log.debug("#{new_resource} already unlocked - nothing to do")
  end
end

#check_lockObject

Raises:

  • (NotImplementedError)

199
200
201
# File 'lib/chef/provider/user.rb', line 199

def check_lock
  raise NotImplementedError
end

#compare_userObject

Check to see if the user needs any changes

=== Returns :: If a change is required :: If the users are identical


109
110
111
112
113
114
115
116
117
# File 'lib/chef/provider/user.rb', line 109

def compare_user
  return true if !new_resource.home.nil? && Pathname.new(new_resource.home).cleanpath != Pathname.new(current_resource.home).cleanpath

  [ :comment, :shell, :password, :uid, :gid ].each do |user_attrib|
    return true if !new_resource.send(user_attrib).nil? && new_resource.send(user_attrib).to_s != current_resource.send(user_attrib).to_s
  end

  false
end

#convert_group_nameObject


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

def convert_group_name
  if new_resource.gid.is_a? String
    new_resource.gid(Etc.getgrnam(new_resource.gid).gid)
  end
rescue ArgumentError
  @group_name_resolved = false
end

#create_userObject

Raises:

  • (NotImplementedError)

179
180
181
# File 'lib/chef/provider/user.rb', line 179

def create_user
  raise NotImplementedError
end

#define_resource_requirementsObject


85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
# File 'lib/chef/provider/user.rb', line 85

def define_resource_requirements
  requirements.assert(:create, :modify, :manage, :lock, :unlock) do |a|
    a.assertion { @group_name_resolved }
    a.failure_message Chef::Exceptions::User, "Couldn't lookup integer GID for group name #{new_resource.gid}"
    a.whyrun "group name #{new_resource.gid} does not exist.  This will cause group assignment to fail.  Assuming this group will have been created previously."
  end
  requirements.assert(:all_actions) do |a|
    a.assertion { @shadow_lib_ok }
    a.failure_message Chef::Exceptions::MissingLibrary, "You must have ruby-shadow installed for password support!"
    a.whyrun "ruby-shadow is not installed. Attempts to set user password will cause failure.  Assuming that this gem will have been previously installed." \
      "Note that user update converge may report false-positive on the basis of mismatched password. "
  end
  requirements.assert(:modify, :lock, :unlock) do |a|
    a.assertion { @user_exists }
    a.failure_message(Chef::Exceptions::User, "Cannot modify user #{new_resource.username} - does not exist!")
    a.whyrun("Assuming user #{new_resource.username} would have been created")
  end
end

#load_current_resourceObject


44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
# File 'lib/chef/provider/user.rb', line 44

def load_current_resource
  @current_resource = Chef::Resource::User.new(new_resource.name)
  current_resource.username(new_resource.username)

  begin
     = Etc.getpwnam(new_resource.username)
  rescue ArgumentError
    @user_exists = false
    Chef::Log.debug("#{new_resource} user does not exist")
     = nil
  end

  if 
    current_resource.uid(.uid)
    current_resource.gid(.gid)
    current_resource.home(.dir)
    current_resource.shell(.shell)
    current_resource.password(.passwd)

    if new_resource.comment
      .gecos.force_encoding(new_resource.comment.encoding)
    end
    current_resource.comment(.gecos)

    if new_resource.password && current_resource.password == "x"
      begin
        require "shadow"
      rescue LoadError
        @shadow_lib_ok = false
      else
        shadow_info = Shadow::Passwd.getspnam(new_resource.username)
        current_resource.password(shadow_info.sp_pwdp)
      end
    end

    convert_group_name if new_resource.gid
  end

  current_resource
end

#lock_userObject

Raises:

  • (NotImplementedError)

191
192
193
# File 'lib/chef/provider/user.rb', line 191

def lock_user
  raise NotImplementedError
end

#manage_userObject

Raises:

  • (NotImplementedError)

187
188
189
# File 'lib/chef/provider/user.rb', line 187

def manage_user
  raise NotImplementedError
end

#remove_userObject

Raises:

  • (NotImplementedError)

183
184
185
# File 'lib/chef/provider/user.rb', line 183

def remove_user
  raise NotImplementedError
end

#unlock_userObject

Raises:

  • (NotImplementedError)

195
196
197
# File 'lib/chef/provider/user.rb', line 195

def unlock_user
  raise NotImplementedError
end