socks5_impl/protocol/
mod.rs

1mod address;
2mod command;
3pub mod handshake;
4mod reply;
5mod request;
6mod response;
7mod udp;
8
9pub use self::{
10    address::{Address, AddressType},
11    command::Command,
12    handshake::{
13        AuthMethod,
14        password_method::{self, UserKey},
15    },
16    reply::Reply,
17    request::Request,
18    response::Response,
19    udp::UdpHeader,
20};
21pub use bytes::BufMut;
22
23#[cfg(feature = "tokio")]
24use async_trait::async_trait;
25#[cfg(feature = "tokio")]
26use tokio::io::{AsyncRead, AsyncWrite, AsyncWriteExt};
27
28/// SOCKS protocol version, either 4 or 5
29#[repr(u8)]
30#[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, Default)]
31pub enum Version {
32    V4 = 4,
33    #[default]
34    V5 = 5,
35}
36
37impl TryFrom<u8> for Version {
38    type Error = std::io::Error;
39
40    fn try_from(value: u8) -> std::io::Result<Self> {
41        match value {
42            4 => Ok(Version::V4),
43            5 => Ok(Version::V5),
44            _ => Err(std::io::Error::new(std::io::ErrorKind::InvalidData, "invalid version")),
45        }
46    }
47}
48
49impl From<Version> for u8 {
50    fn from(v: Version) -> Self {
51        v as u8
52    }
53}
54
55impl std::fmt::Display for Version {
56    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
57        let v: u8 = (*self).into();
58        write!(f, "{}", v)
59    }
60}
61
62pub trait StreamOperation {
63    fn retrieve_from_stream<R>(stream: &mut R) -> std::io::Result<Self>
64    where
65        R: std::io::Read,
66        Self: Sized;
67
68    fn write_to_stream<W: std::io::Write>(&self, w: &mut W) -> std::io::Result<()> {
69        let mut buf = Vec::with_capacity(self.len());
70        self.write_to_buf(&mut buf);
71        w.write_all(&buf)
72    }
73
74    fn write_to_buf<B: bytes::BufMut>(&self, buf: &mut B);
75
76    fn len(&self) -> usize;
77
78    fn is_empty(&self) -> bool {
79        self.len() == 0
80    }
81}
82
83#[cfg(feature = "tokio")]
84#[async_trait]
85pub trait AsyncStreamOperation: StreamOperation {
86    async fn retrieve_from_async_stream<R>(r: &mut R) -> std::io::Result<Self>
87    where
88        R: AsyncRead + Unpin + Send + ?Sized,
89        Self: Sized;
90
91    async fn write_to_async_stream<W>(&self, w: &mut W) -> std::io::Result<()>
92    where
93        W: AsyncWrite + Unpin + Send + ?Sized,
94    {
95        let mut buf = bytes::BytesMut::with_capacity(self.len());
96        self.write_to_buf(&mut buf);
97        w.write_all(&buf).await
98    }
99}
socks5_impl/protocol/mod.rs

socks5_impl/protocol/
mod.rs
