add aes-128 aes-192 cipher

This reverts commit ae699f498c.

.github/ISSUE_TEMPLATE

@@ -0,0 +1,12 @@
+Before firing issue, make sure you figured out the following common questions.
+
+PLEASE DO SEARCH FIRST.
+
+1. Are you using the **latest release**?
+2. Which **OS** do you use?
+3. Which end for this issue related to, **client or server**?
+4. Are you using the **same version** for both client & server
+5. Did you correctly set the ***-target value, -t value	target server address (default: "127.0.0.1:12948")*** on the server side?
+6. Can ```telnet target port``` successful?
+7. ```-nocomp, -datashard, -parityshard,  -key, -crypt``` ***must be the same*** on both side.
+8. Does your ***firewall allows UDP*** communications? (including your ISP Cable-Modem)

README.en.md

@@ -1,5 +1,5 @@
 # <img src="logo.png" alt="kcptun" height="60px" /> 
-[![GoDoc][1]][2] [![Release][13]][14] [![Powered][17]][18] [![Build Status][3]][4] [![Go Report Card][5]][6] [![Downloads][15]][16] [![Gitter][19]][20]
+[![GoDoc][1]][2] [![Release][13]][14] [![Powered][17]][18] [![MIT licensed][11]][12] [![Build Status][3]][4] [![Go Report Card][5]][6] [![Downloads][15]][16] [![Gitter][19]][20]
 [1]: https://godoc.org/github.com/xtaci/kcptun?status.svg
 [2]: https://godoc.org/github.com/xtaci/kcptun
 [3]: https://travis-ci.org/xtaci/kcptun.svg?branch=master
@@ -10,8 +10,8 @@
 [8]: https://raw.githubusercontent.com/xtaci/kcptun/master/LICENSE.md
 [9]: https://img.shields.io/github/stars/xtaci/kcptun.svg
 [10]: https://github.com/xtaci/kcptun/stargazers
-[11]: https://img.shields.io/github/forks/xtaci/kcptun.svg
-[12]: https://github.com/xtaci/kcptun/network
+[11]: https://img.shields.io/badge/license-MIT-blue.svg
+[12]: LICENSE.md
 [13]: https://img.shields.io/github/release/xtaci/kcptun.svg
 [14]: https://github.com/xtaci/kcptun/releases/latest
 [15]: https://img.shields.io/github/downloads/xtaci/kcptun/total.svg?maxAge=1800
