Class Msf::Encoder
In: lib/msf/core/encoder.rb
Parent: Module

This class is the base class that all encoders inherit from.

Methods

decoder_block_size   decoder_hash   decoder_key_offset   decoder_key_pack   decoder_key_size   decoder_stub   do_encode   encode   encode_begin   encode_block   encode_end   encode_finalize_stub   encoder_type   find_bad_keys   find_context_key   find_key   find_key_verify   has_badchars?   init_state   integer_to_key_bytes   key_bytes_to_buffer   key_bytes_to_integer   new   obtain_key   prepend_buf   to_native   type   type  

Classes and Modules

Module Msf::Encoder::Type

Public Class methods

new(info)

Initializes an encoder module instance using the supplied information hash.

type()

Returns MODULE_ENCODER to indicate that this is an encoder module.

Public Instance methods

decoder_block_size()

Returns the size of each logical encoding block, in bytes. This is typically the same as decoder_key_size.

decoder_hash()

Returns the module‘s decoder hash or an empty hash.

decoder_key_offset()

Returns the offset to the key associated with the decoder stub.

decoder_key_pack()

Returns the byte-packing character that should be used to encode the key.

decoder_key_size()

Returns the size of the key, in bytes.

decoder_stub(state)

Returns the decoder stub to use based on the supplied state.

do_encode(state)

Performs the actual encoding operation after the encoder state has been initialized and is ready to go.

encode(buf, badchars = nil, state = nil)

This method generates an encoded version of the supplied buffer in buf using the bad characters as guides. On success, an encoded and functional version of the supplied buffer will be returned. Otherwise, an exception will be thrown if an error is encountered during the encoding process.

encode_begin(state)

Called when encoding is about to start immediately after the encoding state has been initialized.

encode_block(state, block)

Called once for each block being encoded based on the attributes of the decoder.

encode_end(state)

Called after encoding has completed.

encode_finalize_stub(state, stub)

This callback allows a derived class to finalize a stub after a key have been selected. The finalized stub should be returned.

encoder_type()

Returns the type or types of encoders that this specific module classifies as. If there is more than one type, the values should be separated by whitespace.

prepend_buf()

Returns a string that should be prepended to the encoded version of the buffer before returning it to callers.

to_native(buf)

Provides the encoder with an opportunity to return the native format (as in the format the code will be in when it executes on the target). In general, the same buffer is returned to the caller. However, for things like unicode, the buffer is unicod encoded and then returned.

type()

Returns MODULE_ENCODER to indicate that this is an encoder module.

Protected Instance methods

find_bad_keys(buf, badchars)

Returns the list of bad keys associated with this encoder.

find_context_key(buf, badchars, state)

Parses a context information file in an effort to find a compatible key

find_key(buf, badchars, state)

This method finds a compatible key for the supplied buffer based also on the supplied bad characters list. This is meant to make encoders more reliable and less prone to bad character failure by doing a fairly complete key search before giving up on an encoder.

find_key_verify(buf, key_bytes, badchars)

Determines if the key selected by find_key is usable

has_badchars?(buf, badchars)

Returns the index of any bad characters found in the supplied buffer.

init_state(state)

Initializes the encoding state supplied as an argument to the attributes that have been defined for this decoder stub, such as key offset, size, and pack.

integer_to_key_bytes(integer)

Convert an integer into the individual key bytes based on the decoder‘s key size and packing requirements

key_bytes_to_buffer(key_bytes)

Convert individual key bytes into a byte buffer

key_bytes_to_integer(key_bytes)

Convert individual key bytes into a single integer based on the decoder‘s key size and packing requirements

obtain_key(buf, badchars, state)

Obtains the key to use during encoding. If context encoding is enabled, special steps are taken. Otherwise, the derived class is given an opportunity to find the key.

[Validate]