Struct SocksProxyHandshake

pub struct SocksProxyHandshake {
    state: State,
    socks5_auth: Option<SocksAuth>,
    handshake: Option<SocksRequest>,
}

Available on crate feature proxy-handshake only.

The Proxy (responder) side of an ongoing SOCKS handshake.

Create you have one of these with SocksProxyHandshake::new(), and then use Handshake::step to drive it.

Eventually you will hopefully obtain a SocksRequest, on which you should call .reply(), and send the resulting data to the peer.

Fields

state: State

Current state of the handshake. Each completed message advances the state.

socks5_auth: Option<SocksAuth>

SOCKS5 authentication that has been received (but not yet put in a SocksRequest object.)

handshake: Option<SocksRequest>

Completed SOCKS handshake.

Implementations

impl SocksProxyHandshake

pub fn new() -> Self

Construct a new SocksProxyHandshake in its initial state

fn s4(&mut self, r: &mut Reader<'_>) -> Result<ImplNextStep>

Complete a socks4 or socks4a handshake.

fn s5_initial(&mut self, r: &mut Reader<'_>) -> Result<ImplNextStep>

Socks5: initial handshake to negotiate authentication method.

fn s5_uname(&mut self, r: &mut Reader<'_>) -> Result<ImplNextStep>

Socks5: second step for username/password authentication.

fn s5(&mut self, r: &mut Reader<'_>) -> Result<ImplNextStep>

Socks5: final step, to receive client’s request.

pub fn finished(&self) -> bool

Return true if this handshake is finished.

pub fn into_request(self) -> Option<SocksRequest>

Consume this handshake’s state; if it finished successfully, return a SocksRequest.

Trait Implementations

impl Clone for SocksProxyHandshake

fn clone(&self) -> SocksProxyHandshake

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SocksProxyHandshake

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

Formats the value using the given formatter.

impl Default for SocksProxyHandshake

fn default() -> Self

Returns the “default value” for a type.

impl Handshake for SocksProxyHandshake

type Output = <Option<SocksRequest> as IntoIterator>::Item

Available on crate features proxy-handshake or client-handshake only.

Output from the handshake: the meaning, as we understand it

fn step<'b, P: ReadPrecision>( &mut self, buffer: &'b mut Buffer<P>, ) -> Result<NextStep<'b, <Self as Handshake>::Output, P>, Error>

Available on crate features proxy-handshake or client-handshake only.

Drive a handshake forward, determining what the next step is

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

👎Deprecated: use the new Handshake::step API instead

Available on crate features proxy-handshake or client-handshake only.

Try to advance the handshake, given some peer input in input.

impl HandshakeImpl for SocksProxyHandshake

fn handshake_impl(&mut self, input: &mut Reader<'_>) -> Result<ImplNextStep>

Available on crate features proxy-handshake or client-handshake only.

Actual implementation, to be provided

fn call_handshake_impl(&mut self, input: &[u8]) -> (usize, Result<ImplNextStep>)

Available on crate features proxy-handshake or client-handshake only.

Helper, used by public API implementations to call handshake_impl.

impl HasHandshakeOutput<<Option<SocksRequest> as IntoIterator>::Item> for SocksProxyHandshake

fn take_output( &mut self, ) -> Option<<Option<SocksRequest> as IntoIterator>::Item>

Available on crate features proxy-handshake or client-handshake only.

Obtain the output from a handshake completed with .handshake

impl HasHandshakeState for SocksProxyHandshake

fn set_failed(&mut self)

Available on crate features proxy-handshake or client-handshake only.

Set the state to Failed