feat: add ssh doc (#72)

Co-authored-by: Author Name <int7>

content/zh-cn/docs/Features/common/ssh.md

@@ -0,0 +1,190 @@
+---
+title: "SSH Tunnel Gateway"
+weight: 50
+---
+
+## 概念
+SSH 支持反向代理能力[链接](https://www.rfc-editor.org/rfc/rfc4254#page-16)。
+
+frp 支持在 frps 端监听一个 ssh 端口，通过走 ssh -R 协议来完成 TCP 协议代理，该模式下不需要依赖 frpc。
+
+SSH 反向隧道代理和通过 frp 代理 SSH 端口是不同的2个概念。SSH 反向隧道代理本质上是在你不想使用 frpc 的时候，通过 ssh client 连接 frps 来完成基本的反向代理。
+
+
+
+## 参数
+
+
+```toml
+# frps.toml
+
+sshTunnelGateway.bindPort = 0
+sshTunnelGateway.privateKeyFile = ""
+sshTunnelGateway.autoGenPrivateKeyPath = ""
+sshTunnelGateway.authorizedKeysFile = ""
+```
+
+| Field | Type | Description | Required |
+| :--- | :--- | :--- | :--- |
+| bindPort| int | frps 监听的 ssh server 端口。| YES |
+| privateKeyFile | string | 默认为空。ssh server 使用的私钥文件，为空frps会读取 autoGenPrivateKeyPath 路径下的私钥文件。可复用本地 /home/user/.ssh/id_rsa 文件或自定义路径。| No |
+| autoGenPrivateKeyPath  | string |默认为 ./.autogen_ssh_key。文件不存在或内容为空，frps会自动生成 RSA 私钥文件内容存入该文件。|No|
+| authorizedKeysFile  | string |默认为空。空不对ssh客户端进行鉴权认证。不空可实现ssh免密登录认证，可复用本地 /home/user/.ssh/authorized_keys 文件或自定义路径。| No |
+
+
+
+## 基本使用
+### 服务端 frps
+最简配置
+
+```toml
+sshTunnelGateway.bindPort = 2200
+```
+
+将上述配置放入 frps.toml, 运行 ./frps -c frps.toml，此时会在2200的端口监听，接受 ssh 反向代理的请求。
+
+注意：
+1. 使用最简配置，会在当前运行目录自动创建一个 .autogen_ssh_key 的私钥文件，frps 的 ssh server 会使用到该私钥文件，用来加解密数据。也可以复用本地已有的私钥文件，如 /home/user/.ssh/id_rsa.
+
+2. 最简配置模式下运行的frps，通过 ssh 连接 frps 是不鉴权的，强烈建议 frps 配置 token，在 ssh 命令行指定 token。
+
+
+
+### 客户端 ssh
+命令格式为
+
+```
+ssh -R :80:{local_ip:port} v0@{frps address} -p {frps ssh listen port} {tcp|http|https|stcp|tcpmux} --remote_port {real remote port} --proxy_name {proxy_name} --token {frp token}
+
+```
+
+1. --proxy_name 非必填，空会随机生成一个。
+
+2. 登录 frps 的用户名统一为 v0，目前没有任何含义，即 v0@{frps address}。
+
+3. server 端的 proxy 监听的端口由 --remote_port 决定。
+
+4. {tcp|http|https|stcp|tcpmux} 支持的完整命令参数可通过 --help 获取。 如： ssh -R :80::8080 [email protected] -p 2200 http --help
+
+5. token 非必填，为了安全强烈建议在frps配置上token。
+
+
+
+####  TCP 代理
+
+
+> ssh -R :80:127.0.0.1:8080 v0@{frp address} -p 2200 tcp --proxy_name "test-tcp" --remote_port 9090
+
+在 frps 启动一个 9090 的端口代理本地的 8080 服务。
+
+```
+frp (via SSH) (Ctrl+C to quit)
+
+User: 
+ProxyName: test-tcp
+Type: tcp
+RemoteAddress: :9090
+
+```
+
+等同于：
+
+> frpc tcp --proxy_name "test-tcp" --local_ip 127.0.0.1 --local_port 8080 --remote_port 9090
+
+
+更多参数可执行 --help 获取。
+
+
+
+####  HTTP 代理
+
+> ssh -R :80:127.0.0.1:8080 v0@{frp address} -p 2200 http --proxy_name "test-http"  --custom_domain test-http.frps.com 
+
+
+
+等同于
+
+> frpc http --proxy_name "test-http" --custom_domain test-http.frps.com
+
+
+可以通过以下命令访问 http 服务：
+
+curl 'http://test-http.frps.com'
+
+
+更多参数可执行 --help 获取。
+
+
+#### HTTPS/STCP/TCPMUX 代理
+
+通过如下命令获取使用方式：
+
+ssh -R :80:127.0.0.1:8080 v0@{frp address} -p 2200 {https|stcp|tcpmux} --help
+
+
+
+## 高级使用
+
+### 服务端 frps
+
+#### 复用本机的 id_rsa 文件
+
+```toml
+# frps.toml
+
+sshTunnelGateway.bindPort = 2200
+sshTunnelGateway.privateKeyFile = "/home/user/.ssh/id_rsa"
+```
+
+ssh 协议握手阶段需要交换公钥用来加密数据，所以 frps 端的 ssh server 需要指定一个私钥文件，可以复用本机已存在的；如果为空，frps会自动创建一个 rsa 私钥文件。
+
+
+#### 指定自动生成私钥文件地址
+
+```toml
+# frps.toml
+
+sshTunnelGateway.bindPort = 2200
+sshTunnelGateway.autoGenPrivateKeyPath = "/var/frp/ssh-private-key-file"
+```
+
+frps自动创建私钥文件并指定路径存储。
+
+注意：
+frps 更换私钥文件，会导致ssh客户端登录失败，如果需要成功登录，可以删除 /home/user/.ssh/known_hosts 文件。
+
+
+#### 使用本机已存在的 authorized_keys 文件，实现 ssh 免密登录鉴权
+
+```toml
+# frps.toml
+
+sshTunnelGateway.bindPort = 2200
+sshTunnelGateway.authorizedKeysFile = "/home/user/.ssh/authorized_keys"
+```
+
+authorizedKeysFile 是 ssh 免密登录使用的文件，存放用户公钥信息，一行一个。
+
+authorizedKeysFile 为空， frps 不对 ssh 客户端进行任何认证。frps 不支持 ssh 用户名+密码模式认证。
+
+可复用本机已有的 authorized_keys 文件对客户端进行认证。
+
+
+注意：
+authorizedKeysFile 是 ssh 登录阶段的用户认证，token 是 frps 已有的认证，2者没有关联，ssh认证在前，frps 认证 token 在后，强烈建议至少开启1个，如果 authorizedKeysFile 为空，强烈建议 frps 端开启 token 认证，否则有安全风险。
+
+
+#### 使用自定义的 authorized_keys 文件，实现 ssh 免密登录鉴权
+
+```toml
+# frps.toml
+
+sshTunnelGateway.bindPort = 2200
+sshTunnelGateway.authorizedKeysFile = "/var/frps/custom_authorized_keys_file"
+```
+
+自定义 authorized_keys 文件路径。
+
+authorizedKeysFile 文件变动可能会导致 ssh 登录认证失败，可能需要重新将公钥信息放入 authorizedKeysFile。
+
+

content/zh-cn/docs/Reference/server-configures.md

@@ -79,3 +79,11 @@ description: >
 | path | string | 插件接口的 Path。 | Yes |
 | ops | []string | 插件需要生效的操作列表，具体可选值请参考服务端插件的说明文档。 | Yes |
 | tlsVerify | bool | 当插件地址为 HTTPS 协议时，是否校验插件的 TLS 证书，默认为不校验。 | No |
+
+### SSHTunnelGateway
+| Field | Type | Description | Required |
+| :--- | :--- | :--- | :--- |
+| bindPort| int | SSH 服务器监听端口。| YES |
+| privateKeyFile | string | SSH 服务器私钥文件路径。若为空，frps将读取autoGenPrivateKeyPath路径下的私钥文件。| No |
+| autoGenPrivateKeyPath  | string |私钥文件自动生成路径，默认为./.autogen_ssh_key。若文件不存在或内容为空，frps将自动生成RSA私钥文件并存储到该路径。|No|
+| authorizedKeysFile  | string |SSH 客户端授权密钥文件路径。若为空，则不进行SSH客户端鉴权认证。非空可实现SSH免密登录认证。| No |