@@ -29,8 +29,8 @@ A tool for converting tcp stream into kcp+udp stream, :zap: ***[download address
 
 ### *QuickStart* :lollipop:
 ```
-Server Side: ./server_linux_amd64 -t "127.0.0.1:1080" -l ":554" -mode fast2  // forwarding to local port 1080
-Client Side: ./client_darwin_amd64 -r "SERVERIP:554" -l ":1080" -mode fast2  // listening on port 1080
+Server Side: ./server_linux_amd64 -t "127.0.0.1:1080" -l ":4000" -mode fast2  // forwarding to local port 1080
+Client Side: ./client_darwin_amd64 -r "SERVERIP:4000" -l ":1080" -mode fast2  // listening on port 1080
 ```
 
 ### *Performance* :lollipop:
@@ -40,25 +40,94 @@ Client Side: ./client_darwin_amd64 -r "SERVERIP:554" -l ":1080" -mode fast2  //
 * WIFI: 5GHz TL-WDR3320
 
 ### *Usage* :lollipop:
-![client](client.png)
-![server](server.png)
+```
+$ ./client_darwin_amd64 -h
+NAME:
+   kcptun - kcptun client
+
+USAGE:
+   client_darwin_amd64 [global options] command [command options] [arguments...]
+
+VERSION:
+   20160811
+
+COMMANDS:
+     help, h  Shows a list of commands or help for one command
+
+GLOBAL OPTIONS:
+   --localaddr value, -l value   local listen address (default: ":12948")
+   --remoteaddr value, -r value  kcp server address (default: "vps:29900")
+   --key value                   key for communcation, must be the same as kcptun server (default: "it's a secrect") [$KCPTUN_KEY]
+   --crypt value                 methods for encryption: aes, tea, xor, none (default: "aes")
+   --mode value                  mode for communication: fast3, fast2, fast, normal (default: "fast")
+   --conn value                  establish N physical connections as specified by 'conn' to server (default: 1)
+   --mtu value                   set MTU of UDP packets, suggest 'tracepath' to discover path mtu (default: 1350)
+   --sndwnd value                set send window size(num of packets) (default: 128)
+   --rcvwnd value                set receive window size(num of packets) (default: 1024)
+   --nocomp                      disable compression
+   --datashard value             set reed-solomon erasure coding - datashard (default: 10)
+   --parityshard value           set reed-solomon erasure coding - parityshard (default: 3)
+   --dscp value                  set DSCP(6bit) (default: 0)
+   --help, -h                    show help
+   --version, -v                 print the version
+```
+
+```
+$ ./server_darwin_amd64 -h
+NAME:
+   kcptun - kcptun server
+
+USAGE:
+   server_darwin_amd64 [global options] command [command options] [arguments...]
+
+VERSION:
+   20160811
+
+COMMANDS:
+     help, h  Shows a list of commands or help for one command
+
+GLOBAL OPTIONS:
+   --listen value, -l value  kcp server listen address (default: ":29900")
+   --target value, -t value  target server address (default: "127.0.0.1:12948")
+   --key value               key for communcation, must be the same as kcptun client (default: "it's a secrect") [$KCPTUN_KEY]
+   --crypt value             methods for encryption: aes, tea, xor, none (default: "aes")
+   --mode value              mode for communication: fast3, fast2, fast, normal (default: "fast")
+   --mtu value               set MTU of UDP packets, suggest 'tracepath' to discover path mtu (default: 1350)
+   --sndwnd value            set send window size(num of packets) (default: 1024)
+   --rcvwnd value            set receive window size(num of packets) (default: 1024)
+   --nocomp                  disable compression
+   --datashard value         set reed-solomon erasure coding - datashard (default: 10)
+   --parityshard value       set reed-solomon erasure coding - parityshard (default: 3)
+   --dscp value              set DSCP(6bit) (default: 0)
+   --help, -h                show help
+   --version, -v             print the version
+```
 
 ### *Applications* :lollipop:   
 1. Real-time gaming.
 2. Cross-ISP data exchange in PRC.
 3. Other lossy network.
 
-### *Parameters Recommended* :lollipop: 
-```
-Test Environment: China Telecom 100M ADSL(100mbps up/8mbps down)
-SERVER:   -mtu 1400 -sndwnd 2048 -rcvwnd 2048 -mode fast2
-CLIENT:   -mtu 1400 -sndwnd 256 -rcvwnd 2048 -mode fast2 -dscp 46
-```
+### *Parameters* :lollipop: 
+***Both sides must agree on the following parameters:***
+* datashard
+* parityshard
+* nocomp
+* key
+* crypt
+
+other parameters can be set independently.
 
 *How to optimize*：
 > Step 1：Increase client rcvwnd & server sndwnd simultaneously & gradually。       
 > Step 2：Try download something and observer, if the bandwidth usage is close the limit then stop, otherwise goto step 1.     
 
+***NOTICE: if too much retranmission happens, it's quite possible the windows are too large***
+
+### *Memory Control* :lollipop: 
+Routers, mobile devices are sensitive to memory consumption; by setting GOGC environment(eg: GOGC=20) will lower memory consumption.
+Reference: https://blog.golang.org/go15gc
+
 ### *Traffic Control* :lollipop: 
 ***Intended audience : for those server's bandwidth is quite limited.***      
 

README.md

@@ -1,5 +1,5 @@
 # <img src="logo.png" alt="kcptun" height="60px" /> 
-[![GoDoc][1]][2] [![Release][13]][14] [![Powered][17]][18] [![Build Status][3]][4] [![Go Report Card][5]][6] [![Downloads][15]][16] [![Gitter][19]][20]
+[![GoDoc][1]][2] [![Release][13]][14] [![Powered][17]][18] [![MIT licensed][11]][12] [![Build Status][3]][4] [![Go Report Card][5]][6] [![Downloads][15]][16] [![Gitter][19]][20]
 [1]: https://godoc.org/github.com/xtaci/kcptun?status.svg
 [2]: https://godoc.org/github.com/xtaci/kcptun
 [3]: https://travis-ci.org/xtaci/kcptun.svg?branch=master
@@ -8,10 +8,8 @@
 [6]: https://goreportcard.com/report/github.com/xtaci/kcptun
 [7]: https://img.shields.io/badge/license-MIT-blue.svg
 [8]: https://raw.githubusercontent.com/xtaci/kcptun/master/LICENSE.md
-[9]: https://img.shields.io/github/stars/xtaci/kcptun.svg
-[10]: https://github.com/xtaci/kcptun/stargazers
-[11]: https://img.shields.io/github/forks/xtaci/kcptun.svg
-[12]: https://github.com/xtaci/kcptun/network
+[11]: https://img.shields.io/badge/license-MIT-blue.svg
+[12]: LICENSE.md
 [13]: https://img.shields.io/github/release/xtaci/kcptun.svg
 [14]: https://github.com/xtaci/kcptun/releases/latest
 [15]: https://img.shields.io/github/downloads/xtaci/kcptun/total.svg?maxAge=1800
@@ -27,8 +25,8 @@
 [English Readme](README.en.md)
 ### *快速设定* :lollipop:
 ```
-服务器: ./server_linux_amd64 -t "127.0.0.1:8388" -l ":554" -mode fast2  // 转发到服务器的本地8388端口
-客户端: ./client_darwin_amd64 -r "服务器IP地址:554" -l ":8388" -mode fast2    // 监听客户端的本地8388端口
+服务器: ./server_linux_amd64 -t "127.0.0.1:8388" -l ":4000" -mode fast2  // 转发到服务器的本地8388端口
+客户端: ./client_darwin_amd64 -r "服务器IP地址:4000" -l ":8388" -mode fast2    // 监听客户端的本地8388端口
 注: 服务器端需要有服务监听8388端口
 ```
 
@@ -40,24 +38,85 @@
 
 ### *使用方法* :lollipop:
 在Mac OS X El Capitan下的帮助输出: 
-
-![client](client.png)
-![server](server.png)
-
-### *推荐参数* :lollipop: 
 ```
-适用大部分ADSL接入（非对称上下行）的参数（实验环境电信100M ADSL）
-其它带宽请按比例调整，比如 50M ADSL，把 CLIENT 的 -sndwnd -rcvwnd 减掉一半，SERVER 不变
+$ ./client_darwin_amd64 -h
+NAME:
+   kcptun - kcptun client
 
-SERVER:   -mtu 1400 -sndwnd 2048 -rcvwnd 2048 -mode fast2
-CLIENT:   -mtu 1400 -sndwnd 256 -rcvwnd 2048 -mode fast2 -dscp 46
-*巭孬嫑乱动* 
+USAGE:
+   client_darwin_amd64 [global options] command [command options] [arguments...]
+
+VERSION:
+   20160811
+
+COMMANDS:
+     help, h  Shows a list of commands or help for one command
+
+GLOBAL OPTIONS:
+   --localaddr value, -l value   local listen address (default: ":12948")
+   --remoteaddr value, -r value  kcp server address (default: "vps:29900")
+   --key value                   key for communcation, must be the same as kcptun server (default: "it's a secrect") [$KCPTUN_KEY]
+   --crypt value                 methods for encryption: aes, tea, xor, none (default: "aes")
+   --mode value                  mode for communication: fast3, fast2, fast, normal (default: "fast")
+   --conn value                  establish N physical connections as specified by 'conn' to server (default: 1)
+   --mtu value                   set MTU of UDP packets, suggest 'tracepath' to discover path mtu (default: 1350)
+   --sndwnd value                set send window size(num of packets) (default: 128)
+   --rcvwnd value                set receive window size(num of packets) (default: 1024)
+   --nocomp                      disable compression
+   --datashard value             set reed-solomon erasure coding - datashard (default: 10)
+   --parityshard value           set reed-solomon erasure coding - parityshard (default: 3)
+   --dscp value                  set DSCP(6bit) (default: 0)
+   --help, -h                    show help
+   --version, -v                 print the version
 ```
 
+```
+$ ./server_darwin_amd64 -h
+NAME:
+   kcptun - kcptun server
+
+USAGE:
+   server_darwin_amd64 [global options] command [command options] [arguments...]
+
+VERSION:
+   20160811
+
+COMMANDS:
+     help, h  Shows a list of commands or help for one command
+
+GLOBAL OPTIONS:
+   --listen value, -l value  kcp server listen address (default: ":29900")
+   --target value, -t value  target server address (default: "127.0.0.1:12948")
+   --key value               key for communcation, must be the same as kcptun client (default: "it's a secrect") [$KCPTUN_KEY]
+   --crypt value             methods for encryption: aes, tea, xor, none (default: "aes")
+   --mode value              mode for communication: fast3, fast2, fast, normal (default: "fast")
+   --mtu value               set MTU of UDP packets, suggest 'tracepath' to discover path mtu (default: 1350)
+   --sndwnd value            set send window size(num of packets) (default: 1024)
+   --rcvwnd value            set receive window size(num of packets) (default: 1024)
+   --nocomp                  disable compression
+   --datashard value         set reed-solomon erasure coding - datashard (default: 10)
+   --parityshard value       set reed-solomon erasure coding - parityshard (default: 3)
+   --dscp value              set DSCP(6bit) (default: 0)
+   --help, -h                show help
+   --version, -v             print the version
+```
+
+### *参数调整* :lollipop: 
+***两端参数必须一致的有:***
+* datashard
+* parityshard
+* nocomp
+* key
+* crypt
+
+其余为两边可独立设定的参数
+
 *简易自我调优方法*：
 > 第一步：同时在两端逐步增大client rcvwnd和server sndwnd;        
 > 第二步：尝试下载，观察如果带宽利用率（服务器＋客户端两端都要观察）接近物理带宽则停止，否则跳转到第一步。
 
+***注意：产生大量重传时，一定是窗口偏大了***
+
 *带宽计算公式*：
 ```
 在不丢包的情况下，有最大-rcvwnd 个数据包在网络上正在向你传输，以平均数据包大小avgsize计算，在任意时刻，有：     
@@ -83,6 +142,10 @@ CLIENT:   -mtu 1400 -sndwnd 256 -rcvwnd 2048 -mode fast2 -dscp 46
 		max_bandwidth_fec = max_bandwidth * (10 + 3) /10 = 1.3*max_bandwidth ＝ 1.3 * 25Mbps = 32.5Mbps
 ```
 
+### *内存控制* :lollipop: 
+路由器，手机等嵌入式设备通常对内存用量敏感，通过调节环境变量GOGC（例如GOGC=20)后启动client，可以降低内存使用。      
+参考：https://blog.golang.org/go15gc
+
 ### *流量控制* :lollipop: 
 ***必要性: 针对流量敏感的服务器，做双保险。***      
 
