Class: Puppet::Provider::DscBaseProvider

Inherits:
Object
  • Object
show all
Defined in:
lib/puppet/provider/dsc_base_provider/dsc_base_provider.rb

Overview

rubocop:disable Metrics/ClassLength

Constant Summary collapse

SECRET_POSTFIX =

In order to avoid having to update the string that indicates when a value came from a sensitive string in multiple places, use a constant to indicate what the text of the secret identifier should be. This is used to write, identify, and redact secrets between PowerShell & Puppet.

'#PuppetSensitive'
SECRET_DATA_REGEX =

With multiple methods which need to discover secrets it is necessary to keep a single regex which can discover them. This will lazily match everything in a single-quoted string which ends with the secret postfix id and mark the actual contents of the string as the secret.

/'(?<secret>[^']+)+?#{Regexp.quote(SECRET_POSTFIX)}'/.freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ DscBaseProvider

Initializes the provider, preparing the instance variables which cache:

  • the canonicalized resources across calls

  • query results

  • logon failures



13
14
15
16
17
18
19
20
 
# File 'lib/puppet/provider/dsc_base_provider/dsc_base_provider.rb', line 13

def initialize
  @cached_canonicalized_resource = []
  @cached_query_results = []
  @cached_test_results = []
  @logon_failures = []
  @timeout = nil # default timeout, ps_manager.execute is expecting nil by default..
  super
end

Instance Attribute Details

#cached_test_results ⇒ Object (readonly)

Returns the value of attribute cached_test_results.



22
23
24
 
# File 'lib/puppet/provider/dsc_base_provider/dsc_base_provider.rb', line 22

def cached_test_results
  @cached_test_results
end

Instance Method Details

#canonicalize(context, resources) ⇒ Hash

Implements the canonicalize feature of the Resource API; this method is called first against any resources defined in the manifest, then again to conform the results from a get call. The method attempts to retrieve the DSC resource from the machine; if the resource is found, this method then compares the downcased values of the two hashes, overwriting the manifest value with the discovered one if they are case insensitively equivalent; this enables case insensitive but preserving behavior where a manifest declaration of a path as “c:/foo/bar” if discovered on disk as “C:FooBar” will canonicalize to the latter and prevent any flapping.

rubocop:disable Metrics/BlockLength, Metrics/MethodLength

Parameters:

  • context (Object) —

    the Puppet runtime context to operate in and send feedback to

  • resources (Hash) —

    the hash of the resource to canonicalize from either manifest or invocation

Returns:

  • (Hash) —

    returns a hash representing the current state of the object, if it exists



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
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
115
116
117
 
# File 'lib/puppet/provider/dsc_base_provider/dsc_base_provider.rb', line 49

def canonicalize(context, resources)
  canonicalized_resources = []
  resources.collect do |r|
    # During RSAPI refresh runs mandatory parameters are stripped and not available;
    # Instead of checking again and failing, search the cache for a namevar match.
    namevarized_r = r.select { |k, _v| namevar_attributes(context).include?(k) }
    cached_result = fetch_cached_hashes(@cached_canonicalized_resource, [namevarized_r]).first
    if cached_result.nil?
      # If the resource is meant to be absent, skip canonicalization and rely on the manifest
      # value; there's no reason to compare system state to desired state for casing if the
      # resource is being removed.
      if r[:dsc_ensure] == 'absent'
        canonicalized = r.dup
        @cached_canonicalized_resource << r.dup
      else
        canonicalized = invoke_get_method(context, r)
        # If the resource could not be found or was returned as absent, skip case munging and
        # treat the manifest values as canonical since the resource is being created.
        # rubocop:disable Metrics/BlockNesting
        if canonicalized.nil? || canonicalized[:dsc_ensure] == 'absent'
          canonicalized = r.dup
          @cached_canonicalized_resource << r.dup
        else
          parameters = r.select { |name, _properties| parameter_attributes(context).include?(name) }
          canonicalized.merge!(parameters)
          canonicalized[:name] = r[:name]
          if r[:dsc_psdscrunascredential].nil?
            canonicalized.delete(:dsc_psdscrunascredential)
          else
            canonicalized[:dsc_psdscrunascredential] = r[:dsc_psdscrunascredential]
          end
          downcased_result = recursively_downcase(canonicalized)
          downcased_resource = recursively_downcase(r)
          # Ensure that metaparameters are preserved when we canonicalize the resource.
          metaparams = downcased_resource.select { |key, _value| Puppet::Type.metaparam?(key) }
          canonicalized.merge!(metaparams) unless metaparams.nil?
          downcased_result.each do |key, value|
            # Canonicalize to the manifest value unless the downcased strings match and the attribute is not an enum:
            # - When the values don't match at all, the manifest value is desired;
            # - When the values match case insensitively but the attribute is an enum, and the casing from invoke_get_method
            #   is not int the enum, prefer the casing of the manifest enum.
            # - When the values match case insensitively and the attribute is not an enum, or is an enum and invoke_get_method casing
            #   is in the enum, prefer the casing from invoke_get_method
            is_enum = enum_attributes(context).include?(key)
            canonicalized_value_in_enum = if is_enum
                                            enum_values(context, key).include?(canonicalized[key])
                                          else
                                            false
                                          end
            match_insensitively = same?(value, downcased_resource[key])
            canonicalized[key] = r[key] unless match_insensitively && (canonicalized_value_in_enum || !is_enum)
            canonicalized.delete(key) unless downcased_resource.key?(key)
          end
          # Cache the actually canonicalized resource separately
          @cached_canonicalized_resource << canonicalized.dup
        end
        # rubocop:enable Metrics/BlockNesting
      end
    else
      # The resource has already been canonicalized for the set values and is not being canonicalized for get
      # In this case, we do *not* want to process anything, just return the resource. We only call canonicalize
      # so we can get case insensitive but preserving values for _setting_ state.
      canonicalized = r
    end
    canonicalized_resources << canonicalized
  end
  context.debug("Canonicalized Resources: #{canonicalized_resources}")
  canonicalized_resources
end

#clear_instantiated_variables! ⇒ Object

Clear the instantiated variables hash to be ready for the next run



581
582
583
 
# File 'lib/puppet/provider/dsc_base_provider/dsc_base_provider.rb', line 581

def clear_instantiated_variables!
  @instantiated_variables = {}
end

#create(context, name, should) ⇒ Hash

Attempts to set an instance of the DSC resource, invoking the ‘Set` method and thinly wrapping the `invoke_set_method` method; whether this method, `update`, or `delete` is called is entirely up to the Resource API based on the results

Parameters:

  • context (Object) —

    the Puppet runtime context to operate in and send feedback to

  • name (String) —

    the name of the resource being created

Returns:

  • (Hash) —

    returns a hash indicating whether or not the resource is in the desired state, whether or not it requires a reboot, and any error messages captured.



211
212
213
214
 
# File 'lib/puppet/provider/dsc_base_provider/dsc_base_provider.rb', line 211

def create(context, name, should)
  context.debug("Creating '#{name}' with #{should.inspect}")
  invoke_set_method(context, name, should)
end

#delete(context, name) ⇒ Hash

Attempts to set an instance of the DSC resource, invoking the ‘Set` method and thinly wrapping the `invoke_set_method` method; whether this method, `create`, or `update` is called is entirely up to the Resource API based on the results

Parameters:

  • context (Object) —

    the Puppet runtime context to operate in and send feedback to

  • name (String) —

    the name of the resource being created

Returns:

  • (Hash) —

    returns a hash indicating whether or not the resource is in the desired state, whether or not it requires a reboot, and any error messages captured.



235
236
237
238
 
