Class: Rex::Post::Meterpreter::Extensions::Stdapi::Sys::RegistrySubsystem::RegistryKey

Inherits:
Object
  • Object
show all
Defined in:
lib/rex/post/meterpreter/extensions/stdapi/sys/registry_subsystem/registry_key.rb

Overview

Class wrapper around a logical registry key on the remote side

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client, root_key, base_key, perm, hkey) ⇒ RegistryKey

Initializes an instance of a registry key using the supplied properties and HKEY handle from the server.



26
27
28
29
30
31
32
33
34
 
# File 'lib/rex/post/meterpreter/extensions/stdapi/sys/registry_subsystem/registry_key.rb', line 26

def initialize(client, root_key, base_key, perm, hkey)
  self.client   = client
  self.root_key = root_key
  self.base_key = base_key
  self.perm     = perm
  self.hkey     = hkey

  ObjectSpace.define_finalizer( self, self.class.finalize(self.client, self.hkey) )
end

Instance Attribute Details

#base_key ⇒ Object

The base key name, such as SoftwareFoo.



180
181
182
 
# File 'lib/rex/post/meterpreter/extensions/stdapi/sys/registry_subsystem/registry_key.rb', line 180

def base_key
  @base_key
end

#hkey ⇒ Object

The open handle to the key on the server.



172
173
174
 
# File 'lib/rex/post/meterpreter/extensions/stdapi/sys/registry_subsystem/registry_key.rb', line 172

def hkey
  @hkey
end

#perm ⇒ Object

The permissions that the key was opened with.



184
185
186
 
# File 'lib/rex/post/meterpreter/extensions/stdapi/sys/registry_subsystem/registry_key.rb', line 184

def perm
  @perm
end

#root_key ⇒ Object

The root key name, such as HKEY_LOCAL_MACHINE.



176
177
178
 
# File 'lib/rex/post/meterpreter/extensions/stdapi/sys/registry_subsystem/registry_key.rb', line 176

def root_key
  @root_key
end

Class Method Details

.close(client, hkey) ⇒ Object

Closes the open key. This must be called if the registry key was opened.



108
109
110
111
112
113
114
 
# File 'lib/rex/post/meterpreter/extensions/stdapi/sys/registry_subsystem/registry_key.rb', line 108

def self.close(client, hkey)
  if hkey != nil
    return client.sys.registry.close_key(hkey)
  end

  return false
end

.finalize(client, hkey) ⇒ Object 



36
37
38
 
# File 'lib/rex/post/meterpreter/extensions/stdapi/sys/registry_subsystem/registry_key.rb', line 36

def self.finalize(client,hkey)
  proc { self.close(client,hkey) }
end

Instance Method Details

#close ⇒ Object

Instance method for the same



117
118
119
 
# File 'lib/rex/post/meterpreter/extensions/stdapi/sys/registry_subsystem/registry_key.rb', line 117

def close()
  self.class.close(self.client, self.hkey)
end

#create_key(base_key, perm = KEY_READ) ⇒ Object

Creates a registry key that is relative to this registry key.



93
94
95
 
# File 'lib/rex/post/meterpreter/extensions/stdapi/sys/registry_subsystem/registry_key.rb', line 93

def create_key(base_key, perm = KEY_READ)
  return self.client.sys.registry.create_key(self.hkey, base_key, perm)
end

#delete_key(base_key, recursive = true) ⇒ Object

Deletes a registry key that is relative to this registry key.



100
101
102
 
# File 'lib/rex/post/meterpreter/extensions/stdapi/sys/registry_subsystem/registry_key.rb', line 100

def delete_key(base_key, recursive = true)
  return self.client.sys.registry.delete_key(self.hkey, base_key, recursive)
end

#delete_value(name) ⇒ Object

Delete the supplied registry value.



152
153
154
 
# File 'lib/rex/post/meterpreter/extensions/stdapi/sys/registry_subsystem/registry_key.rb', line 152

def delete_value(name)
  return self.client.sys.registry.delete_value(self.hkey, name)
end

#each_key(&block) ⇒ Object

Enumerates all of the child keys within this registry key.



49
50
51
 
# File 'lib/rex/post/meterpreter/extensions/stdapi/sys/registry_subsystem/registry_key.rb', line 49

def each_key(&block)
  return enum_key.each(&block)
end

#each_value(&block) ⇒ Object

Enumerates all of the child values within this registry key.



56
57
58
 
# File 'lib/rex/post/meterpreter/extensions/stdapi/sys/registry_subsystem/registry_key.rb', line 56

def each_value(&block)
  return enum_value.each(&block)
end

#enum_key ⇒ Object

Retrieves all of the registry keys that are direct descendents of the class’ registry key.



64
65
66
 
# File 'lib/rex/post/meterpreter/extensions/stdapi/sys/registry_subsystem/registry_key.rb', line 64

def enum_key()
  return self.client.sys.registry.enum_key(self.hkey)
end

#enum_value ⇒ Object

Retrieves all of the registry values that exist within the opened registry key.



72
73
74
 
# File 'lib/rex/post/meterpreter/extensions/stdapi/sys/registry_subsystem/registry_key.rb', line 72

def enum_value()
  return self.client.sys.registry.enum_value(self.hkey)
end

#open_key(base_key, perm = KEY_READ) ⇒ Object

Opens a registry key that is relative to this registry key.



86
87
88
 
# File 'lib/rex/post/meterpreter/extensions/stdapi/sys/registry_subsystem/registry_key.rb', line 86

def open_key(base_key, perm = KEY_READ)
  return self.client.sys.registry.open_key(self.hkey, base_key, perm)
end

#query_class ⇒ Object

Queries the class of the specified key



145
146
147
 
# File 'lib/rex/post/meterpreter/extensions/stdapi/sys/registry_subsystem/registry_key.rb', line 145

def query_class
  return self.client.sys.registry.query_class(self.hkey)
end

#query_value(name) ⇒ Object

Queries the attributes of the supplied registry value relative to the opened registry key.



138
139
140
 
# File 'lib/rex/post/meterpreter/extensions/stdapi/sys/registry_subsystem/registry_key.rb', line 138

def query_value(name)
  return self.client.sys.registry.query_value(self.hkey, name)
end

#set_value(name, type, data) ⇒ Object

Sets a value relative to the opened registry key.



130
131
132
 
# File 'lib/rex/post/meterpreter/extensions/stdapi/sys/registry_subsystem/registry_key.rb', line 130

def set_value(name, type, data)
  return self.client.sys.registry.set_value(self.hkey, name, type, data)
end

#to_s ⇒ Object

Returns the path to the key.



165
166
167
 
# File 'lib/rex/post/meterpreter/extensions/stdapi/sys/registry_subsystem/registry_key.rb', line 165

def to_s
  return self.root_key.to_s + "\\" + self.base_key
end