@@ -188,7 +251,7 @@ type Snmp struct {
 
 对该项目的捐款将用于[gonet/2](http://gonet2.github.io/)游戏服务器框架的研发。     
 
-> 特别感谢: 郑H立, 南D风, Li, 七q, 凌J，昶，Les*ables 等，名字已做特殊处理。
+```特别感谢: 郑H立, 南D风, Li, 七q, 凌J，昶，Les*ables, Ky*n, 噼**啦, 等，名字已做特殊处理。```
 
 ### *参考资料* :paperclip:
 1. https://github.com/skywind3000/kcp -- KCP - A Fast and Reliable ARQ Protocol.

client/main.go

@@ -87,6 +87,10 @@ func checkError(err error) {
 
 func main() {
 	rand.Seed(int64(time.Now().Nanosecond()))
+	if VERSION == "SELFBUILD" {
+		// add more log flags for debugging
+		log.SetFlags(log.LstdFlags | log.Lshortfile)
+	}
 	myApp := cli.NewApp()
 	myApp.Name = "kcptun"
 	myApp.Usage = "kcptun client"
@@ -111,7 +115,7 @@ func main() {
 		cli.StringFlag{
 			Name:  "crypt",
 			Value: "aes",
-			Usage: "methods for encryption: aes, tea, xor, none",
+			Usage: "methods for encryption: aes, aes-128, aes-192, tea, xor, none",
 		},
 		cli.StringFlag{
 			Name:  "mode",
@@ -224,6 +228,10 @@ func main() {
 			block, _ = kcp.NewSimpleXORBlockCrypt(pass)
 		case "none":
 			block, _ = kcp.NewNoneBlockCrypt(pass)
+		case "aes-128":
+			block, _ = kcp.NewAESBlockCrypt(pass[:16])
+		case "aes-192":
+			block, _ = kcp.NewAESBlockCrypt(pass[:24])
 		default:
 			block, _ = kcp.NewAESBlockCrypt(pass)
 		}
@@ -248,6 +256,14 @@ func main() {
 		log.Println("keepalive:", keepalive)
 		log.Println("conn:", conn)
 
+		config := &yamux.Config{
+			AcceptBacklog:          256,
+			EnableKeepAlive:        true,
+			KeepAliveInterval:      30 * time.Second,
+			ConnectionWriteTimeout: 30 * time.Second,
+			MaxStreamWindowSize:    uint32(sockbuf),
+			LogOutput:              os.Stderr,
+		}
 		createConn := func() *yamux.Session {
 			kcpconn, err := kcp.DialWithOptions(remoteaddr, block, datashard, parityshard)
 			checkError(err)
@@ -269,14 +285,6 @@ func main() {
 			}
 
 			// stream multiplex
-			config := &yamux.Config{
-				AcceptBacklog:          256,
-				EnableKeepAlive:        true,
-				KeepAliveInterval:      30 * time.Second,
-				ConnectionWriteTimeout: 30 * time.Second,
-				MaxStreamWindowSize:    16777216,
-				LogOutput:              os.Stderr,
-			}
 			var session *yamux.Session
 			if nocomp {
 				session, err = yamux.Client(kcpconn, config)
@@ -302,8 +310,8 @@ func main() {
 			if err != nil { // yamux failure
 				log.Println(err)
 				p1.Close()
-				mux.Close()
 				muxes[rr%numconn] = createConn()
+				mux.Close()
 				continue
 			}
 			go handleClient(p1, p2)

server/main.go

@@ -53,23 +53,13 @@ func newCompStream(conn net.Conn) *compStream {
 }
 
 // handle multiplex-ed connection
-func handleMux(conn io.ReadWriteCloser, target string) {
+func handleMux(conn io.ReadWriteCloser, target string, config *yamux.Config) {
 	// stream multiplex
-	var mux *yamux.Session
-	config := &yamux.Config{
-		AcceptBacklog:          256,
-		EnableKeepAlive:        true,
-		KeepAliveInterval:      30 * time.Second,
-		ConnectionWriteTimeout: 30 * time.Second,
-		MaxStreamWindowSize:    16777216,
-		LogOutput:              os.Stderr,
-	}
-	m, err := yamux.Server(conn, config)
+	mux, err := yamux.Server(conn, config)
 	if err != nil {
 		log.Println(err)
 		return
 	}
-	mux = m
 	defer mux.Close()
 
 	for {
@@ -115,6 +105,10 @@ func handleClient(p1, p2 io.ReadWriteCloser) {
 
 func main() {
 	rand.Seed(int64(time.Now().Nanosecond()))
+	if VERSION == "SELFBUILD" {
+		// add more log flags for debugging
+		log.SetFlags(log.LstdFlags | log.Lshortfile)
+	}
 	myApp := cli.NewApp()
 	myApp.Name = "kcptun"
 	myApp.Usage = "kcptun server"
@@ -139,7 +133,7 @@ func main() {
 		cli.StringFlag{
 			Name:  "crypt",
 			Value: "aes",
-			Usage: "methods for encryption: aes, tea, xor, none",
+			Usage: "methods for encryption: aes, aes-128, aes-192, tea, xor, none",
 		},
 		cli.StringFlag{
 			Name:  "mode",
@@ -240,6 +234,10 @@ func main() {
 			block, _ = kcp.NewSimpleXORBlockCrypt(pass)
 		case "none":
 			block, _ = kcp.NewNoneBlockCrypt(pass)
+		case "aes-128":
+			block, _ = kcp.NewAESBlockCrypt(pass[:16])
+		case "aes-192":
+			block, _ = kcp.NewAESBlockCrypt(pass[:24])
 		default:
 			block, _ = kcp.NewAESBlockCrypt(pass)
 		}
@@ -276,7 +274,14 @@ func main() {
 		if err := lis.SetWriteBuffer(sockbuf); err != nil {
 			log.Println("SetWriteBuffer:", err)
 		}
-
+		config := &yamux.Config{
+			AcceptBacklog:          256,
+			EnableKeepAlive:        true,
+			KeepAliveInterval:      30 * time.Second,
+			ConnectionWriteTimeout: 30 * time.Second,
+			MaxStreamWindowSize:    uint32(sockbuf),
+			LogOutput:              os.Stderr,
+		}
 		for {
 			if conn, err := lis.Accept(); err == nil {
 				log.Println("remote address:", conn.RemoteAddr())
@@ -288,9 +293,9 @@ func main() {
 				conn.SetKeepAlive(keepalive)
 
 				if nocomp {
-					go handleMux(conn, target)
+					go handleMux(conn, target, config)
 				} else {
-					go handleMux(newCompStream(conn), target)
+					go handleMux(newCompStream(conn), target, config)
 				}
 			} else {
 				log.Println(err)