# File 'lib/puppet/provider/dsc_base_provider/dsc_base_provider.rb', line 235

def delete(context, name)
  context.debug("Deleting '#{name}'")
  invoke_set_method(context, name, name.merge({ dsc_ensure: 'Absent' }))
end

#downcase_hash_keys!(enumerable) ⇒ Object

Recursively transforms any enumerable, downcasing any hash keys it finds, changing the passed enumerable.

Parameters:

  • enumerable (Enumerable) —

    a string, array, hash, or other object to attempt to recursively downcase



599
600
601
602
603
604
605
606
607
608
609
 
# File 'lib/puppet/provider/dsc_base_provider/dsc_base_provider.rb', line 599

def downcase_hash_keys!(enumerable)
  if enumerable.is_a?(Hash)
    enumerable.keys.each do |key| # rubocop:disable Style/HashEachMethods
      name = key.dup.downcase
      enumerable[name] = enumerable.delete(key)
      downcase_hash_keys!(enumerable[name]) if enumerable[name].is_a?(Enumerable)
    end
  else
    enumerable.each { |item| downcase_hash_keys!(item) if item.is_a?(Enumerable) }
  end
end

#enum_attributes(context) ⇒ Array

Parses the DSC resource type definition to retrieve the names of any attributes which are specified as enums Note that for complex types, especially those that have nested CIM instances, this will return for any data type which includes an Enum, not just for simple ‘Enum[]` or `Optional[Enum]` data types.

Parameters:

  • context (Object) —

    the Puppet runtime context to operate in and send feedback to

Returns:

  • (Array) —

    returns an array of attribute names as symbols which are enums



721
722
723
 
# File 'lib/puppet/provider/dsc_base_provider/dsc_base_provider.rb', line 721

def enum_attributes(context)
  context.type.attributes.select { |_name, properties| properties[:type].include?('Enum[') }.keys
end

#enum_values(context, attribute) ⇒ Array

Parses the DSC resource type definition to retrieve the values of any attributes which are specified as enums

Parameters:

  • context (Object) —

    the Puppet runtime context to operate in and send feedback to

  • attribute (String) —

    the enum attribute to retrieve the allowed values from

Returns:

  • (Array) —

    returns an array of attribute names as symbols which are enums



730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
 
# File 'lib/puppet/provider/dsc_base_provider/dsc_base_provider.rb', line 730

def enum_values(context, attribute)
  # Get the attribute's type string for the given key
  type_string = context.type.attributes[attribute][:type]

  # Return an empty array if the key doesn't have an Enum type or doesn't exist
  return [] unless type_string&.include?('Enum[')

  # Extract the enum values from the type string
  enum_content = type_string.match(/Enum\[(.*?)\]/)&.[](1)

  # Return an empty array if we couldn't find the enum values
  return [] if enum_content.nil?

  # Return an array of the enum values, stripped of extra whitespace and quote marks
  enum_content.split(',').map { |val| val.strip.delete('\'') }
end

#escape_quotes(text) ⇒ String

Escape any nested single quotes in a Sensitive string

Parameters:

  • text (String) —

    the text to escape

Returns:

  • (String) —

    the escaped text



1025
1026
1027
 
# File 'lib/puppet/provider/dsc_base_provider/dsc_base_provider.rb', line 1025

def escape_quotes(text)
  text.gsub("'", "''")
end

#fetch_cached_hashes(cache, hashes) ⇒ Array

Look through a cache to retrieve the hashes specified, if they have been cached. Does so by seeing if each of the specified hashes is a subset of any of the hashes in the cache, so 1, bar: 2 would return if 1 was the search hash.

Parameters:

  • cache (Array) —

    the instance variable containing cached hashes to search through

  • hashes (Array) —

    the list of hashes to search the cache for

Returns:

  • (Array) —

    an array containing the matching hashes for the search condition, if any



31
32
33
34
35
36
 
# File 'lib/puppet/provider/dsc_base_provider/dsc_base_provider.rb', line 31

def fetch_cached_hashes(cache, hashes)
  cache.reject do |item|
    matching_hash = hashes.select { |hash| (item.to_a - hash.to_a).empty? || (hash.to_a - item.to_a).empty? }
    matching_hash.empty?
  end.flatten
end

#format(value) ⇒ String

Convert a Puppet/Ruby value into a PowerShell representation. Requires some slight additional munging over what is provided in the ruby-pwsh library, as it does not handle unwrapping Sensitive data types or interpolating Credentials.

Parameters:

  • value (Object) —

    The object to format into valid PowerShell

Returns:

  • (String) —

    A string representation of the input value as valid PowerShell



987
988
989
990
991
992
993
 
# File 'lib/puppet/provider/dsc_base_provider/dsc_base_provider.rb', line 987

def format(value)
  Pwsh::Util.format_powershell_value(value)
rescue RuntimeError => e
  raise unless e.message.include?('Sensitive [value redacted]')

  Pwsh::Util.format_powershell_value(unwrap(value))
end

#format_ciminstance(variable_name, class_name, property_hash) ⇒ String

Write a line of PowerShell which creates a CIM Instance and assigns it to a variable

Parameters:

  • variable_name (String) —

    the name of the Variable to assign the CIM Instance to

  • class_name (String) —

    the CIM Class to instantiate

  • property_hash (Hash) —

    the Properties which define the CIM Instance

Returns:

  • (String) —

    A line of PowerShell which defines the CIM Instance and stores it to a variable



886
887
888
889
890
891
892
893
894
 
# File 'lib/puppet/provider/dsc_base_provider/dsc_base_provider.rb', line 886

def format_ciminstance(variable_name, class_name, property_hash)
  definition = "$#{variable_name} = New-CimInstance -ClientOnly -ClassName '#{class_name}' -Property #{format(property_hash)}"
  # AWFUL HACK to make New-CimInstance happy ; it can't parse an array unless it's an array of Cim Instances
  # definition = definition.gsub("@(@{'cim_instance_type'","[CimInstance[]]@(@{'cim_instance_type'")
  # EVEN WORSE HACK - this one we can't even be sure it's a cim instance...
  # but I don't _think_ anything but nested cim instances show up as hashes inside an array
  definition = definition.gsub('@(@{', '[CimInstance[]]@(@{')
  interpolate_variables(definition)
end

#format_pscredential(variable_name, credential_hash) ⇒ String

Write a line of PowerShell which creates a PSCredential object and assigns it to a variable

Parameters:

  • variable_name (String) —

    the name of the Variable to assign the PSCredential object to

  • credential_hash (Hash) —

    the Properties which define the PSCredential Object

Returns:

  • (String) —

    A line of PowerShell which defines the PSCredential object and stores it to a variable



811
812
813
 
# File 'lib/puppet/provider/dsc_base_provider/dsc_base_provider.rb', line 811

def format_pscredential(variable_name, credential_hash)
  "$#{variable_name} = New-PSCredential -User #{credential_hash['user']} -Password '#{credential_hash['password']}#{SECRET_POSTFIX}'"
end

#get(context, names = nil) ⇒ Hash

Attempts to retrieve an instance of the DSC resource, invoking the ‘Get` method and passing any namevars as the Properties to Invoke-DscResource. The result object, if any, is compared to the specified properties in the Puppet Resource to decide whether it needs to be created, updated, deleted, or whether it is in the desired state.

Parameters:

  • context (Object) —

    the Puppet runtime context to operate in and send feedback to

  • names (Hash) (defaults to: nil) —

    the hash of namevar properties and their values to use to get the resource

Returns:

  • (Hash) —

    returns a hash representing the current state of the object, if it exists



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/puppet/provider/dsc_base_provider/dsc_base_provider.rb', line 128

