Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
IrineSistiana committed Nov 23, 2021
1 parent ee2961f commit e0b2960
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 127 deletions.
59 changes: 28 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,9 @@
# simple-tls

[中文](README.md) [English](README_en.md)
一个简单易用的 shadowsocks SIP003 插件。可为原始数据流加一层 TLS。还支持 Websocket 和 mux (连接复用)。

---

- [simple-tls](#simple-tls)
- [参数](#参数)
- [SIP003模式](#sip003模式)
- [Android](#android)

## 参数

```text
Expand All @@ -20,61 +15,67 @@
# 通用参数
-b string
[Host:Port] 监听地址。
[Host:Port] (必需) 监听地址。
-d string
[Host:Port] 目的地地址。
[Host:Port] (必需) 目的地地址。
-auth string
身份验证密码。(可选。客户端和服务端需一致。仅用于过滤扫描流量。)
身份验证密码。客户端和服务端需一致。用于过滤扫描流量。
-ws
使用 Websocket 协议。客户端和服务端需一致。
-ws-path string
Websocket 的 url path。客户端和服务端需一致。
# 客户端参数
# e.g. simple-tls -b 127.0.0.1:1080 -d your_server_ip:1080 -n your.server.name
-mux int
单条 TCP 连接内最大复用的连接数。(默认 0 禁用 mux)
单条 TCP 连接内最大复用的连接数。(默认 0, 禁用 mux)
-n string
服务器证书名。
-no-verify
客户端将不会验证服务端的证书。
客户端将不会验证服务端的证书的合法性。(证书链验证)
-ca string
加载 PEM CA 证书文件。
加载 CA 证书文件。
e.g. -ca ./path/to/my.ca.cert
-cca string
从字符串加载被 base64 编码 (e.g. base64 -w 0 ./my.cert) 的 PEM CA 证书。
e.g. -cca VkRJW...4eGdFbz0K==
-cert-hash string
检查服务器证书的 hash。(文件验证)
# 服务端参数
# e.g. simple-tls -b 0.0.0.0:1080 -d 127.0.0.1:12345 -s -key /path/to/your/key -cert /path/to/your/cert
# -cert 和 -key 可以同时留空,会生成一个临时证书。证书的 Subject Alternate Name 取自 `-n` 参数。
# e.g. simple-tls -b 0.0.0.0:1080 -d 127.0.0.1:12345 -s -n my.test.domain
-s
以服务端运行。
(必需) 以服务端运行。
-cert string
PEM 证书路径。
证书路径。
-key string
PEM 密钥路径。
密钥路径。
-no-tls
禁用 TLS
# 其他参数
-cpu int
最多使用的cpu数。
-fast-open
启用TCP快速开启,仅支持Linux内核4.11+。
启用 tcp fast open,仅支持 Linux 4.11+ 内核
-t int
空闲超时,以秒记 (默认300)。
# 命令
-gen-cert
快速生成一个 Subject Alternate Name 为 `-n` 的 ECC 证书
快速生成一个 Subject Alternate Name 为 `-n` 的 ECC 证书
e.g. simple-tls -gen-cert -n my.test.domain
-hash-cert
计算证书的 hash 值。(用于客户端的 -cert-hash)
e.g. simple-tls -hash-cert ./my.cert
-v
显示目前程序版本
```

## SIP003模式
## SIP003 模式

支持 [SIP003](https://shadowsocks.org/en/wiki/Plugin.html) 插件协议。 以 [shadowsocks-libev](https://github.com/shadowsocks/shadowsocks-libev) 为例:
支持 shadowsocks 的 [SIP003](https://shadowsocks.org/en/wiki/Plugin.html) 插件协议。 以 [shadowsocks-libev](https://github.com/shadowsocks/shadowsocks-libev) 为例:

```shell
ss-server -c config.json --plugin simple-tls --plugin-opts "s;key=/path/to/your/key;cert=/path/to/your/cert"
Expand All @@ -83,14 +84,10 @@ ss-local -c config.json --plugin simple-tls --plugin-opts "n=your.server.certifi

## Android

simple-tls-android 是 [shadowsocks-android](https://github.com/shadowsocks/shadowsocks-android) 的GUI插件,需要先下载 shadowsocks-android。simple-tls-android 同样是开源软件,源代码在 [这里](https://github.com/IrineSistiana/simple-tls-android)

<details><summary><code>屏幕截图</code></summary>

<br>
simple-tls-android 是 [shadowsocks-android](https://github.com/shadowsocks/shadowsocks-android) 的带 GUI 的插件。

![截屏](/assets/simple-tls-android-screenshot.jpg)
目前随 simple-tls 一起发布。可从 release 界面下载。

</details>
simple-tls-android 的源代码在 [这里](https://github.com/IrineSistiana/simple-tls-android)

---
96 changes: 0 additions & 96 deletions README_en.md

This file was deleted.

Binary file removed assets/simple-tls-android-screenshot.jpg
Binary file not shown.

1 comment on commit e0b2960

@IceCodeNew
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

欢迎 WebSocket 回归!

Please sign in to comment.