class Chef::Provider::User::Windows

Public Class Methods

new(new_resource, run_context) click to toggle source
Calls superclass method Chef::Provider::User::new
# File lib/chef/provider/user/windows.rb, line 30
def initialize(new_resource, run_context)
  super
  @net_user = Chef::Util::Windows::NetUser.new(new_resource.username)
end

Public Instance Methods

check_lock() click to toggle source
# File lib/chef/provider/user/windows.rb, line 92
def check_lock
  @net_user.check_enabled
end
compare_user() click to toggle source

Check to see if the user needs any changes

Returns

<true>

If a change is required

<false>

If the users are identical

# File lib/chef/provider/user/windows.rb, line 63
def compare_user
  @change_desc = []
  if new_resource.password && !@net_user.validate_credentials(new_resource.password)
    @change_desc << "update password"
  end

  %i{uid comment home shell full_name}.any? do |user_attrib|
    new_val = new_resource.send(user_attrib)
    cur_val = current_resource.send(user_attrib)
    if !new_val.nil? && new_val != cur_val
      @change_desc << "change #{user_attrib} from #{cur_val} to #{new_val}"
    end
  end

  !@change_desc.empty?
end
create_user() click to toggle source
# File lib/chef/provider/user/windows.rb, line 80
def create_user
  @net_user.add(**set_options)
end
load_current_resource() click to toggle source
# File lib/chef/provider/user/windows.rb, line 35
def load_current_resource
  if new_resource.gid
    logger.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::WindowsUser.new(new_resource.name)
  current_resource.username(new_resource.username)
  begin
    user_info = @net_user.get_info
    current_resource.uid(user_info[:user_id])
    current_resource.full_name(user_info[:full_name])
    current_resource.comment(user_info[:comment])
    current_resource.home(user_info[:home_dir])
    current_resource.shell(user_info[: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
    logger.trace("#{new_resource} does not exist (#{e.message})")
  end

  current_resource
end
lock_user() click to toggle source
# File lib/chef/provider/user/windows.rb, line 96
def lock_user
  @net_user.disable_account
end
manage_user() click to toggle source
# File lib/chef/provider/user/windows.rb, line 84
def manage_user
  @net_user.update(**set_options)
end
remove_user() click to toggle source
# File lib/chef/provider/user/windows.rb, line 88
def remove_user
  @net_user.delete
end
set_options() click to toggle source
# File lib/chef/provider/user/windows.rb, line 104
def set_options
  opts = { name: new_resource.username }

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

  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)
    next unless new_resource.send(field_symbol)

    unless field_symbol == :password
      logger.trace("#{new_resource} setting #{field} to #{new_resource.send(field_symbol)}")
    end
    opts[option.to_sym] = new_resource.send(field_symbol)
  end
  opts
end
unlock_user() click to toggle source
# File lib/chef/provider/user/windows.rb, line 100
def unlock_user
  @net_user.enable_account
end