def get(context, names = nil)
  # Relies on the get_simple_filter feature to pass the namevars
  # as an array containing the namevar parameters as a hash.
  # This hash is functionally the same as a should hash as
  # passed to the invocable_resource method.
  context.debug('Collecting data from the DSC Resource')

  # If the resource has already been queried, do not bother querying for it again
  cached_results = fetch_cached_hashes(@cached_query_results, names)
  return cached_results unless cached_results.empty?

  if @cached_canonicalized_resource.empty?
    mandatory_properties = {}
  else
    canonicalized_resource = @cached_canonicalized_resource[0].dup
    mandatory_properties = canonicalized_resource.select do |attribute, _value|
      (mandatory_get_attributes(context) - namevar_attributes(context)).include?(attribute)
    end
    # If dsc_psdscrunascredential was specified, re-add it here.
    mandatory_properties[:dsc_psdscrunascredential] = canonicalized_resource[:dsc_psdscrunascredential] if canonicalized_resource.key?(:dsc_psdscrunascredential)
  end
  names.collect do |name|
    name = { name: name } if name.is_a? String
    invoke_get_method(context, name.merge(mandatory_properties))
  end
end

#handle_secrets(text, replacement, error_message) ⇒ String

Strings containing sensitive data have a secrets postfix. These strings cannot be passed directly either to debug streams or to PowerShell and must be handled; this method contains the shared logic for parsing text for secrets and substituting values for them.

Parameters:

  • text (String) —

    the text to parse and handle for secrets

  • replacement (String) —

    the value to pass to gsub to replace secrets with

  • error_message (String) —

    the error message to raise instead of leaking secrets

Returns:

  • (String) —

    the modified text



1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
 
# File 'lib/puppet/provider/dsc_base_provider/dsc_base_provider.rb', line 1047

def handle_secrets(text, replacement, error_message)
  # Every secret unwrapped in this module will unwrap as "'secret#{SECRET_POSTFIX}'"
  # Currently, no known resources specify a SecureString instead of a PSCredential object.
  return text unless /#{Regexp.quote(SECRET_POSTFIX)}/.match?(text)

  # In order to reduce time-to-parse, look at each line individually and *only* attempt
  # to substitute if a naive match for the secret postfix is found on the line.
  modified_text = text.split("\n").map do |line|
    if /#{Regexp.quote(SECRET_POSTFIX)}/.match?(line)
      line.gsub(SECRET_DATA_REGEX, replacement)
    else
      line
    end
  end

  modified_text = modified_text.join("\n")

  # Something has gone wrong, error loudly
  raise error_message if /#{Regexp.quote(SECRET_POSTFIX)}/.match?(modified_text)

  modified_text
end

#instantiated_variables ⇒ Hash

Return a Hash containing all of the variables defined for instantiation as well as the Ruby hash for their properties so they can be matched and replaced as needed.

Returns:

  • (Hash) —

    containing all instantiated variables and the properties that they define



576
577
578
 
# File 'lib/puppet/provider/dsc_base_provider/dsc_base_provider.rb', line 576

def instantiated_variables
  @instantiated_variables ||= {}
end

#insync?(context, name, _property_name, _is_hash, should_hash) ⇒ Boolean, Void

Determine if the DSC Resource is in the desired state, invoking the ‘Test` method unless it’s

already been run for the resource, in which case reuse the result instead of checking for each
property. This behavior is only triggered if the validation_mode is set to resource; by default
it is set to property and uses the default property comparison logic in Puppet::Property.

Parameters:

  • context (Object) —

    the Puppet runtime context to operate in and send feedback to

  • name (String) —

    the name of the resource being tested

  • is_hash (Hash) —

    the current state of the resource on the system

  • should_hash (Hash) —

    the desired state of the resource per the manifest

Returns:

  • (Boolean, Void) —

    returns true/false if the resource is/isn’t in the desired state and the validation mode is set to resource, otherwise nil.



355
356
357
358
359
360
 
# File 'lib/puppet/provider/dsc_base_provider/dsc_base_provider.rb', line 355

def insync?(context, name, _property_name, _is_hash, should_hash)
  return nil if should_hash[:validation_mode] != 'resource'

  prior_result = fetch_cached_hashes(@cached_test_results, [name])
  prior_result.empty? ? invoke_test_method(context, name, should_hash) : prior_result.first[:in_desired_state]
end

#interpolate_variables(string) ⇒ String

Look through a fully formatted string, replacing all instances where a value matches the formatted properties of an instantiated variable with references to the variable instead. This allows us to pass complex and nested CIM instances to the Invoke-DscResource parameter hash without constructing them in the hash.

Parameters:

  • string (String) —

    the string of text to search through for places an instantiated variable can be referenced

Returns:

  • (String) —

    the string with references to instantiated variables instead of their properties



753
754
755
756
757
758
759
760
 
# File 'lib/puppet/provider/dsc_base_provider/dsc_base_provider.rb', line 753

def interpolate_variables(string)
  modified_string = string
  # Always replace later-created variables first as they sometimes were built from earlier ones
  instantiated_variables.reverse_each do |variable_name, ruby_definition|
    modified_string = modified_string.gsub(format(ruby_definition), "$#{variable_name}")
  end
  modified_string
end

#invocable_resource(should, context, dsc_invoke_method) ⇒ Hash

Converts a Puppet resource hash into a hash with the information needed to call Invoke-DscResource, including the desired state, the path to the PowerShell module containing the resources, the invoke method, and metadata about the DSC Resource and Puppet Type.

Parameters:

  • should (Hash) —

    A hash representing the desired state of the DSC resource as defined in Puppet

  • context (Object) —

    the Puppet runtime context to operate in and send feedback to

  • dsc_invoke_method (String) —

    the method to pass to Invoke-DscResource: get, set, or test

Returns:

  • (Hash) —

    a hash with the information needed to run ‘Invoke-DscResource`



484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
 
# File 'lib/puppet/provider/dsc_base_provider/dsc_base_provider.rb', line 484

def invocable_resource(should, context, dsc_invoke_method)
  resource = {}
  resource[:parameters] = {}
  %i[name dscmeta_resource_friendly_name dscmeta_resource_name dscmeta_resource_implementation dscmeta_module_name dscmeta_module_version].each do |k|
    resource[k] = context.type.definition[k]
  end
  should.each do |k, v|
    # PSDscRunAsCredential is considered a namevar and will always be passed, even if nil
    # To prevent flapping during runs, remove it from the resource definition unless specified
    next if k == :dsc_psdscrunascredential && v.nil?

    resource[:parameters][k] = {}
    resource[:parameters][k][:value] = v
    %i[mof_type mof_is_embedded].each do |ky|
      resource[:parameters][k][ky] = context.type.definition[:attributes][k][ky]
    end
  end
  resource[:dsc_invoke_method] = dsc_invoke_method

  resource[:vendored_modules_path] = vendored_modules_path(resource[:dscmeta_module_name])

  resource[:attributes] = nil

  context.debug("invocable_resource: #{resource.inspect}")
  resource
end

#invoke_dsc_resource(context, name_hash, props, method) ⇒ Hash

