Class: Chef::Provider::Group::Windows

Inherits:
Chef::Provider::Group show all
Defined in:
lib/chef/provider/group/windows.rb

Instance Attribute Summary

Attributes inherited from Chef::Provider::Group

#change_desc, #group_exists

Attributes inherited from Chef::Provider

#action, #after_resource, #current_resource, #logger, #new_resource, #recipe_name, #run_context

Instance Method Summary collapse

Methods inherited from Chef::Provider::Group

#compare_group, #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, #cookbook_name, #define_resource_requirements, #description, #events, include_resource_dsl?, include_resource_dsl_module, #introduced, #load_after_resource, #node, #process_resource_requirements, provides, provides?, #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::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 Mixin::PowershellExec

#powershell_exec, #powershell_exec!

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

Constructor Details

#initialize(new_resource, run_context) ⇒ Windows

Returns a new instance of Windows.


31
32
33
34
# File 'lib/chef/provider/group/windows.rb', line 31

def initialize(new_resource, run_context)
  super
  @net_group = Chef::Util::Windows::NetGroup.new(new_resource.group_name)
end

Instance Method Details

#create_groupObject


66
67
68
69
# File 'lib/chef/provider/group/windows.rb', line 66

def create_group
  @net_group.local_add
  manage_group
end

#group_gid_match?Boolean

Returns:

  • (Boolean)

43
44
45
# File 'lib/chef/provider/group/windows.rb', line 43

def group_gid_match?
  true
end

#group_members_match?Boolean

Returns:

  • (Boolean)

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

def group_members_match?
  sorted_members_sids = new_resource.members.map { |x| (x) }.sort
  sorted_current_sids = current_resource.members.sort
  Chef::Log.debug("#{new_resource.name}: current_members: #{sorted_current_sids} vs new_members #{sorted_members_sids}")
  sorted_members_sids == sorted_current_sids
end

#has_current_group_member?(member) ⇒ Boolean

Returns:

  • (Boolean)

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

def has_current_group_member?(member)
  member_sid = (member)
  current_resource.members.include?(member_sid)
end

#load_current_resourceObject


47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
# File 'lib/chef/provider/group/windows.rb', line 47

def load_current_resource
  @current_resource = Chef::Resource::Group.new(new_resource.name)
  current_resource.group_name(new_resource.group_name)

  members = nil
  begin
    members = @net_group.local_get_members
  rescue
    @group_exists = false
    logger.trace("#{new_resource} group does not exist")
  end

  if members
    current_resource.members(members)
  end

  current_resource
end

#locally_qualified_name(account_name) ⇒ Object


103
104
105
# File 'lib/chef/provider/group/windows.rb', line 103

def locally_qualified_name()
  .include?("\\") ?  : "#{ENV["COMPUTERNAME"]}\\#{}"
end

#lookup_account_name(account_name) ⇒ Object


111
112
113
114
115
116
# File 'lib/chef/provider/group/windows.rb', line 111

def ()
  Chef::ReservedNames::Win32::Security.(locally_qualified_name())[1].to_s
rescue Chef::Exceptions::Win32APIError
  logger.warn("SID for '#{locally_qualified_name()}' could not be found")
  ""
end

#manage_groupObject


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/group/windows.rb', line 71

def manage_group
  if new_resource.append
    members_to_be_added = [ ]
    new_resource.members.each do |member|
      members_to_be_added << member if !has_current_group_member?(member) && validate_member!(member)
    end

    # local_add_members will raise ERROR_MEMBER_IN_ALIAS if a
    # member already exists in the group.
    @net_group.local_add_members(members_to_be_added) unless members_to_be_added.empty?

    members_to_be_removed = [ ]
    new_resource.excluded_members.each do |member|
      (member)
      members_to_be_removed << member if has_current_group_member?(member)
    end
    @net_group.local_delete_members(members_to_be_removed) unless members_to_be_removed.empty?
  elsif !group_members_match?
    @net_group.local_set_members(new_resource.members)
  end
  @net_group.local_group_set_info(new_resource.comment) if new_resource.comment
end

#remove_groupObject


99
100
101
# File 'lib/chef/provider/group/windows.rb', line 99

def remove_group
  @net_group.local_delete
end

#validate_member!(member) ⇒ Object


107
108
109
# File 'lib/chef/provider/group/windows.rb', line 107

def validate_member!(member)
  Chef::ReservedNames::Win32::Security.(locally_qualified_name(member))[1].to_s
end