Class: Rex::Services::LocalRelay

This service acts as a local TCP relay whereby clients can connect to a local listener that forwards to an arbitrary remote endpoint. Interaction with the remote endpoint socket requires that it implement the Rex::IO::Stream interface.

Methods

accept_relay_conn alias close_relay close_relay_conn each_tcp_relay hardcore_alias monitor_relays new start start_relay start_tcp_relay stop stop_relay stop_tcp_relay

Classes and Modules

Module Rex::Services::LocalRelay::Stream
Module Rex::Services::LocalRelay::StreamServer
Class Rex::Services::LocalRelay::Relay

Attributes

 relay_mutex
 relay_thread
 relays
 rfds

Public Class methods

hardcore_alias(*args)

Returns the hardcore alias for the local relay service.

new()

Initializes the local tcp relay monitor.

Public Instance methods

alias()

Returns the alias for this service.

each_tcp_relay() {|relay.opts['LocalHost'] || '0.0.0.0', relay.opts['LocalPort'], relay.opts['PeerHost'], relay.opts['PeerPort'], relay.opts| ...}

Enumerate each TCP relay

start()

Starts the thread that monitors the local relays.

start_relay(stream_server, name, opts = {})

Starts a local relay on the supplied local port. This listener will call the supplied callback procedures when various events occur.

start_tcp_relay(lport, opts = {})

Starts a local TCP relay.

stop()

Stops the thread that monitors the local relays and destroys all local listeners.

stop_relay(name)

Stops a relay with a given name.

stop_tcp_relay(lport, lhost = nil)

Stops relaying on a given local port.

Protected Instance methods

accept_relay_conn(srvfd)

Accepts a client connection on a local relay.

close_relay(relay)

Closes an cleans up a specific relay

close_relay_conn(fd)

Closes a specific relay connection without tearing down the actual relay itself.

monitor_relays()