Invokes the given DSC method, passing the name_hash as the properties to use with ‘Invoke-DscResource` The PowerShell script returns a JSON hash with key-value pairs indicating the result of the given command. The hash is left untouched for the most part with any further parsing handled by the methods that call upon it.

Parameters:

  • context (Object) —

    the Puppet runtime context to operate in and send feedback to

  • name_hash (Hash) —

    the hash of namevars to be passed as properties to ‘Invoke-DscResource`

  • props (Hash) —

    the properties to be passed to ‘Invoke-DscResource`

  • method (String) —

    the method to be specified

Returns:

  • (Hash) —

    returns a hash representing the result of the DSC resource call



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/puppet/provider/dsc_base_provider/dsc_base_provider.rb', line 249

def invoke_dsc_resource(context, name_hash, props, method)
  # Do not bother running if the logon credentials won't work
  if !name_hash[:dsc_psdscrunascredential].nil? && logon_failed_already?(name_hash[:dsc_psdscrunascredential])
    context.err('Logon credentials are invalid')
    return nil
  end
  specify_dsc_timeout(name_hash)
  resource = invocable_resource(props, context, method)
  script_content = ps_script_content(resource)
  context.debug("Invoke-DSC Timeout: #{@timeout} milliseconds") if @timeout
  context.debug("Script:\n #{redact_secrets(script_content)}")
  output = ps_manager.execute(remove_secret_identifiers(script_content), @timeout)

  if output[:stdout].nil?
    message = 'Nothing returned.'
    message += " #{output[:errormessage]}" if output[:errormessage]&.match?(/PowerShell module timeout \(\d+ ms\) exceeded while executing/)
    context.err(message)
    return nil
  end

  begin
    data = JSON.parse(output[:stdout])
  rescue StandardError => e
    context.err(e)
    return nil
  end
  context.debug("raw data received: #{data.inspect}")
  collision_error_matcher = /The Invoke-DscResource cmdlet is in progress and must return before Invoke-DscResource can be invoked/

  error = data['errormessage']

  unless error.nil? || error.empty?
    # NB: We should have a way to stop processing this resource *now* without blowing up the whole Puppet run
    # Raising an error stops processing but blows things up while context.err alerts but continues to process
    if error.include?('Logon failure: the user has not been granted the requested logon type at this computer')
      logon_error = "PSDscRunAsCredential account specified (#{name_hash[:dsc_psdscrunascredential]['user']}) does not have appropriate logon rights; are they an administrator?"
      name_hash[:name].nil? ? context.err(logon_error) : context.err(name_hash[:name], logon_error)
      @logon_failures << name_hash[:dsc_psdscrunascredential].dup
      # This is a hack to handle the query cache to prevent a second lookup
      @cached_query_results << name_hash # if fetch_cached_hashes(@cached_query_results, [data]).empty?
    elsif error.match?(collision_error_matcher)
      context.notice('Invoke-DscResource collision detected: Please stagger the timing of your Puppet runs as this can lead to unexpected behaviour.')
      retry_invoke_dsc_resource(context, 5, 60, collision_error_matcher) do
        data = ps_manager.execute(remove_secret_identifiers(script_content))[:stdout]
      end
    else
      context.err(error)
    end
    # Either way, something went wrong and we didn't get back a good result, so return nil
    return nil
  end
  data
end

#invoke_get_method(context, name_hash) ⇒ Hash

Invokes the ‘Get` method, passing the name_hash as the properties to use with `Invoke-DscResource` The PowerShell script returns a JSON representation of the DSC Resource’s CIM Instance munged as best it can be for Ruby. Once that JSON is parsed into a hash this method further munges it to fit the expected property definitions. Finally, it returns the object for the Resource API to compare against and determine what future actions, if any, are needed.

Parameters:

  • context (Object) —

    the Puppet runtime context to operate in and send feedback to

  • name_hash (Hash) —

    the hash of namevars to be passed as properties to ‘Invoke-DscResource`

Returns:

  • (Hash) —

    returns a hash representing the DSC resource munged to the representation the Puppet Type expects



371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
 
# File 'lib/puppet/provider/dsc_base_provider/dsc_base_provider.rb', line 371

def invoke_get_method(context, name_hash) # rubocop:disable Metrics/AbcSize
  context.debug("retrieving #{name_hash.inspect}")

  query_props = name_hash.select { |k, v| mandatory_get_attributes(context).include?(k) || (k == :dsc_psdscrunascredential && !v.nil?) }
  data = invoke_dsc_resource(context, name_hash, query_props, 'get')
  return nil if data.nil?

  # DSC gives back information we don't care about; filter down to only
  # those properties exposed in the type definition.
  valid_attributes = context.type.attributes.keys.collect(&:to_s)
  parameters = parameter_attributes(context).collect(&:to_s)
  data.select! { |key, _value| valid_attributes.include?("dsc_#{key.downcase}") }
  data.reject! { |key, _value| parameters.include?("dsc_#{key.downcase}") }
  # Canonicalize the results to match the type definition representation;
  # failure to do so will prevent the resource_api from comparing the result
  # to the should hash retrieved from the resource definition in the manifest.
  data.keys.each do |key| # rubocop:disable Style/HashEachMethods
    type_key = "dsc_#{key.downcase}".to_sym
    data[type_key] = data.delete(key)

    # Special handling for CIM Instances
    if data[type_key].is_a?(Enumerable)
      downcase_hash_keys!(data[type_key])
      munge_cim_instances!(data[type_key])
    end

    # Convert DateTime back to appropriate type
    if context.type.attributes[type_key][:mof_type] =~ /DateTime/i && !data[type_key].nil?
      data[type_key] = begin
        Puppet::Pops::Time::Timestamp.parse(data[type_key]) if context.type.attributes[type_key][:mof_type] =~ /DateTime/i && !data[type_key].nil?
      rescue ArgumentError, TypeError => e
        # Catch any failures in the parse, output them to the context and then return nil
        context.err("Value returned for DateTime (#{data[type_key].inspect}) failed to parse: #{e}")
        nil
      end
    end
    # PowerShell does not distinguish between a return of empty array/string
    #  and null but Puppet does; revert to those values if specified.
    data[type_key] = [] if data[type_key].nil? && query_props.key?(type_key) && query_props[type_key].is_a?(Array)
  end
  # If a resource is found, it's present, so refill this Puppet-only key
  data[:name] = name_hash[:name]

  data = stringify_nil_attributes(context, data)

  # Have to check for this to avoid a weird canonicalization warning
  # The Resource API calls canonicalize against the current state which
  # will lead to dsc_ensure being set to absent in the name_hash even if
  # it was set to present in the manifest
  name_hash_has_nil_keys = name_hash.count { |_k, v| v.nil? }.positive?
  # We want to throw away all of the empty keys if and only if the manifest
  # declaration is for an absent resource and the resource is actually absent
  data.compact! if data[:dsc_ensure] == 'Absent' && name_hash[:dsc_ensure] == 'Absent' && !name_hash_has_nil_keys

  # Sort the return for order-insensitive nested enumerable comparison:
  data = recursively_sort(data)

  # Cache the query to prevent a second lookup
  @cached_query_results << data.dup if fetch_cached_hashes(@cached_query_results, [data]).empty?
  context.debug("Returned to Puppet as #{data}")
  data
end

#invoke_params(resource) ⇒ String

Munge a resource definition (as from ‘invocable_resource`) into valid PowerShell which represents the `InvokeParams` hash which will be splatted to `Invoke-DscResource`, interpolating all previously defined variables into the hash.

