mirror of
https://github.com/fatedier/frp.git
synced 2024-12-12 17:50:51 +01:00
172 lines
3.4 KiB
Markdown
172 lines
3.4 KiB
Markdown
|
### 服务端管理插件
|
||
|
|
||
|
frp 管理插件的作用是在不侵入自身代码的前提下,扩展 frp 服务端的能力。
|
||
|
|
||
|
frp 管理插件会以单独进程的形式运行,并且监听在一个端口上,对外提供 RPC 接口,响应 frps 的请求。
|
||
|
|
||
|
frps 在执行某些操作前,会根据配置向管理插件发送 RPC 请求,根据管理插件的响应来执行相应的操作。
|
||
|
|
||
|
### RPC 请求
|
||
|
|
||
|
管理插件接收到操作请求后,可以给出三种回应。
|
||
|
|
||
|
* 拒绝操作,需要返回拒绝操作的原因。
|
||
|
* 允许操作,不需要修改操作内容。
|
||
|
* 允许操作,对操作请求进行修改后,返回修改后的内容。
|
||
|
|
||
|
### 接口
|
||
|
|
||
|
接口路径可以在 frps 配置中为每个插件单独配置,这里以 `/handler` 为例。
|
||
|
|
||
|
Request
|
||
|
|
||
|
```
|
||
|
POST /handler
|
||
|
{
|
||
|
"version": "0.1.0",
|
||
|
"op": "Login",
|
||
|
"content": {
|
||
|
... // 具体的操作信息
|
||
|
}
|
||
|
}
|
||
|
|
||
|
请求 Header
|
||
|
X-Frp-Reqid: 用于追踪请求
|
||
|
```
|
||
|
|
||
|
Response
|
||
|
|
||
|
非 200 的返回都认为是请求异常。
|
||
|
|
||
|
拒绝执行操作
|
||
|
|
||
|
```
|
||
|
{
|
||
|
"reject": true,
|
||
|
"reject_reason": "invalid user"
|
||
|
}
|
||
|
```
|
||
|
|
||
|
允许且内容不需要变动
|
||
|
|
||
|
```
|
||
|
{
|
||
|
"reject": false,
|
||
|
"unchange": true
|
||
|
}
|
||
|
```
|
||
|
|
||
|
允许且需要替换操作内容
|
||
|
|
||
|
```
|
||
|
{
|
||
|
"unchange": "false",
|
||
|
"content": {
|
||
|
... // 替换后的操作信息,格式必须和请求时的一致
|
||
|
}
|
||
|
}
|
||
|
```
|
||
|
|
||
|
### 操作类型
|
||
|
|
||
|
目前插件支持管理的操作类型有 `Login` 和 `NewProxy`。
|
||
|
|
||
|
#### Login
|
||
|
|
||
|
用户登录操作信息
|
||
|
|
||
|
```
|
||
|
{
|
||
|
"content": {
|
||
|
"version": <string>,
|
||
|
"hostname": <string>,
|
||
|
"os": <string>,
|
||
|
"arch": <string>,
|
||
|
"user": <string>,
|
||
|
"timestamp": <int64>,
|
||
|
"privilege_key": <string>,
|
||
|
"run_id": <string>,
|
||
|
"pool_count": <int>,
|
||
|
"metas": map<string>string
|
||
|
}
|
||
|
}
|
||
|
```
|
||
|
|
||
|
#### NewProxy
|
||
|
|
||
|
创建代理的相关信息
|
||
|
|
||
|
```
|
||
|
{
|
||
|
"content": {
|
||
|
"user": {
|
||
|
"user": <string>,
|
||
|
"metas": map<string>string
|
||
|
},
|
||
|
"proxy_name": <string>,
|
||
|
"proxy_type": <string>,
|
||
|
"use_encryption": <bool>,
|
||
|
"use_compression": <bool>,
|
||
|
"group": <string>,
|
||
|
"group_key": <string>,
|
||
|
|
||
|
// tcp and udp only
|
||
|
"remote_port": <int>,
|
||
|
|
||
|
// http and https only
|
||
|
"custom_domains": []<string>,
|
||
|
"subdomain": <string>,
|
||
|
"locations": <string>,
|
||
|
"http_user": <string>,
|
||
|
"http_pwd": <string>,
|
||
|
"host_header_rewrite": <string>,
|
||
|
"headers": map<string>string,
|
||
|
|
||
|
"metas": map<string>string
|
||
|
}
|
||
|
}
|
||
|
```
|
||
|
|
||
|
### frps 中插件配置
|
||
|
|
||
|
```ini
|
||
|
[common]
|
||
|
bind_port = 7000
|
||
|
|
||
|
[plugin.user-manager]
|
||
|
addr = 127.0.0.1:9000
|
||
|
path = /handler
|
||
|
ops = Login
|
||
|
|
||
|
[plugin.port-manager]
|
||
|
addr = 127.0.0.1:9001
|
||
|
path = /handler
|
||
|
ops = NewProxy
|
||
|
```
|
||
|
|
||
|
addr: 插件监听的网络地址。
|
||
|
path: 插件监听的 HTTP 请求路径。
|
||
|
ops: 插件需要处理的操作列表,多个 op 以英文逗号分隔。
|
||
|
|
||
|
### 元数据
|
||
|
|
||
|
为了减少 frps 的代码修改,同时提高管理插件的扩展能力,在 frpc 的配置文件中引入自定义元数据的概念。元数据会在调用 RPC 请求时发送给插件。
|
||
|
|
||
|
元数据以 `meta_` 开头,可以配置多个,元数据分为两种,一种配置在 `common` 下,一种配置在各个 proxy 中。
|
||
|
|
||
|
```
|
||
|
# frpc.ini
|
||
|
[common]
|
||
|
server_addr = 127.0.0.1
|
||
|
server_port = 7000
|
||
|
user = fake
|
||
|
meta_token = fake
|
||
|
meta_version = 1.0.0
|
||
|
|
||
|
[ssh]
|
||
|
type = tcp
|
||
|
local_port = 22
|
||
|
remote_port = 6000
|
||
|
meta_id = 123
|
||
|
```
|