2020-04-19 09:08:22 +00:00
|
|
|
go-socks5
|
2014-01-22 23:49:51 +00:00
|
|
|
=========
|
|
|
|
|
|
2020-04-19 09:11:00 +00:00
|
|
|
[](https://travis-ci.org/thinkgos/go-socks5)
|
|
|
|
|
[](https://codecov.io/gh/thinkgos/go-socks5)
|
|
|
|
|
|
|
|
|
|
[](https://goreportcard.com/report/github.com/thinkgos/go-socks5)
|
|
|
|
|
[](https://github.com/thinkgos/go-socks5/raw/master/LICENSE)
|
2020-04-19 09:08:22 +00:00
|
|
|
|
2014-01-23 22:22:07 +00:00
|
|
|
Provides the `socks5` package that implements a [SOCKS5 server](http://en.wikipedia.org/wiki/SOCKS).
|
|
|
|
|
SOCKS (Secure Sockets) is used to route traffic between a client and server through
|
|
|
|
|
an intermediate proxy layer. This can be used to bypass firewalls or NATs.
|
|
|
|
|
|
|
|
|
|
Feature
|
|
|
|
|
=======
|
|
|
|
|
|
|
|
|
|
The package has the following features:
|
|
|
|
|
* "No Auth" mode
|
2020-04-21 14:39:11 +00:00
|
|
|
* User/Password authentication optional user addr limit
|
2014-01-23 22:22:07 +00:00
|
|
|
* Support for the CONNECT command
|
2020-04-20 12:41:58 +00:00
|
|
|
* Support for the ASSOCIATE command
|
2014-01-23 22:22:07 +00:00
|
|
|
* Rules to do granular filtering of commands
|
|
|
|
|
* Custom DNS resolution
|
|
|
|
|
* Unit tests
|
2020-04-21 14:39:11 +00:00
|
|
|
* Custom goroutine pool
|
|
|
|
|
* Custom logger
|
|
|
|
|
* buffer pool design
|
2014-01-23 22:22:07 +00:00
|
|
|
|
|
|
|
|
TODO
|
|
|
|
|
====
|
|
|
|
|
|
|
|
|
|
The package still needs the following:
|
|
|
|
|
* Support for the BIND command
|
2014-06-27 05:39:00 +00:00
|
|
|
|
|
|
|
|
Example
|
|
|
|
|
=======
|
|
|
|
|
|
|
|
|
|
Below is a simple example of usage
|
|
|
|
|
|
|
|
|
|
```go
|
|
|
|
|
// Create a SOCKS5 server
|
2020-04-20 13:29:50 +00:00
|
|
|
server := socks5.New()
|
2014-06-27 05:39:00 +00:00
|
|
|
|
|
|
|
|
// Create SOCKS5 proxy on localhost port 8000
|
|
|
|
|
if err := server.ListenAndServe("tcp", "127.0.0.1:8000"); err != nil {
|
|
|
|
|
panic(err)
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
2020-04-19 09:13:57 +00:00
|
|
|
# Reference
|
|
|
|
|
original armon go-sock5 [go-sock5](https://github.com/armon/go-socks5)
|