Parameters:

  • resource (Hash) —

    a hash with the information needed to run ‘Invoke-DscResource`

Returns:

  • (String) —

    A string representing the PowerShell definition of the InvokeParams hash



902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
 
# File 'lib/puppet/provider/dsc_base_provider/dsc_base_provider.rb', line 902

def invoke_params(resource)
  params = {
    Name: resource[:dscmeta_resource_friendly_name],
    Method: resource[:dsc_invoke_method],
    Property: {}
  }
  if resource.key?(:dscmeta_module_version)
    params[:ModuleName] = {}
    params[:ModuleName][:ModuleName] = if resource[:dscmeta_resource_implementation] == 'Class'
                                         resource[:dscmeta_module_name]
                                       else
                                         "#{resource[:vendored_modules_path]}/#{resource[:dscmeta_module_name]}/#{resource[:dscmeta_module_name]}.psd1"
                                       end
    params[:ModuleName][:RequiredVersion] = resource[:dscmeta_module_version]
  else
    params[:ModuleName] = resource[:dscmeta_module_name]
  end
  resource[:parameters].each do |property_name, property_hash|
    # strip dsc_ from the beginning of the property name declaration
    name = property_name.to_s.gsub(/^dsc_/, '').to_sym
    params[:Property][name] = case property_hash[:mof_type]
                              when 'PSCredential'
                                # format can't unwrap Sensitive strings nested in arbitrary hashes/etc, so make
                                # the Credential hash interpolable as it will be replaced by a variable reference.
                                {
                                  'user' => property_hash[:value]['user'],
                                  'password' => escape_quotes(property_hash[:value]['password'].unwrap)
                                }
                              when 'DateTime'
                                # These have to be handled specifically because they rely on the *Puppet* DateTime,
                                # not a generic ruby data type (and so can't go in the shared util in ruby-pwsh)
                                "[DateTime]#{property_hash[:value].format('%FT%T%z')}"
                              else
                                property_hash[:value]
                              end
  end
  params_block = interpolate_variables("$InvokeParams = #{format(params)}")
  # Move the Apostrophe for DateTime declarations
  params_block = params_block.gsub("'[DateTime]", "[DateTime]'")
  # HACK: Handle intentionally empty arrays - need to strongly type them because
  # CIM instances do not do a consistent job of casting an empty array properly.
  empty_array_parameters = resource[:parameters].select { |_k, v| v[:value].is_a?(Array) && v[:value].empty? }
  empty_array_parameters.each do |name, properties|
    param_block_name = name.to_s.gsub(/^dsc_/, '')
    params_block = params_block.gsub("#{param_block_name} = @()", "#{param_block_name} = [#{properties[:mof_type]}]@()")
  end
  # HACK: make CIM instances work:
  resource[:parameters].select { |_key, hash| hash[:mof_is_embedded] && hash[:mof_type].include?('[]') }.each do |_property_name, property_hash|
    formatted_property_hash = interpolate_variables(format(property_hash[:value]))
    params_block = params_block.gsub(formatted_property_hash, "[CimInstance[]]#{formatted_property_hash}")
  end
  params_block
end

#invoke_set_method(context, name, should) ⇒ Hash

Invokes the ‘Set` method, passing the should hash as the properties to use with `Invoke-DscResource` The PowerShell script returns a JSON hash with key-value pairs indicating whether or not the resource is in the desired state, whether or not it requires a reboot, and any error messages captured.

Parameters:

  • context (Object) —

    the Puppet runtime context to operate in and send feedback to

  • should (Hash) —

    the desired state represented definition to pass as properties to Invoke-DscResource

Returns:

  • (Hash) —

    returns a hash indicating whether or not the resource is in the desired state, whether or not it requires a reboot, and any error messages captured.



441
442
443
444
445
446
447
448
449
 
# File 'lib/puppet/provider/dsc_base_provider/dsc_base_provider.rb', line 441

def invoke_set_method(context, name, should)
  context.debug("Invoking Set Method for '#{name}' with #{should.inspect}")

  apply_props = should.select { |k, _v| k.to_s =~ /^dsc_/ }
  invoke_dsc_resource(context, should, apply_props, 'set')

  # TODO: Implement this functionality for notifying a DSC reboot?
  # notify_reboot_pending if data['rebootrequired'] == true
end

#invoke_test_method(context, name, should) ⇒ Boolean

Invokes the ‘Test` method, passing the should hash as the properties to use with `Invoke-DscResource`

The PowerShell script returns a JSON hash with key-value pairs indicating whether or not the resource
is in the desired state and any error messages captured.

Parameters:

  • context (Object) —

    the Puppet runtime context to operate in and send feedback to

  • should (Hash) —

    the desired state represented definition to pass as properties to Invoke-DscResource

Returns:

  • (Boolean) —

    returns true if the resource is in the desired state, otherwise false



458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'lib/puppet/provider/dsc_base_provider/dsc_base_provider.rb', line 458

def invoke_test_method(context, name, should)
  context.debug("Relying on DSC Test method for validating if '#{name}' is in the desired state")
  context.debug("Invoking Test Method for '#{name}' with #{should.inspect}")

  test_props = should.select { |k, _v| k.to_s =~ /^dsc_/ }
  data = invoke_dsc_resource(context, name, test_props, 'test')
  # Something went wrong with Invoke-DscResource; fall back on property state comparisons
  return nil if data.nil?

  in_desired_state = data['indesiredstate']
  @cached_test_results << name.merge({ in_desired_state: in_desired_state })

  return in_desired_state if in_desired_state

  change_log = 'DSC reported that this resource is not in the desired state; treating all properties as out-of-sync'
  [in_desired_state, change_log]
end

#load_path ⇒ Array

Return the ruby $LOAD_PATH variable; this method exists to make testing vendored resource path discovery easier.

Returns:

  • (Array) —

    The absolute file paths to available/known ruby code paths



546
547
548
 
# File 'lib/puppet/provider/dsc_base_provider/dsc_base_provider.rb', line 546

def load_path
  $LOAD_PATH
end

#logon_failed_already?(credential_hash) ⇒ Bool

Return true if the specified credential hash has already failed to execute a DSC resource due to a logon error, as when the account is not an administrator on the machine; otherwise returns false.

Parameters:

  • a (Hash) —

    credential hash with a user and password keys where the password is a sensitive string

Returns:

  • (Bool) —

    true if the credential_hash has already failed logon, false otherwise



590
591
592
593
594
 
# File 'lib/puppet/provider/dsc_base_provider/dsc_base_provider.rb', line 590

def logon_failed_already?(credential_hash)
  @logon_failures.any? do |failure_hash|
    failure_hash['user'] == credential_hash['user'] && failure_hash['password'].unwrap == credential_hash['password'].unwrap
  end
end

#mandatory_get_attributes(context) ⇒ Array

Parses the DSC resource type definition to retrieve the names of any attributes which are specified as mandatory for get operations

Parameters:

  • context (Object) —

    the Puppet runtime context to operate in and send feedback to

Returns:

  • (Array) —

    returns an array of attribute names as symbols which are mandatory for get operations



673
674
675
 
# File 'lib/puppet/provider/dsc_base_provider/dsc_base_provider.rb', line 673

def mandatory_get_attributes(context)
  context.type.attributes.select { |_attribute, properties| properties[:mandatory_for_get] }.keys
end

#mandatory_set_attributes(context) ⇒ Array

Parses the DSC resource type definition to retrieve the names of any attributes which are specified as mandatory for set operations

Parameters:

  • context (Object) —

    the Puppet runtime context to operate in and send feedback to

Returns:

  • (Array) —

    returns an array of attribute names as symbols which are mandatory for set operations



681
682
683
 
# File 'lib/puppet/provider/dsc_base_provider/dsc_base_provider.rb', line 681

def mandatory_set_attributes(context)
  context.type.attributes.select { |_attribute, properties| properties[:mandatory_for_set] }.keys
end

#munge_cim_instances!(enumerable) ⇒ Object 



611
612
613
614
615
616
617
618
 
# File 'lib/puppet/provider/dsc_base_provider/dsc_base_provider.rb', line 611

def munge_cim_instances!(enumerable)
  if enumerable.is_a?(Hash)
    # Delete the cim_instance_type key from a top-level CIM Instance **only**
    _ = enumerable.delete('cim_instance_type')
  else
    enumerable.each { |item| munge_cim_instances!(item) if item.is_a?(Enumerable) }
  end
end

#munge_psmodulepath(resource) ⇒ String

Parses a resource definition (as from ‘invocable_resource`) and ensures the System environment variable for PSModulePath is munged to include the vendored PowerShell modules. Due to a bug in PSDesiredStateConfiguration, class-based DSC Resources cannot be called via Invoke-DscResource by path, only by module name, and the module must be discoverable in the system-level PSModulePath. The postscript for invocation has logic to reset the system PSModulePath as stored in the script lines returned by this method.

