Module: Ronin::Support::Binary::CTypes::Mixin

Included in:

Array, Buffer, Stack, Stream, Struct, Template

Defined in:

lib/ronin/support/binary/ctypes/mixin.rb

Overview

Adds a type system that can be used by Memory objects.

Instance Attribute Summary

• #arch ⇒ :x86, ... readonly

  The desired architecture of the binary format.

• #endian ⇒ :little, ... readonly

  The endianness of the binary format.

• #os ⇒ :linux, ... readonly

  The desired Operating System (OS) of the binary format.

• #type_resolver ⇒ Resolver readonly

  The type resolver.

• #type_system ⇒ Native, ... readonly

  The type system module or object to lookup type names in.

Instance Method Summary

• #initialize_type_system(type_system: nil, endian: nil, arch: nil, os: nil) ⇒ Object protected

  Initializes the type system.

Instance Attribute Details

#arch ⇒ :x86, ... (readonly)

The desired architecture of the binary format.

Returns:

• (:x86, :x86_64, :ppc, :ppc64, :arm, :arm_be, :arm64, :arm64_be, :mips, :mips_le, :mips64, :mips64_le, nil)

# File 'lib/ronin/support/binary/ctypes/mixin.rb', line 44

def arch
  @arch
end

#endian ⇒ :little, ... (readonly)

The endianness of the binary format.

Returns:

• (:little, :big, :net, nil)

# File 'lib/ronin/support/binary/ctypes/mixin.rb', line 36

def endian
  @endian
end

#os ⇒ :linux, ... (readonly)

The desired Operating System (OS) of the binary format.

Returns:

• (:linux, :macos, :windows, :bsd, :freebsd, :openbsd, :netbsd, nil)

# File 'lib/ronin/support/binary/ctypes/mixin.rb', line 52

def os
  @os
end

#type_resolver ⇒ Resolver (readonly)

The type resolver.

Returns:

• (Resolver)

# File 'lib/ronin/support/binary/ctypes/mixin.rb', line 77

def type_resolver
  @type_resolver
end

#type_system ⇒ Native, ... (readonly)

The type system module or object to lookup type names in.

Returns:

• (Native, LittleEndian, BigEndian, Network, Arch::ARM, Arch::ARM::BigEndian, Arch::ARM64, Arch::ARM64::BigEndian, Arch::MIPS, Arch::MIPS::LittleEndian, Arch::MIPS64, Arch::MIPS64::LittleEndian, Arch::PPC64, Arch::PPC, Arch::X86_64, Arch::X86, OS::FreeBSD, OS::NetBSD, OS::OpenBSD, OS::Linux, OS::MacOS, OS::Windows)

# File 'lib/ronin/support/binary/ctypes/mixin.rb', line 70

def type_system
  @type_system
end

Instance Method Details

#initialize_type_system(type_system: nil, endian: nil, arch: nil, os: nil) ⇒ Object (protected)

Initializes the type system.

Optional type system to use instead.

The desired architecture to use.

The Operating System (OS) to use.

Parameters:

• type_system (Native, LittleEndian, BigEndian, Network, Arch::ARM, Arch::ARM::BigEndian, Arch::ARM64, Arch::ARM64::BigEndian, Arch::MIPS, Arch::MIPS::LittleEndian, Arch::MIPS64, Arch::MIPS64::LittleEndian, Arch::PPC64, Arch::PPC, Arch::X86_64, Arch::X86, OS::FreeBSD, OS::NetBSD, OS::OpenBSD, OS::Linux, OS::MacOS, OS::Windows, nil) (defaults to: nil)
• endian (:little, :big, :net, nil) (defaults to: nil) —

  The desired endianness to use.

• arch (:x86, :x86_64, :ppc, :ppc64, :mips, :mips_le, :mips_be, :mips64, :mips64_le, :mips64_be, :arm, :arm_le, :arm_be, :arm64, :arm64_le, :arm64_be) (defaults to: nil)
• os (:linux, :macos, :windows, :bsd, :freebsd, :openbsd, :netbsd) (defaults to: nil)

# File 'lib/ronin/support/binary/ctypes/mixin.rb', line 113

def initialize_type_system(type_system: nil,
                           endian:      nil,
                           arch:        nil,
                           os:          nil)
  @endian = endian
  @arch   = arch
  @os     = os

  @type_system = type_system || CTypes.platform(
                                  endian: endian,
                                  arch:   arch,
                                  os:     os
                                )

  @type_resolver = CTypes::TypeResolver.new(@type_system)
end