Class: Chef::Provider::RegistryKey

Inherits:
Chef::Provider show all
Includes:
Mixin::Checksum
Defined in:
lib/chef/provider/registry_key.rb

Instance Attribute Summary

Attributes inherited from Chef::Provider

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

Instance Method Summary collapse

Methods included from Mixin::Checksum

#checksum, #short_cksum

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, #description, #events, include_resource_dsl?, include_resource_dsl_module, #initialize, #introduced, #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::ShellOut

apply_default_env, maybe_add_timeout, #shell_out, #shell_out!

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

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

This class inherits a constructor from Chef::Provider

Instance Method Details

#action_create ⇒ Object 



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/chef/provider/registry_key.rb', line 116

def action_create
  unless registry.key_exists?(current_resource.key)
    converge_by("create key #{new_resource.key}") do
      registry.create_key(new_resource.key, new_resource.recursive)
    end
  end
  new_resource.unscrubbed_values.each do |value|
    if @name_hash.key?(value[:name].downcase)
      current_value = @name_hash[value[:name].downcase]
      if %i{dword dword_big_endian qword}.include? value[:type]
        value[:data] = value[:data].to_i
      end
      unless current_value[:type] == value[:type] && current_value[:data] == value[:data]
        converge_by_value = if new_resource.sensitive
                              value.merge(data: "*sensitive value suppressed*")
                            else
                              value
                            end

        converge_by("set value #{converge_by_value}") do
          registry.set_value(new_resource.key, value)
        end
      end
    else
      converge_by_value = if new_resource.sensitive
                            value.merge(data: "*sensitive value suppressed*")
                          else
                            value
                          end

      converge_by("set value #{converge_by_value}") do
        registry.set_value(new_resource.key, value)
      end
    end
  end
end

#action_create_if_missing ⇒ Object 



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/chef/provider/registry_key.rb', line 153

def action_create_if_missing
  unless registry.key_exists?(new_resource.key)
    converge_by("create key #{new_resource.key}") do
      registry.create_key(new_resource.key, new_resource.recursive)
    end
  end
  new_resource.unscrubbed_values.each do |value|
    unless @name_hash.key?(value[:name].downcase)
      converge_by_value = if new_resource.sensitive
                            value.merge(data: "*sensitive value suppressed*")
                          else
                            value
                          end

      converge_by("create value #{converge_by_value}") do
        registry.set_value(new_resource.key, value)
      end
    end
  end
end

#action_delete ⇒ Object 



174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/chef/provider/registry_key.rb', line 174

def action_delete
  if registry.key_exists?(new_resource.key)
    new_resource.unscrubbed_values.each do |value|
      if @name_hash.key?(value[:name].downcase)
        converge_by_value = value
        converge_by_value[:data] = "*sensitive value suppressed*" if new_resource.sensitive

        converge_by("delete value #{converge_by_value}") do
          registry.delete_value(new_resource.key, value)
        end
      end
    end
  end
end

#action_delete_key ⇒ Object 



189
190
191
192
193
194
195
 
# File 'lib/chef/provider/registry_key.rb', line 189

def action_delete_key
  if registry.key_exists?(new_resource.key)
    converge_by("delete key #{new_resource.key}") do
      registry.delete_key(new_resource.key, new_resource.recursive)
    end
  end
end

#define_resource_requirements ⇒ Object 



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/chef/provider/registry_key.rb', line 76

def define_resource_requirements
  requirements.assert(:create, :create_if_missing, :delete, :delete_key) do |a|
    a.assertion { registry.hive_exists?(new_resource.key) }
    a.failure_message(Chef::Exceptions::Win32RegHiveMissing, "Hive #{new_resource.key.split('\\').shift} does not exist")
  end

  requirements.assert(:create) do |a|
    a.assertion { registry.key_exists?(new_resource.key) }
    a.whyrun("Key #{new_resource.key} does not exist. Unless it would have been created before, attempt to modify its values would fail.")
  end

  requirements.assert(:create, :create_if_missing) do |a|
    # If keys missing in the path and recursive == false
    a.assertion { !registry.keys_missing?(current_resource.key) || new_resource.recursive }
    a.failure_message(Chef::Exceptions::Win32RegNoRecursive, "Intermediate keys missing but recursive is set to false")
    a.whyrun("Intermediate keys in #{new_resource.key} do not exist. Unless they would have been created earlier, attempt to modify them would fail.")
  end

  requirements.assert(:delete_key) do |a|
    # If key to be deleted has subkeys but recurssive == false
    a.assertion { !registry.key_exists?(new_resource.key) || !registry.has_subkeys?(new_resource.key) || new_resource.recursive }
    a.failure_message(Chef::Exceptions::Win32RegNoRecursive, "#{new_resource.key} has subkeys but recursive is set to false.")
    a.whyrun("#{current_resource.key} has subkeys, but recursive is set to false. attempt to delete would fails unless subkeys were deleted prior to this action.")
  end

  requirements.assert(:create, :create_if_missing) do |a|
    # If type key missing in the RegistryKey values hash
    a.assertion { !key_missing?(new_resource.values, :type) }
    a.failure_message(Chef::Exceptions::RegKeyValuesTypeMissing, "Missing type key in RegistryKey values hash")
    a.whyrun("Type key does not exist. Attempt would fail unless the complete values hash containing all the keys does not exist for registry_key resource's create action.")
  end

  requirements.assert(:create, :create_if_missing) do |a|
    # If data key missing in the RegistryKey values hash
    a.assertion { !key_missing?(new_resource.values, :data) }
    a.failure_message(Chef::Exceptions::RegKeyValuesDataMissing, "Missing data key in RegistryKey values hash")
    a.whyrun("Data key does not exist. Attempt would fail unless the complete values hash containing all the keys does not exist for registry_key resource's create action.")
  end
end

#key_missing?(values, name) ⇒ Boolean

Returns:

  • (Boolean) 


69
70
71
72
73
74
 
# File 'lib/chef/provider/registry_key.rb', line 69

def key_missing?(values, name)
  values.each do |v|
    return true unless v.key?(name)
  end
  false
end

#load_current_resource ⇒ Object 



44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/chef/provider/registry_key.rb', line 44

def load_current_resource
  running_on_windows!
  @current_resource ||= Chef::Resource::RegistryKey.new(new_resource.key, run_context)
  current_resource.key(new_resource.key)
  current_resource.architecture(new_resource.architecture)
  current_resource.recursive(new_resource.recursive)
  if registry.key_exists?(new_resource.key)
    current_resource.values(registry.get_values(new_resource.key))
  end
  values_to_hash(current_resource.unscrubbed_values)
  current_resource
end

#registry ⇒ Object 



57
58
59
 
# File 'lib/chef/provider/registry_key.rb', line 57

def registry
  @registry ||= Chef::Win32::Registry.new(@run_context, new_resource.architecture)
end

#running_on_windows! ⇒ Object 



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

def running_on_windows!
  unless ChefUtils.windows?
    raise Chef::Exceptions::Win32NotWindows, "Attempt to manipulate the windows registry on a non-windows node"
  end
end

#values_to_hash(values) ⇒ Object 



61
62
63
64
65
66
67
 
# File 'lib/chef/provider/registry_key.rb', line 61

def values_to_hash(values)
  if values
    @name_hash = Hash[values.map { |val| [val[:name].downcase, val] }]
  else
    @name_hash = {}
  end
end