Parameters:

  • resource (Hash) —

    a hash with the information needed to run ‘Invoke-DscResource`

Returns:

  • (String) —

    A multi-line string which sets the PSModulePath at the system level



771
772
773
774
775
776
777
778
779
 
# File 'lib/puppet/provider/dsc_base_provider/dsc_base_provider.rb', line 771

def munge_psmodulepath(resource)
  vendor_path = resource[:vendored_modules_path]&.tr('/', '\\')
  <<~MUNGE_PSMODULEPATH.strip
    $UnmungedPSModulePath = [System.Environment]::GetEnvironmentVariable('PSModulePath','machine')
    $MungedPSModulePath = $env:PSModulePath + ';#{vendor_path}'
    [System.Environment]::SetEnvironmentVariable('PSModulePath', $MungedPSModulePath, [System.EnvironmentVariableTarget]::Machine)
    $env:PSModulePath = [System.Environment]::GetEnvironmentVariable('PSModulePath','machine')
  MUNGE_PSMODULEPATH
end

#namevar_attributes(context) ⇒ Array

Parses the DSC resource type definition to retrieve the names of any attributes which are specified as namevars

Parameters:

  • context (Object) —

    the Puppet runtime context to operate in and send feedback to

Returns:

  • (Array) —

    returns an array of attribute names as symbols which are namevars



703
704
705
 
# File 'lib/puppet/provider/dsc_base_provider/dsc_base_provider.rb', line 703

def namevar_attributes(context)
  context.type.attributes.select { |_attribute, properties| properties[:behaviour] == :namevar }.keys
end

#nested_cim_instances(enumerable) ⇒ Hash

Recursively search for and return CIM instances nested in an enumerable

Parameters:

  • enumerable (Enumerable) —

    a hash or array which may contain CIM Instances

Returns:

  • (Hash) —

    every discovered hash which does define a CIM Instance



866
867
868
869
870
871
872
873
874
875
876
877
878
 
# File 'lib/puppet/provider/dsc_base_provider/dsc_base_provider.rb', line 866

def nested_cim_instances(enumerable)
  enumerable.collect do |key, value|
    if key.is_a?(Hash) && key.key?('cim_instance_type')
      key
      # TODO: Are there any cim instancees 3 levels deep, or only 2?
      # if so, we should *also* keep searching and processing...
    elsif key.is_a?(Enumerable)
      nested_cim_instances(key)
    elsif value.is_a?(Enumerable)
      nested_cim_instances(value)
    end
  end
end

#parameter_attributes(context) ⇒ Array

Parses the DSC resource type definition to retrieve the names of any attributes which are specified as parameters

Parameters:

  • context (Object) —

    the Puppet runtime context to operate in and send feedback to

Returns:

  • (Array) —

    returns an array of attribute names as symbols which are parameters



711
712
713
 
# File 'lib/puppet/provider/dsc_base_provider/dsc_base_provider.rb', line 711

def parameter_attributes(context)
  context.type.attributes.select { |_name, properties| properties[:behaviour] == :parameter }.keys
end

#prepare_cim_instances(resource) ⇒ String

Parses a resource definition (as from ‘invocable_resource`) for any properties which are CIM instances whether at the top level or nested inside of other CIM instances, and, where they are discovered, adds those objects to the instantiated_variables hash as well as returning a line of PowerShell code which will create the CIM object and store it in a variable. This then allows the CIM instances to be assigned by variable reference.

Parameters:

  • resource (Hash) —

    a hash with the information needed to run ‘Invoke-DscResource`

Returns:

  • (String) —

    An array of lines of PowerShell to instantiate CIM Instances and store them in variables



823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
 
# File 'lib/puppet/provider/dsc_base_provider/dsc_base_provider.rb', line 823

def prepare_cim_instances(resource)
  cim_instances_block = []
  resource[:parameters].each do |_property_name, property_hash|
    next unless property_hash[:mof_is_embedded]
    next if property_hash[:mof_type] == 'PSCredential' # Credentials are handled separately

    # strip dsc_ from the beginning of the property name declaration
    # name = property_name.to_s.gsub(/^dsc_/, '').to_sym
    # Process nested CIM instances first as those neeed to be passed to higher-order
    # instances and must therefore be declared before they must be referenced
    cim_instance_hashes = nested_cim_instances(property_hash[:value]).flatten.compact
    # Sometimes the instances are an empty array
    unless cim_instance_hashes.count.zero?
      cim_instance_hashes.each do |instance|
        variable_name = random_variable_name
        class_name = instance['cim_instance_type']
        properties = instance.reject { |k, _v| k == 'cim_instance_type' }
        cim_instances_block << format_ciminstance(variable_name, class_name, properties)
        instantiated_variables.merge!(variable_name => instance)
      end
    end
    # We have to handle arrays of CIM instances slightly differently
    if /\[\]$/.match?(property_hash[:mof_type])
      class_name = property_hash[:mof_type].gsub('[]', '')
      property_hash[:value].each do |hash|
        variable_name = random_variable_name
        cim_instances_block << format_ciminstance(variable_name, class_name, hash)
        instantiated_variables.merge!(variable_name => hash)
      end
    else
      variable_name = random_variable_name
      class_name = property_hash[:mof_type]
      cim_instances_block << format_ciminstance(variable_name, class_name, property_hash[:value])
      instantiated_variables.merge!(variable_name => property_hash[:value])
    end
  end
  cim_instances_block == [] ? '' : cim_instances_block.join("\n")
end

#prepare_credentials(resource) ⇒ String

Parses a resource definition (as from ‘invocable_resource`) for any properties which are PowerShell Credentials. As these values need to be serialized into PSCredential objects, return an array of PowerShell lines, each of which instantiates a variable which holds the value as a PSCredential. These credential variables can then be simply assigned in the parameter hash where needed.

Parameters:

  • resource (Hash) —

    a hash with the information needed to run ‘Invoke-DscResource`

Returns:

  • (String) —

    An array of lines of PowerShell to instantiate PSCredentialObjects and store them in variables



788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
 
# File 'lib/puppet/provider/dsc_base_provider/dsc_base_provider.rb', line 788

def prepare_credentials(resource)
  credentials_block = []
  resource[:parameters].each do |_property_name, property_hash|
    next unless property_hash[:mof_type] == 'PSCredential'
    next if property_hash[:value].nil?

    variable_name = random_variable_name
    credential_hash = {
      'user' => property_hash[:value]['user'],
      'password' => escape_quotes(property_hash[:value]['password'].unwrap)
    }
    credentials_block << format_pscredential(variable_name, credential_hash)
    instantiated_variables.merge!(variable_name => credential_hash)
  end
  credentials_block.join("\n")
  credentials_block == [] ? '' : credentials_block
end

#ps_manager ⇒ Object

Instantiate a PowerShell manager via the ruby-pwsh library and use it to invoke PowerShell. Definiing it here allows re-use of a single instance instead of continually instantiating and tearing a new instance down for every call.



1093
1094
1095
1096
1097
1098
1099
1100
1101
 
# File 'lib/puppet/provider/dsc_base_provider/dsc_base_provider.rb', line 1093

def ps_manager
  debug_output = Puppet::Util::Log.level == :debug
  # TODO: Allow you to specify an alternate path, either to pwsh generally or a specific pwsh path.
  if Pwsh::Util.on_windows?
    Pwsh::Manager.instance(Pwsh::Manager.powershell_path, Pwsh::Manager.powershell_args, debug: debug_output)
  else
    Pwsh::Manager.instance(Pwsh::Manager.pwsh_path, Pwsh::Manager.pwsh_args, debug: debug_output)
  end
end

#ps_script_content(resource) ⇒ String

Given a resource definition (as from ‘invocable_resource`), return a PowerShell script which has all of the appropriate function and variable definitions, which will call Invoke-DscResource, and will correct munge the results for returning to Puppet as a JSON object.

