66 lines
2.3 KiB
Markdown
66 lines
2.3 KiB
Markdown
|
MicroSocks - multithreaded, small, efficient SOCKS5 server.
|
||
|
|
===========================================================
|
||
|
|
|
||
|
|
a SOCKS5 service that you can run on your remote boxes to tunnel connections
|
||
|
|
through them, if for some reason SSH doesn't cut it for you.
|
||
|
|
|
||
|
|
It's very lightweight, and very light on resources too:
|
||
|
|
|
||
|
|
for every client, a thread with a stack size of 8KB is spawned.
|
||
|
|
the main process basically doesn't consume any resources at all.
|
||
|
|
|
||
|
|
the only limits are the amount of file descriptors and the RAM.
|
||
|
|
|
||
|
|
It's also designed to be robust: it handles resource exhaustion
|
||
|
|
gracefully by simply denying new connections, instead of calling abort()
|
||
|
|
as most other programs do these days.
|
||
|
|
|
||
|
|
another plus is ease-of-use: no config file necessary, everything can be
|
||
|
|
done from the command line and doesn't even need any parameters for quick
|
||
|
|
setup.
|
||
|
|
|
||
|
|
History
|
||
|
|
-------
|
||
|
|
|
||
|
|
This is the successor of "rocksocks5", and it was written with
|
||
|
|
different goals in mind:
|
||
|
|
|
||
|
|
- prefer usage of standard libc functions over homegrown ones
|
||
|
|
- no artificial limits
|
||
|
|
- do not aim for minimal binary size, but for minimal source code size,
|
||
|
|
and maximal readability, reusability, and extensibility.
|
||
|
|
|
||
|
|
as a result of that, ipv4, dns, and ipv6 is supported out of the box
|
||
|
|
and can use the same code, while rocksocks5 has several compile time
|
||
|
|
defines to bring down the size of the resulting binary to extreme values
|
||
|
|
like 10 KB static linked when only ipv4 support is enabled.
|
||
|
|
|
||
|
|
still, if optimized for size, *this* program when static linked against musl
|
||
|
|
libc is not even 50 KB. that's easily usable even on the cheapest routers.
|
||
|
|
|
||
|
|
command line options
|
||
|
|
--------------------
|
||
|
|
|
||
|
|
microsocks -1 -i listenip -p port -u user -P password -b bindaddr
|
||
|
|
|
||
|
|
all arguments are optional.
|
||
|
|
by default listenip is 0.0.0.0 and port 1080.
|
||
|
|
|
||
|
|
option -1 activates auth_once mode: once a specific ip address
|
||
|
|
authed successfully with user/pass, it is added to a whitelist
|
||
|
|
and may use the proxy without auth.
|
||
|
|
this is handy for programs like firefox that don't support
|
||
|
|
user/pass auth. for it to work you'd basically make one connection
|
||
|
|
with another program that supports it, and then you can use firefox too.
|
||
|
|
for example, authenticate once using curl:
|
||
|
|
|
||
|
|
curl --socks5 user:password@listenip:port anyurl
|
||
|
|
|
||
|
|
|
||
|
|
Supported SOCKS5 Features
|
||
|
|
-------------------------
|
||
|
|
- authentication: none, password, one-time
|
||
|
|
- IPv4, IPv6, DNS
|
||
|
|
- TCP (no UDP at this time)
|
||
|
|
|