Struct tor_socksproto::SocksClientHandshake

pub struct SocksClientHandshake {
    request: SocksRequest,
    state: State,
    reply: Option<SocksReply>,
}

Available on crate feature client-handshake only.

The client (initiator) side of a SOCKS handshake.

Fields

request: SocksRequest

The request that we are currently trying to negotiate with the proxy.

state: State

Our current state in negotiating that request.

reply: Option<SocksReply>

If present, the return message that we received from the proxy.

Implementations

impl SocksClientHandshake

pub fn new(request: SocksRequest) -> Self

Construct a new SocksClientHandshake that will attempt to negotiate with a peer using request.

pub fn into_reply(self) -> Option<SocksReply>

Consume this handshake’s state; if it finished successfully, return the SocksReply that we got from the proxy..

pub fn handshake(&mut self, input: &[u8]) -> TResult<Action>

Try to advance a SocksProxyHandshake, given some proxy input in input.

If there isn’t enough input, gives a Truncated. In this case, the caller must retain the input, and pass it to a later invocation of handshake. Input should only be regarded as consumed when the Action::drain field is nonzero.

Other errors (besides Truncated) indicate a failure.

On success, return an Action describing what to tell the proxy, and how much of its input to consume.

fn send_v4(&mut self) -> Result<Action>

Send the client side of the socks 4 handshake.

fn handle_v4(&mut self, input: &[u8]) -> Result<Action>

Handle a SOCKSv4 response.

fn send_v5_initial(&mut self) -> Result<Action>

Send our initial socks5 message (which negotiates our authentication methods).

fn handle_v5_auth(&mut self, input: &[u8]) -> Result<Action>

Try to handle a socks5 reply telling us what authentication method to use, and reply as appropriate.

fn generate_v5_username_auth(&self) -> Result<Vec<u8>>

Return a message to perform username/password authentication.

fn handle_v5_username_ack(&mut self, input: &[u8]) -> Result<Action>

Try to handle a reply from the socks5 proxy to acknowledge our username/password authentication, and reply as appropriate.

fn generate_v5_command(&self) -> Result<Vec<u8>>

Return a message to encode our final socks5 request.

(This can be done either in response getting an ACK for our authentication, or in response to being told that we don’t need to authenticate.)

fn handle_v5_final(&mut self, input: &[u8]) -> Result<Action>

Handle a final socks5 reply.

Trait Implementations

impl Clone for SocksClientHandshake

fn clone(&self) -> SocksClientHandshake

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SocksClientHandshake

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

Formats the value using the given formatter.