Parameters:

  • resource (Hash) —

    a hash with the information needed to run ‘Invoke-DscResource`

Returns:

  • (String) —

    A string representing the PowerShell script which will invoke the DSC Resource.



962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
 
# File 'lib/puppet/provider/dsc_base_provider/dsc_base_provider.rb', line 962

def ps_script_content(resource)
  template_path = File.expand_path(__dir__)
  # Defines the helper functions
  functions     = File.new("#{template_path}/invoke_dsc_resource_functions.ps1").read
  # Defines the response hash and the runtime settings
  preamble      = File.new("#{template_path}/invoke_dsc_resource_preamble.ps1").read
  # The postscript defines the invocation error and result handling; expects `$InvokeParams` to be defined
  postscript    = File.new("#{template_path}/invoke_dsc_resource_postscript.ps1").read
  # The blocks define the variables to define for the postscript.
  module_path_block = munge_psmodulepath(resource)
  credential_block = prepare_credentials(resource)
  cim_instances_block = prepare_cim_instances(resource)
  parameters_block = invoke_params(resource)
  # clean them out of the temporary cache now that they're not needed; failure to do so can goof up future executions in this run
  clear_instantiated_variables!

  [functions, preamble, module_path_block, credential_block, cim_instances_block, parameters_block, postscript].join("\n")
end

#puppetize_name(name) ⇒ String

Return a String containing a puppetized name. A puppetized name is a string that only includes lowercase letters, digits, underscores and cannot start with a digit.

Returns:

  • (String) —

    with a puppetized module name



554
555
556
557
558
559
560
561
 
# File 'lib/puppet/provider/dsc_base_provider/dsc_base_provider.rb', line 554

def puppetize_name(name)
  # Puppet module names must be lower case
  name = name.downcase
  # Puppet module names must only include lowercase letters, digits and underscores
  name = name.gsub(/[^a-z0-9_]/, '_')
  # Puppet module names must not start with a number so if it does, append the letter 'a' to the name. Eg: '7zip' becomes 'a7zip'
  name = name.match?(/^\d/) ? "a#{name}" : name # rubocop:disable Lint/UselessAssignment
end

#random_variable_name ⇒ String

Return a UUID with the dashes turned into underscores to enable the specifying of guaranteed-unique variables in the PowerShell script.

Returns:

  • (String) —

    a uuid with underscores instead of dashes.



567
568
569
570
 
# File 'lib/puppet/provider/dsc_base_provider/dsc_base_provider.rb', line 567

def random_variable_name
  # PowerShell variables can't include dashes
  SecureRandom.uuid.tr('-', '_')
end

#recursively_downcase(object) ⇒ Object

Recursively transforms any object, downcasing it to enable case insensitive comparisons

Parameters:

  • object (Object) —

    a string, array, hash, or other object to attempt to recursively downcase

Returns:

  • (Object) —

    returns the input object recursively downcased



624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
 
# File 'lib/puppet/provider/dsc_base_provider/dsc_base_provider.rb', line 624

def recursively_downcase(object)
  case object
  when String
    object.downcase
  when Array
    object.map { |item| recursively_downcase(item) }
  when Hash
    transformed = {}
    object.transform_keys(&:downcase).each do |key, value|
      transformed[key] = recursively_downcase(value)
    end
    transformed
  else
    object
  end
end

#recursively_sort(object) ⇒ Object

Recursively sorts any object to enable order-insensitive comparisons

Parameters:

  • object (Object) —

    an array, hash, or other object to attempt to recursively downcase

Returns:

  • (Object) —

    returns the input object recursively downcased



645
646
647
648
649
650
651
652
653
654
655
656
657
658
 
# File 'lib/puppet/provider/dsc_base_provider/dsc_base_provider.rb', line 645

def recursively_sort(object)
  case object
  when Array
    object.map { |item| recursively_sort(item) }.sort_by(&:to_s)
  when Hash
    transformed = {}
    object.sort.to_h.each do |key, value|
      transformed[key] = recursively_sort(value)
    end
    transformed
  else
    object
  end
end

#redact_secrets(text) ⇒ String

While Puppet is aware of Sensitive data types, the PowerShell script is not and so for debugging purposes must be redacted before being sent to debug output but must not be redacted when sent to the PowerShell code manager.

Parameters:

  • text (String) —

    the text to redact

Returns:

  • (String) —

    the redacted text



1076
1077
1078
 
# File 'lib/puppet/provider/dsc_base_provider/dsc_base_provider.rb', line 1076

def redact_secrets(text)
  handle_secrets(text, "'#<Sensitive [value redacted]>'", "Unredacted sensitive data would've been leaked")
end

#remove_secret_identifiers(text) ⇒ String

While Puppet is aware of Sensitive data types, the PowerShell script is not and so the helper-id for sensitive data must be removed before sending to the PowerShell code manager.

Parameters:

  • text (String) —

    the text to strip of secret data identifiers

Returns:

  • (String) —

    the modified text to pass to the PowerShell code manager



1086
1087
1088
 
# File 'lib/puppet/provider/dsc_base_provider/dsc_base_provider.rb', line 1086

def remove_secret_identifiers(text)
  handle_secrets(text, "'\\k<secret>'", 'Unable to properly format text for PowerShell with sensitive data')
end

#retry_invoke_dsc_resource(context, max_retry_count, retry_wait_interval_secs, error_matcher) ⇒ Object

Retries Invoke-DscResource when returned error matches error regex supplied as param.

Parameters:

  • context (Object) —

    the Puppet runtime context to operate in and send feedback to

  • max_retry_count (Int) —

    max number of times to retry Invoke-DscResource

  • retry_wait_interval_secs (Int) —

    Time delay between retries

  • error_matcher (String) —

    the regex pattern to match with error



320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/puppet/provider/dsc_base_provider/dsc_base_provider.rb', line 320

def retry_invoke_dsc_resource(context, max_retry_count, retry_wait_interval_secs, error_matcher)
  try = 0
  while try < max_retry_count
    try += 1
    # notify and wait for retry interval
    context.notice("Sleeping for #{retry_wait_interval_secs} seconds.")
    sleep retry_wait_interval_secs
    # notify and retry
    context.notice("Retrying: attempt #{try} of #{max_retry_count}.")
    data = JSON.parse(yield)
    # if no error, assume successful invocation and break
    break if data['errormessage'].nil?

    # notify of failed retry
    context.notice("Attempt #{try} of #{max_retry_count} failed.")
    # return if error does not match expceted error, or all retries exhausted
    return context.err(data['errormessage']) unless data['errormessage'].match?(error_matcher) && try < max_retry_count

    # else, retry
    next
  end
  data
end

#same?(value1, value2) ⇒ bool

Check equality, sort if necessary

Parameters:

  • value1 (object) —

    a string, array, hash, or other object to sort and compare to value2

  • value2 (object) —

    a string, array, hash, or other object to sort and compare to value1

Returns:

  • (bool) —

    returns equality



665
666
667
 
# File 'lib/puppet/provider/dsc_base_provider/dsc_base_provider.rb', line 665

def same?(value1, value2)
  recursively_sort(value2) == recursively_sort(value1)
end

#set(context, changes) ⇒ Object

Determines whether a resource is ensurable and which message to write (create, update, or delete), then passes the appropriate values along to the various sub-methods which themselves call the Set method of Invoke-DscResource. Implementation borrowed directly from the Resource API Simple Provider

Parameters:

  • context (Object) —

    the Puppet runtime context to operate in and send feedback to

  • changes (Hash) —

    the hash of whose key is the name_hash and value is the is and should hashes



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/puppet/provider/dsc_base_provider/dsc_base_provider.rb', line 161

def set(context, changes)
  changes.each do |name, change|
    is = change[:is]
    should = change[:should]

    # If should is an array instead of a hash and only has one entry, use that.
    should = should.first if should.is_a?(Array) && should.length == 1

    # for compatibility sake, we use dsc_ensure instead of ensure, so context.type.ensurable? does not work
    if context.type.attributes.key?(:dsc_ensure)
      # HACK: If the DSC Resource is ensurable but doesn't report a default value
      # for ensure, we assume it to be `Present` - this is the most common pattern.
      should_ensure = should[:dsc_ensure].nil? ? 'Present' : should[:dsc_ensure].to_s
      # HACK: Sometimes dsc_ensure is removed???? If it's gone, pretend it's absent??
      is_ensure = is[:dsc_ensure].nil? ? 'Absent' : is[:dsc_ensure].to_s

      if is_ensure == 'Absent' && should_ensure == 'Present'
        context.creating(name) do
          create(context, name, should)
        end
      elsif is_ensure == 'Present' && should_ensure == 'Present'
        context.updating(name) do
          update(context, name, should)
        end
      elsif is_ensure == 'Present' && should_ensure == 'Absent'
        context.deleting(name) do
          delete(context, name)
        end
      else
        # In this case we are not sure if the resource is being created/updated/removed
        # as with ensure "latest" or a specific version number, so default to update.
        context.updating(name) do
          update(context, name, should)
        end
      end
    else
      context.updating(name) do
        update(context, name, should)
      end
    end
  end
end

#specify_dsc_timeout(name_hash) ⇒ Object

Sets the @timeout instance variable. The @timeout variable is set to the value of name_hash in milliseconds If name_hash is nil, @timeout is not changed. If @timeout is already set to a value other than nil, it is changed only if it’s different from name_hash..

Parameters:

  • name_hash (Hash) —

    the hash of namevars to be passed as properties to ‘Invoke-DscResource`



