The Volatility Framework
volatility.plugins.overlays.basic.String Class Reference

Class for dealing with Strings. More...

Inheritance diagram for volatility.plugins.overlays.basic.String:
volatility.obj.BaseObject

Public Member Functions

def __init__ (self, theType, offset, vm=None, encoding='ascii', length=1, parent=None, profile=None, kwargs)
 
def proxied (self, name)
 Return an object to be proxied.
 
def v (self)
 Use zread to help emulate reading null-terminated C strings across page boundaries. More...
 
def __len__ (self)
 This returns the length of the string.
 
def __str__ (self)
 This function ensures that we always return a string from the str method. More...
 
def __unicode__ (self)
 This function returns the unicode encoding of the data retrieved by .v() Any unusual characters in the input are replaced with .
 
def __format__ (self, formatspec)
 
def __cmp__ (self, other)
 
def __add__ (self, other)
 Set up mappings for concat.
 
def __radd__ (self, other)
 Set up mappings for reverse concat.
 
- Public Member Functions inherited from volatility.obj.BaseObject
def __init__ (self, theType, offset, vm, native_vm=None, parent=None, name=None, kwargs)
 
def obj_type (self)
 
def obj_vm (self)
 
def obj_offset (self)
 
def obj_parent (self)
 
def obj_name (self)
 
def obj_native_vm (self)
 
def set_native_vm (self, native_vm)
 Sets the native_vm.
 
def rebase (self, offset)
 
def proxied (self, attr)
 
def newattr (self, attr, value)
 Sets a new attribute after the object has been created.
 
def write (self, value)
 Function for writing the object back to disk.
 
def __getattr__ (self, attr)
 This is only useful for proper methods (not ones that start with __ )
 
def __setattr__ (self, attr, value)
 
def __nonzero__ (self)
 This method is called when we test the truth value of an Object. More...
 
def __eq__ (self, other)
 
def __ne__ (self, other)
 
def __hash__ (self)
 
def m (self, memname)
 
def is_valid (self)
 
def dereference (self)
 
def dereference_as (self, derefType, kwargs)
 
def cast (self, castString)
 
def v (self)
 Do the actual reading and decoding of this member.
 
def __format__ (self, formatspec)
 
def __str__ (self)
 
def __repr__ (self)
 
def d (self)
 Display diagnostic information.
 
def __getstate__ (self)
 This controls how we pickle and unpickle the objects.
 
def __setstate__ (self, state)
 

Public Attributes

 length
 Allow length to be a callable:
 
 encoding
 
- Public Attributes inherited from volatility.obj.BaseObject
 obj_offset
 
 obj_vm
 

Detailed Description

Class for dealing with Strings.

Member Function Documentation

def volatility.plugins.overlays.basic.String.__str__ (   self)

This function ensures that we always return a string from the str method.

Any unusual/unicode characters in the input are replaced with ?.

Note: this effectively masks the NoneObject alert from .v()

def volatility.plugins.overlays.basic.String.v (   self)

Use zread to help emulate reading null-terminated C strings across page boundaries.

Returns
: If all bytes are available, return the full string as a raw byte buffer. If the end of the string is in a page that isn't available, return as much of the string as possible, padded with nulls to the string's length.

If the string length is 0, vtop() fails, or the physical addr of the string is not valid, return NoneObject.

Note: to get a null terminated string, use the str method.


The documentation for this class was generated from the following file: