github.com/TuanKiri/socks5

SOCKS 5

Report Bug | Request Feature

A fully featured implementation of the SOCKS 5 protocol in golang.

CONNECT	BIND	UDP ASSOCIATE
✅ - implemented	🛠 - in progress	✅ - implemented

Installation

go get github.com/TuanKiri/socks5

Getting Started

Create your .go file. For example: main.go.

package main

import (
	"context"
	"log"
	"os/signal"
	"syscall"

	"github.com/TuanKiri/socks5"
)

func main() {
	ctx, stop := signal.NotifyContext(context.Background(), syscall.SIGINT, syscall.SIGTERM)
	defer stop()

	srv := socks5.New()

	go func() {
		if err := srv.ListenAndServe(); err != nil {
			log.Fatal(err)
		}
	}()

	<-ctx.Done()

	if err := srv.Shutdown(); err != nil {
		log.Fatal(err)
	}
}

Run your server:

go run main.go

The following curl example shows how to use the proxy server:

curl -x socks5://127.0.0.1:1080 http://example.com

See the tests and examples for more information about package.

FAQ

• Why can't connect to socks proxy server?

  Not all applications and browsers support socks authentication or socks protocol. You may need extension for Chrome or another browser.

If you have any questions, you can ask in GitHub Discussions.

Note

• The proof of work for the UDP association was done using qBittorrent - a BitTorrent client.

Contributing

Feel free to open tickets or send pull requests with improvements. Thanks in advance for your help!

Please follow the contribution guidelines.

References

• RFC 1928 SOCKS Protocol Version 5
• RFC 1929 Username/Password Authentication for SOCKS V5

Licenses

• All source code is licensed under the MIT License.

• Logo is based on the Go Gopher mascot originally designed by Egon Elbre and which is also licensed under the CC0 1.0 Universal License.