Skip to content

Commit

Permalink
Update AEAD cipher name in README
Browse files Browse the repository at this point in the history
  • Loading branch information
riobard committed Mar 10, 2017
1 parent 6dfc567 commit 155e12e
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,10 @@ go get -u -v github.com/riobard/go-shadowsocks2

### Server

Start a server listening on port 8488 using `aes-128-gcm` AEAD cipher with password `your-password`.
Start a server listening on port 8488 using `AEAD_CHACHA20_POLY1305` AEAD cipher with password `your-password`.

```sh
go-shadowsocks2 -s ss://aes-128-gcm:your-password@:8488 -verbose
go-shadowsocks2 -s ss://AEAD_CHACHA20_POLY1305:your-password@:8488 -verbose
```


Expand All @@ -39,7 +39,7 @@ connections, and tunnels UDP packets received on port 1080 and port 1081 to 8.8.
respectively.

```sh
go-shadowsocks2 -c ss://aes-128-gcm:your-password@[server_address]:8488 \
go-shadowsocks2 -c ss://AEAD_CHACHA20_POLY1305:your-password@[server_address]:8488 \
-socks :1080 -udptun :1080=8.8.8.8:53,:1081=8.8.4.4:53 -verbose
```

Expand All @@ -57,16 +57,16 @@ A random key is almost always better than a password. Generate a base64url-encod
go-shadowsocks2 -keygen 16
```

Start a server listening on port 8848 using `aes-128-gcm` AEAD cipher with the key generated above.
Start a server listening on port 8848 using `AEAD_AES_128_GCM` AEAD cipher with the key generated above.

```sh
go-shadowsocks2 -s :8488 -cipher aes-128-gcm -key k5yEIX5ciUDpkpdtvZm7zQ== -verbose
go-shadowsocks2 -s :8488 -cipher AEAD_AES_128_GCM -key k5yEIX5ciUDpkpdtvZm7zQ== -verbose
```

And the corresponding client to connect to it.

```sh
go-shadowsocks2 -c [server_address]:8488 -cipher aes-128-gcm -key k5yEIX5ciUDpkpdtvZm7zQ== -verbose
go-shadowsocks2 -c [server_address]:8488 -cipher AEAD_AES_128_GCM -key k5yEIX5ciUDpkpdtvZm7zQ== -verbose
```


Expand All @@ -80,7 +80,7 @@ Start a client listening on port 1082 for redirected TCP connections and port 10
TCP IPv6 connections.

```sh
go-shadowsocks2 -c [server_address]:8488 -cipher aes-128-gcm -key k5yEIX5ciUDpkpdtvZm7zQ== \
go-shadowsocks2 -c [server_address]:8488 -cipher AEAD_AES_128_GCM -key k5yEIX5ciUDpkpdtvZm7zQ== \
-redir :1082 -redir6 :1083
```

Expand All @@ -102,7 +102,7 @@ Start a client on the same machine with the server. The client listens on port 1
and tunnels to localhost:5201 where iperf3 is listening.

```sh
go-shadowsocks2 -c [server_address]:8488 -cipher aes-128-gcm -key k5yEIX5ciUDpkpdtvZm7zQ== \
go-shadowsocks2 -c [server_address]:8488 -cipher AEAD_AES_128_GCM -key k5yEIX5ciUDpkpdtvZm7zQ== \
-tcptun :1090=localhost:5201
```

Expand Down

0 comments on commit 155e12e

Please sign in to comment.