Class Rex::Post::Meterpreter::Channel
In: lib/rex/post/meterpreter/channel.rb
Parent: Object

The channel class represents a logical data pipe that exists between the client and the server. The purpose and behavior of the channel depends on which type it is. The three basic types of channels are streams, datagrams, and pools. Streams are basically equivalent to a TCP connection. Bidirectional, connection-oriented streams. Datagrams are basically equivalent to a UDP session. Bidirectional, connectionless. Pools are basically equivalent to a uni-directional connection, like a file handle. Pools denote channels that only have requests flowing in one direction.

Methods

_close   _read   _write   cleanup   close   close_read   close_write   create   dio_close_handler   dio_handler   dio_map   dio_read_handler   dio_write_handler   flag?   interactive   new   read   request_handler   synchronous?   write  

Included Modules

Rex::Post::Meterpreter::InboundPacketHandler

Attributes

cid  [R]  The unique channel identifier.
cls  [R]  The class of channel (stream, datagram, pool).
flags  [R]  Any channel-specific flag, like synchronous IO.
type  [R]  The type of channel.

Public Class methods

create(client, type = nil, klass = nil, flags = CHANNEL_FLAG_SYNCHRONOUS, addends = nil)

Creates a logical channel between the client and the server based on a given type.

new(client, cid, type, flags)

Initializes the instance‘s attributes, such as client context, class identifier, type, and flags.

request_handler(client, packet)

Class request handler for all channels that dispatches requests to the appropriate class instance‘s DIO handler

Public Instance methods

_close(addends = nil)

Closes the channel.

_read(length = nil, addends = nil)

Reads data from the remote half of the channel.

_write(buf, length = nil, addends = nil)

Writes data to the remote half of the channel.

close(addends = nil)

Wrapper around the low-level close.

close_read()

Close the channel for future reads.

close_write()

Close the channel for future writes.

dio_handler(dio, packet)

Handles dispatching I/O requests based on the request packet. The default implementation does nothing with direct I/O requests.

dio_map(method)

Maps packet request methods to DIO request identifiers on a per-instance basis as other instances may add custom dio handlers.

flag?(flag)

Checks to see if a flag is set on the instance‘s flags attribute.

read(length = nil, addends = nil)

Wrapper around the low-level channel read operation.

synchronous?()

Returns whether or not the channel is operating synchronously.

write(buf, length = nil, addends = nil)

Wrapper around the low-level write.

Protected Instance methods

cleanup()

Cleans up any lingering resources

[Validate]