class Struct(_Type):
A user-defined, named structure type. Can actually also be a union type.
The supported way of getting a Struct
is to read type information from the debug object of a binary, using the reven2.ossi.Binary.exact_type
method.
>>> struct_ty = next(server.ossi.executed_binaries("ntoskrnl")).exact_type("_OBJECT_ATTRIBUTES")
A Struct
obtained in this way can then produce reven2.types.StructInstance
s by passing it as the type in the reven2.trace.Context.read
method.
>>> struct_instance = ctx.read(reven2.address.LogicalAddress(0x65dd168), struct_ty)
To see the fields of a Struct
at a glance, you can use its string representation that will list them in a custom format.
>>> print(struct_ty) StructKind.Struct _OBJECT_ATTRIBUTES /* 0x30 */ { /* 0x0 */ Length : U32, /* 0x8 */ RootDirectory : void*, /* 0x10 */ ObjectName : _UNICODE_STRING*, /* 0x18 */ Attributes : U32, /* 0x20 */ SecurityDescriptor : void*, /* 0x28 */ SecurityQualityOfService : void*, }
You can also iterate over the fields programmatically with the Struct.fields
method, and get a specific field from its name with the Struct.field
and Struct.bitfield
methods (use the latter for bitfields, and the former for regular fields, or be welcomed by a ValueError).
Method | __eq__ |
Compares the instance for equality with an object. |
Method | __hash__ |
Returns the hash for this value. |
Method | __init__ |
Initializes a new instance of this class from its kind, its size in bytes, its name, its mangled name if available, all of its fields, and optionally a Resolver. |
Method | __ne__ |
Compares the instance for equality with an object. |
Method | __str__ |
Returns the nicely printable string representation of this instance. |
Method | bitfield |
Find a bitfield from its name. |
Method | description |
The short description of this type. |
Method | field |
Find a regular (as in, non-bitfield) field from its name. |
Method | fields |
An iterator other the fields in this struct, in declaration order. |
Method | is |
Whether the context argument needed by some methods actually has an effect. |
Property | kind |
Whether this instance is a struct, class, interface or enum. |
Property | mangled |
The mangled name of this struct, if exists. |
Property | name |
The name of this struct. |
Method | _construct |
Return the underlying construct instance |
Method | _decode |
Undocumented |
Method | _encode |
Undocumented |
Instance Variable | _fields |
Undocumented |
Instance Variable | _kind |
Undocumented |
Instance Variable | _mangled |
Undocumented |
Instance Variable | _name |
Undocumented |
Instance Variable | _resolver |
Undocumented |
Instance Variable | _size |
Undocumented |
Inherited from Type
:
Method | parse |
Parses the value of an instance of this type from a raw buffer, possibly depending on the context. |
Method | size |
The minimal number of bytes necessary to hold an instance of this type, possibly depending on the context. |
Method | to |
Build a byte buffer from a value of this type. |
Method | _resolve |
Uses the resolver to return a resolved version of the type, if possible. |
Compares the instance for equality with an object.
- if the object is not a
Struct
, it will never be equal to this instance.
Parameters | |
o:object | Undocumented |
Returns | |
bool | Undocumented |
Initializes a new instance of this class from its kind, its size in bytes, its name, its mangled name if available, all of its fields, and optionally a Resolver.
Parameters | |
kind:StructKind | Undocumented |
size:int | Undocumented |
name:str | Undocumented |
mangled_Optional[ | Undocumented |
fields:_Iterable[ | Undocumented |
resolver:_Optional[ | Undocumented |
Compares the instance for equality with an object.
- if the object is not a
Struct
, it will never be equal to this instance.
Parameters | |
o:object | Undocumented |
Returns | |
bool | Undocumented |
Returns the nicely printable string representation of this instance.
Returns | |
str | Undocumented |
Find a bitfield from its name.
Information
Parameters | |
key:str | the exact name of the bitfield in the struct. |
Returns | |
Bitfield | Undocumented |
Raises | |
KeyError | if no field with this name exists in the struct. |
ValueError | if a field with this name exists in the struct, but is not a bitfield. |
reven2.types._type.Type.description
The short description of this type.
For named types, it is the name of the type. For other types, it is generally __str__.
Returns | |
str | Undocumented |
Find a regular (as in, non-bitfield) field from its name.
Information
Parameters | |
key:str | the exact name of the field in the struct. |
Returns | |
RegularField | Undocumented |
Raises | |
KeyError | if no field with this name exists in the struct. |
ValueError | if a field with this name exists in the struct, but is a bitfield. |
An iterator other the fields in this struct, in declaration order.
Returns | |
_Iterator[ | Undocumented |
Whether the context argument needed by some methods actually has an effect.
Types that return False to this method are context-insensitive types. You can safely pass any object as context parameter (including None) to the methods of such type.
Note that the context-sensitivity of a type may change in the future.
Examples
Getting the size of a type without needing a context for context-insensitive types: >>> types.U32.is_context_sensitive() False >>> types.U32.size_bytes(context=None) 4 >>> array32_12 = types.Array(types.U32, 12) >>> array32_12.is_context_sensitive() False >>> array32_12.size_bytes() # context=None by default 48
Context-sensitive types may raise errors when attempting to get the size without a context: >>> types.USize.is_context_sensitive() True >>> types.USize.size_bytes(context=None) ValueError: Please provide a context when using a context-sensitive type
Returns | |
bool | Undocumented |
reven2.types._type.Type._construct_type
Return the underlying construct instance
Parameters | |
context:_Optional[ | Undocumented |
Returns | |
_construct.core.Construct | Undocumented |
Undocumented
Parameters | |
buf:bytes | Undocumented |
context:Context | Undocumented |
Returns | |
StructInstance | Undocumented |
Undocumented
Parameters | |
value:StructInstance | Undocumented |
_ | Undocumented |
Returns | |
bytes | Undocumented |