309
310
311
312
313
 
# File 'lib/puppet/provider/dsc_base_provider/dsc_base_provider.rb', line 309

def specify_dsc_timeout(name_hash)
  return unless name_hash[:dsc_timeout] && (@timeout.nil? || @timeout != name_hash[:dsc_timeout])

  @timeout = name_hash[:dsc_timeout] * 1000
end

#stringify_nil_attributes(context, data) ⇒ Hash

Parses the DSC resource type definition to retrieve the names of any attributes which are specified as required strings This is used to ensure that any nil values are converted to empty strings to match puppets expeceted value

Parameters:

  • context (Object) —

    the Puppet runtime context to operate in and send feedback to

  • data (Hash) —

    the hash of properties returned from the DSC resource

Returns:

  • (Hash) —

    returns a data hash with any nil values converted to empty strings



690
691
692
693
694
695
696
697
 
# File 'lib/puppet/provider/dsc_base_provider/dsc_base_provider.rb', line 690

def stringify_nil_attributes(context, data)
  nil_attributes = data.select { |_name, value| value.nil? }.keys
  nil_attributes.each do |nil_attr|
    attribute_type = context.type.attributes[nil_attr][:type]
    data[nil_attr] = '' if (attribute_type.start_with?('Optional[Enum[', 'Enum[') && enum_values(context, nil_attr).include?('')) || attribute_type == 'String'
  end
  data
end

#unwrap(value) ⇒ Object

Unwrap sensitive strings for formatting, even inside an enumerable, appending the the secret postfix to the end of the string in preparation for gsub cleanup.

Parameters:

  • value (Object) —

    The object to unwrap sensitive data inside of

Returns:

  • (Object) —

    The object with any sensitive strings unwrapped and annotated



1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
 
# File 'lib/puppet/provider/dsc_base_provider/dsc_base_provider.rb', line 1000

def unwrap(value)
  case value
  when Puppet::Pops::Types::PSensitiveType::Sensitive
    "#{value.unwrap}#{SECRET_POSTFIX}"
  when Hash
    unwrapped = {}
    value.each do |k, v|
      unwrapped[k] = unwrap(v)
    end
    unwrapped
  when Array
    unwrapped = []
    value.each do |v|
      unwrapped << unwrap(v)
    end
    unwrapped
  else
    value
  end
end

#update(context, name, should) ⇒ Hash

Attempts to set an instance of the DSC resource, invoking the ‘Set` method and thinly wrapping the `invoke_set_method` method; whether this method, `create`, or `delete` is called is entirely up to the Resource API based on the results

Parameters:

  • context (Object) —

    the Puppet runtime context to operate in and send feedback to

  • name (String) —

    the name of the resource being created

Returns:

  • (Hash) —

    returns a hash indicating whether or not the resource is in the desired state, whether or not it requires a reboot, and any error messages captured.



223
224
225
226
 
# File 'lib/puppet/provider/dsc_base_provider/dsc_base_provider.rb', line 223

def update(context, name, should)
  context.debug("Updating '#{name}' with #{should.inspect}")
  invoke_set_method(context, name, should)
end

#vendored_modules_path(module_name) ⇒ Object 



511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
 
# File 'lib/puppet/provider/dsc_base_provider/dsc_base_provider.rb', line 511

def vendored_modules_path(module_name)
  # Because Puppet adds all of the modules to the LOAD_PATH we can be sure that the appropriate module lives here during an apply;
  # PROBLEM: This currently uses the downcased name, we need to capture the module name in the metadata I think.
  # During a Puppet agent run, the code lives in the cache so we can use the file expansion to discover the correct folder.
  # This handles setting the vendored_modules_path to include the puppet module name; we now add the puppet module name into the
  # path to allow multiple modules to with shared dsc_resources to be installed side by side
  # The old vendored_modules_path: puppet_x/dsc_resources
  # The new vendored_modules_path: puppet_x/<module_name>/dsc_resources
  root_module_path = load_path.grep(%r{#{puppetize_name(module_name)}/lib}).first
  vendored_path = if root_module_path.nil?
                    File.expand_path(Pathname.new(__FILE__).dirname + '../../../' + "puppet_x/#{puppetize_name(module_name)}/dsc_resources") # rubocop:disable Style/StringConcatenation
                  else
                    File.expand_path("#{root_module_path}/puppet_x/#{puppetize_name(module_name)}/dsc_resources")
                  end

  # Check for the old vendored_modules_path second - if there is a mix of modules with the old and new pathing,
  # checking for this first will always work and so the more specific search will never run.
  unless File.exist? vendored_path
    vendored_path = if root_module_path.nil?
                      File.expand_path(Pathname.new(__FILE__).dirname + '../../../' + 'puppet_x/dsc_resources') # rubocop:disable Style/StringConcatenation
                    else
                      File.expand_path("#{root_module_path}/puppet_x/dsc_resources")
                    end
  end

  # A warning is thrown if the something went wrong and the file was not created
  raise "Unable to find expected vendored DSC Resource #{vendored_path}" unless File.exist? vendored_path

  vendored_path
end