Module: Ronin::Payloads::Metadata::Arch

Included in:

ASMPayload

Defined in:

lib/ronin/payloads/metadata/arch.rb

Overview

Metadata mixin that allows a payload to define which architecture it specifically targets.

Defined Under Namespace

Modules: ClassMethods

Class Method Summary

• .included(payload) ⇒ Object private

  Adds an arch metadata attribute to the payload.

Instance Method Summary

• #arch ⇒ :x86, ...

  The architecture that the payload targets.

Class Method Details

.included(payload) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Adds an arch metadata attribute to the payload.

Parameters:

• payload (Class<Ronin::Payloads::Payload>) —

  The payload class that is including Ronin::Payloads::Metadata::Arch.

# File 'lib/ronin/payloads/metadata/arch.rb', line 38

def self.included(payload)
  payload.extend ClassMethods
end

Instance Method Details

#arch ⇒ :x86, ...

The architecture that the payload targets.

Returns:

• (:x86, :x86_64, :ia64, :amd64, :ppc, :ppc64, :mips, :mips_le, :mips_be, :mips64, :mips64_le, :mips64_be, :arm, :arm_le, :arm_be, :arm64, :arm64_le, :arm64_be, nil) —

  The payload's architecture.

See Also:

• Ronin::Payloads::Metadata::Arch::ClassMethods#arch

# File 'lib/ronin/payloads/metadata/arch.rb', line 82

def arch
  self.class.arch
end