Debian Codegraph @

docs/source/index.rst

raw
1 socksio: Client-side sans-I/O SOCKS proxy implementation
2 ========================================================
3
4 ``socksio`` is a sans-I/O library similar to
5 `h11 <https://github.com/python-hyper/h11>`_ or
6 `h2 <https://github.com/python-hyper/hyper-h2/>`_, this means the
7 library itself does not handle the actual sending of the bytes through
8 the network, it only deals with the implementation details of the SOCKS
9 protocols so you can use it in any I/O library you want.
10
11 Current status: stable
12 ----------------------
13
14 Features not yet implemented:
15
16 - SOCKS5 GSS-API authentication.
17 - SOCKS5 UDP associate requests.
18
19 Contents
20 --------
21
22 .. toctree::
23 :maxdepth: 2
24
25 usage.rst
26 development.rst
27 api_socks4.rst
28 api_socks5.rst
29
30 Reference documents
31 -------------------
32
33 Each implementation follows the documents as listed below:
34
35 - SOCKS4: https://www.openssh.com/txt/socks4.protocol
36 - SOCKS4A: https://www.openssh.com/txt/socks4a.protocol
37 - SOCKS5: https://www.ietf.org/rfc/rfc1928.txt
38 - SOCKS5 username/password authentication:
39 https://www.ietf.org/rfc/rfc1929.txt
40 - SOCKS5 GSS-API authentication: https://www.ietf.org/rfc/rfc1961.txt
41
42 License
43 -------
44
45 MIT