Struct tor_socksproto::msg::SocksRequest

pub struct SocksRequest {
    version: SocksVersion,
    cmd: SocksCmd,
    addr: SocksAddr,
    port: u16,
    auth: SocksAuth,
}

A completed SOCKS request, as negotiated on a SOCKS connection.

Once this request is done, we know where to connect. Don’t discard this object immediately: Use it to report success or failure.

Fields

version: SocksVersion

Negotiated SOCKS protocol version.

cmd: SocksCmd

The command requested by the SOCKS client.

addr: SocksAddr

The target address.

port: u16

The target port.

auth: SocksAuth

Authentication information.

(Tor doesn’t believe in SOCKS authentication, since it cannot possibly secure. Instead, we use it for circuit isolation.)

Implementations

impl SocksRequest

pub fn reply( &self, status: SocksStatus, addr: Option<&SocksAddr> ) -> EncodeResult<Vec<u8>>

Available on crate feature proxy-handshake only.

Format a reply to this request, indicating success or failure.

Note that an address should be provided only when the request was for a RESOLVE.

fn s4( &self, status: SocksStatus, addr: Option<&SocksAddr> ) -> EncodeResult<Vec<u8>>

Available on crate feature proxy-handshake only.

Format a SOCKS4 reply.

fn s5( &self, status: SocksStatus, addr: Option<&SocksAddr> ) -> EncodeResult<Vec<u8>>

Available on crate feature proxy-handshake only.

Format a SOCKS5 reply.

impl SocksRequest

pub fn new( version: SocksVersion, cmd: SocksCmd, addr: SocksAddr, port: u16, auth: SocksAuth ) -> Result<Self>

Create a SocksRequest with a given set of fields.

Return an error if the inputs aren’t supported or valid.

pub fn version(&self) -> SocksVersion

Return the negotiated version (4 or 5).

pub fn command(&self) -> SocksCmd

Return the command that the client requested.

pub fn auth(&self) -> &SocksAuth

Return the ‘authentication’ information from this request.

pub fn port(&self) -> u16

Return the requested port.

pub fn addr(&self) -> &SocksAddr

Return the requested address.

Trait Implementations

impl<'a> Arbitrary<'a> for SocksRequest

Available on crate feature arbitrary only.

fn arbitrary(u: &mut Unstructured<'a>) -> ArbitraryResult<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl Clone for SocksRequest

fn clone(&self) -> SocksRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SocksRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.