https://github.com/rofl0r/microsocks

tiny, portable SOCKS5 server with very moderate resource usage
https://github.com/rofl0r/microsocks

lightweight proxy pthreads socks5 socks5-proxy socks5-server

Last synced: 2 months ago
JSON representation

tiny, portable SOCKS5 server with very moderate resource usage

• Host: GitHub
• URL: https://github.com/rofl0r/microsocks
• Owner: rofl0r
• License: other
• Created: 2017-03-01T17:38:36.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-02-26T19:17:58.000Z (4 months ago)
• Last Synced: 2024-02-26T20:33:50.163Z (4 months ago)
• Topics: lightweight, proxy, pthreads, socks5, socks5-proxy, socks5-server
• Language: C
• Size: 26.4 KB
• Stars: 1,270
• Watchers: 37
• Forks: 242
• Open Issues: 23
• Metadata Files:
  • Readme: README.md
  • License: COPYING

Lists

• awesome-proxy - microsocks - Tiny, portable SOCKS5 server with very moderate resource usage. (SOCKS Proxy / Popular Implementations of SOCKS server)
• awesome-stars - rofl0r/microsocks - tiny, portable SOCKS5 server with very moderate resource usage (C)
• awesome-stars - rofl0r/microsocks
• awesome-cyber-security - **257**星
• awesome-stars - rofl0r/microsocks - `★1367` tiny, portable SOCKS5 server with very moderate resource usage (C)
• awesome-network-stuff - **274**星
• awesome-network-stuff - **274**星
• awesome-stars - rofl0r/microsocks - tiny, portable SOCKS5 server with very moderate resource usage (C)

README

        
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)