Class: Chef::Provider::User::Windows

Inherits:
Chef::Provider::User show all
Defined in:
lib/chef/provider/user/windows.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, #convert_group_name, #define_resource_requirements

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, #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) ⇒ Windows

Returns a new instance of Windows


32
33
34
35
# File 'lib/chef/provider/user/windows.rb', line 32

def initialize(new_resource, run_context)
  super
  @net_user = Chef::Util::Windows::NetUser.new(new_resource.username)
end

Instance Method Details

#check_lockObject


87
88
89
# File 'lib/chef/provider/user/windows.rb', line 87

def check_lock
  @net_user.check_enabled
end

#compare_userObject

Check to see if the user needs any changes

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


65
66
67
68
69
70
71
72
73
# File 'lib/chef/provider/user/windows.rb', line 65

def compare_user
  unless @net_user.validate_credentials(new_resource.password)
    Chef::Log.debug("#{new_resource} password has changed")
    return true
  end
  [ :uid, :comment, :home, :shell ].any? do |user_attrib|
    !new_resource.send(user_attrib).nil? && new_resource.send(user_attrib) != current_resource.send(user_attrib)
  end
end

#create_userObject


75
76
77
# File 'lib/chef/provider/user/windows.rb', line 75

def create_user
  @net_user.add(set_options)
end

#load_current_resourceObject


37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
# File 'lib/chef/provider/user/windows.rb', line 37

def load_current_resource
  if new_resource.gid
    Chef::Log.warn("The 'gid' (or 'group') property is not implemented on the Windows platform. Please use the `members` property of the  'group' resource to assign a user to a group.")
  end

  @current_resource = Chef::Resource::User.new(new_resource.name)
  current_resource.username(new_resource.username)
  begin
     = @net_user.get_info

    current_resource.uid([:user_id])
    current_resource.comment([:full_name])
    current_resource.home([:home_dir])
    current_resource.shell([:script_path])
  rescue Chef::Exceptions::UserIDNotFound => e
    # e.message should be "The user name could not be found" but checking for that could cause a localization bug
    @user_exists = false
    Chef::Log.debug("#{new_resource} does not exist (#{e.message})")
  end

  current_resource
end

#lock_userObject


91
92
93
# File 'lib/chef/provider/user/windows.rb', line 91

def lock_user
  @net_user.
end

#manage_userObject


79
80
81
# File 'lib/chef/provider/user/windows.rb', line 79

def manage_user
  @net_user.update(set_options)
end

#remove_userObject


83
84
85
# File 'lib/chef/provider/user/windows.rb', line 83

def remove_user
  @net_user.delete
end

#set_optionsObject


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

def set_options
  opts = { name: new_resource.username }

  field_list = {
    "comment" => "full_name",
    "home" => "home_dir",
    "uid" => "user_id",
    "shell" => "script_path",
    "password" => "password",
  }

  field_list.sort { |a, b| a[0] <=> b[0] }.each do |field, option|
    field_symbol = field.to_sym
    next unless current_resource.send(field_symbol) != new_resource.send(field_symbol)
    next unless new_resource.send(field_symbol)
    unless field_symbol == :password
      Chef::Log.debug("#{new_resource} setting #{field} to #{new_resource.send(field_symbol)}")
    end
    opts[option.to_sym] = new_resource.send(field_symbol)
  end
  opts
end

#unlock_userObject


95
96
97
# File 'lib/chef/provider/user/windows.rb', line 95

def unlock_user
  @net_user.
end