Struct UsernamePasswordRequest

pub struct UsernamePasswordRequest {
    pub version: UsernamePasswordSubnegotiationVersion,
    pub basic: Basic,
}

Initial username-password negotiation starts with the client sending this request.

Once the SOCKS V5 server has started, and the client has selected the Username/Password Authentication protocol, the Username/Password subnegotiation begins. This begins with the client producing a Username/Password request:

+----+------+----------+------+----------+
|VER | ULEN |  UNAME   | PLEN |  PASSWD  |
+----+------+----------+------+----------+
| 1  |  1   | 1 to 255 |  1   | 1 to 255 |
+----+------+----------+------+----------+

The VER field contains the current version of the subnegotiation, which is X’01’. The ULEN field contains the length of the UNAME field that follows. The UNAME field contains the username as known to the source operating system. The PLEN field contains the length of the PASSWD field that follows. The PASSWD field contains the password association with the given UNAME.

Reference: https://datatracker.ietf.org/doc/html/rfc1929#section-2

Security Considerations

Since the request carries the password in cleartext, this subnegotiation is not recommended for environments where “sniffing” is possible and practical.

Fields

version: UsernamePasswordSubnegotiationVersion

basic: Basic

Implementations

impl UsernamePasswordRequest

pub fn new(basic: Basic) -> UsernamePasswordRequest

Create a new UsernamePasswordRequest.

pub async fn read_from<R>( r: &mut R, ) -> Result<UsernamePasswordRequest, ProtocolError>

where R: AsyncRead + Unpin,

Read the client UsernamePasswordRequest, decoded from binary format as specified by RFC 1929 from the reader.

pub async fn write_to<W>(&self, w: &mut W) -> Result<(), Error>

where W: AsyncWrite + Unpin,

Write the client UsernamePasswordRequest in binary format as specified by RFC 1929 into the writer.

Trait Implementations

impl Clone for UsernamePasswordRequest

fn clone(&self) -> UsernamePasswordRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UsernamePasswordRequest

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

Formats the value using the given formatter.

impl PartialEq<UsernamePasswordRequest> for UsernamePasswordRequestRef<'_>

fn eq(&self, other: &UsernamePasswordRequest) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<UsernamePasswordRequestRef<'_>> for UsernamePasswordRequest

fn eq(&self, other: &UsernamePasswordRequestRef<'_>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for UsernamePasswordRequest

fn eq(&self, other: &UsernamePasswordRequest) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for UsernamePasswordRequest

impl StructuralPartialEq for UsernamePasswordRequest