Class: Inspec::Resources::RegistryKey

Inherits:
Object
  • Object
show all
Defined in:
lib/inspec/resources/registry_key.rb

Direct Known Subclasses

WindowsRegistryKey

Instance Method Summary collapse

Constructor Details

#initialize(name, reg_key = nil) ⇒ RegistryKey

Returns a new instance of RegistryKey.



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/inspec/resources/registry_key.rb', line 59

def initialize(name, reg_key = nil)
  # if we have one parameter, we use it as name
  reg_key ||= name
  @options = {}
  if reg_key && reg_key.is_a?(Hash)
    @options = @options.merge!(reg_key)

    # generate registry_key if we do not have a regular expression
    @options[:path] = generate_registry_key_path_from_options
    @options[:name] ||= @options[:path]
  else
    @options[:name] = name
    @options[:path] = reg_key
  end

  return skip_resource "The `registry_key` resource is not supported on your OS yet." unless inspec.os.windows?
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(*keys) ⇒ Object

returns nil, if not existent or value



124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/inspec/resources/registry_key.rb', line 124

def method_missing(*keys)
  # allow the use of array syntax in an `its` block so that users
  # can use it to query for keys with . characters in them
  if keys.is_a?(Array)
    keys.shift if keys[0] == :[]
    key = keys.first
  else
    key = keys
  end

  # get data
  val = registry_key(@options[:path])
  registry_property_value(val, key)
end

Instance Method Details

#children(filter = nil) ⇒ Object

returns an arrray of child nodes



104
105
106
 
# File 'lib/inspec/resources/registry_key.rb', line 104

def children(filter = nil)
  children_keys(@options[:path], filter)
end

#exists? ⇒ Boolean

Returns:

  • (Boolean) 


77
78
79
 
# File 'lib/inspec/resources/registry_key.rb', line 77

def exists?
  !registry_key(@options[:path]).nil?
end

#has_property?(property_name, property_type = nil) ⇒ Boolean

Returns:

  • (Boolean) 


86
87
88
89
 
# File 'lib/inspec/resources/registry_key.rb', line 86

def has_property?(property_name, property_type = nil)
  val = registry_key(@options[:path])
  !val.nil? && registry_property_exists(val, property_name) && (property_type.nil? || registry_property_type(val, property_name) == map2type(property_type)) ? true : false
end

#has_property_value?(property_name, property_type = nil, value) ⇒ Boolean

deactivate rubocop, because we need to stay compatible with Serverspe rubocop:disable Style/OptionalArguments

Returns:

  • (Boolean) 


93
94
95
96
97
98
99
100
101
 
# File 'lib/inspec/resources/registry_key.rb', line 93

def has_property_value?(property_name, property_type = nil, value)
  # rubocop:enable Style/OptionalArguments
  val = registry_key(@options[:path])

  # convert value to binary if required
  value = value.bytes if !property_type.nil? && map2type(property_type) == 3 && !value.is_a?(Array)

  !val.nil? && registry_property_value(val, property_name) == value && (property_type.nil? || registry_property_type(val, property_name) == map2type(property_type)) ? true : false
end

#has_value?(value) ⇒ Boolean

Returns:

  • (Boolean) 


81
82
83
84
 
# File 'lib/inspec/resources/registry_key.rb', line 81

def has_value?(value)
  val = registry_key(@options[:path])
  !val.nil? && registry_property_value(val, "(default)") == value ? true : false
end

#inherited? ⇒ Boolean

returns true if inheritance is enabled for registry key.

Returns:

  • (Boolean) 


116
117
118
119
120
121
 
# File 'lib/inspec/resources/registry_key.rb', line 116

def inherited?
  return false unless exists?

  cmd = inspec.command("(Get-Acl -Path 'Registry::#{@options[:path]}').access| Where-Object {$_.IsInherited -eq $true} | measure | % { $_.Count }")
  cmd.stdout.chomp == "0" ? false : true
end

#resource_id ⇒ Object 



143
144
145
 
# File 'lib/inspec/resources/registry_key.rb', line 143

def resource_id
  @options[:path]
end

#to_s ⇒ Object 



139
140
141
 
# File 'lib/inspec/resources/registry_key.rb', line 139

def to_s
  "Registry Key #{@options[:name]}"
end

#user_permissions ⇒ Object

returns hash containing users / groups and their permission



109
110
111
112
113
 
# File 'lib/inspec/resources/registry_key.rb', line 109

def user_permissions
  return {} unless exists?

  get_permissions(@options[:path])
end