插件说明和示例

本代码运行在特定端口用于监听frp的RPC消息并进行处理，包括通知用户frp连接信息和阻止特定IP段登录的功能。

frp-client登录时（Login），插件会发送以下消息

frp-client登录
frp版本：0.33.0
主机ID：23d28e11011b3344
主机名：
系统类型：linux
系统架构：amd64
登录时间：2020-07-09 18:34:36
连接池大小：5

frp-client创建代理时（NewProxy），插件会发送以下消息

frp-client建立穿透代理
主机ID：23d28e11011b3344
代理名称：ssh_room02
代理类型：tcp
远程端口：8001

用户尝试连接内网机器时（NewUserConn），插件会发送以下消息

用户连接内网机器
内网主机ID：23d28e11011b3344
代理名称：ssh_room02
代理类型：tcp
登录时间：2020-07-09 18:39:01
用户IP和端口：202.103.44.150:63017
用户位置：湖北省武汉市 电信
允许用户连接：是

若用户IP在拒绝名单，则返回False，被拒绝连接的用户在终端显示如下信息：

zfb@super-pc:~/$ ssh -p 8001 [email protected]
kex_exchange_identification: Connection closed by remote host
zfb@super-pc:~/$

1. frp服务端插件开发

frp服务端插件的工作原理见server_plugin.md。简单来说就是我们创建的插件需要提供一个web服务，frp会在收到指定操作时把相关信息通过POST请求来发送给特定的url，而插件收到请求后可以根据内容来决定frp如何处理相关操作。若文件frps.ini添加以下内容

[plugin.frp-info]
addr = 127.0.0.1:6666
path = /handler
ops = Login,NewProxy,NewWorkConn,NewUserConn

这表明frp会在收到Login, NewProxy, NewWorkConn, NewUserConn中的任意一种操作时将该操作的相关信息发送给插件，由插件决定是否进行下一步操作，插件的工作步骤如下：

监听127.0.0.1:6666
创建/handler路由
接收frp的post请求发来的json数据
根据数据决定返回值
返回json数据

示例中的监听端口、路由名称、操作类型均可以自定义，开发插件也可以使用任何喜欢的编程语言，由于本人对Go语言不甚熟悉，所以采用python编写代码

2. frp-info插件使用说明

修改frps.ini文件,添加以下内容

[plugin.frp-info]
addr = 127.0.0.1:6666
path = /handler
ops = Login,NewProxy,NewWorkConn,NewUserConn

修改uwsgi_frp-info.ini文件来配置uwsgi启动参数，保证http监听端口与步骤1设置一致
更改config.py来修改flask安全秘钥以及钉钉群机器人的安全秘钥和接口秘钥和IP名单

注意：SSH_IP_ALLOW如果设置为list，则无法在运行过程中自动载入新的ip；如果设置为文件名称，则可以实现动态的实时ip添加
只需要用户在本机使用GET访问链接（一般直接点击即可）
http://12.34.56.78:6666/auth/fHfuglg_RpLHJBcXDZTYTDHG_ydyydYCYFCcxFFcgx_cJnbVBMjhDSweq_ryiutHG?token=wqfK3JQ7Re2JngWpqtd2C542890tewkvslGDJVifvjFfindPf6xmdCGwYoJejhKwPfqqo
其中12.34.56.78是运行frps的主机IP，6666是本插件的监听端口，token的值是在config.py中配置的验证字符串AUTH_STR
为了减少被扫描的风险，最好自己修改/auth/后面的路径以及AUTH_STR的内容

3. 使用docker运行

3.1 不使用uwsgi

docker 使用方式及注意事项

插件默认监听容器的6666端口（需要与宿主机的frps.ini设置的插件端口匹配，可以使用-p映射到宿主机的任意端口）
修改并配置自己的config.py文件，可以使用-v映射到容器的/frp/app/config.py文件
注意config.py中的文件路径是容器内的路径，不是宿主机的路径

docker使用示例

# -u 指定用户和组，否则容器内的文件权限可能有问题
# -v 映射目录 -p 映射端口
# 注意设置 config.py 的 SSH_IP_ALLOW="/frp/allow.txt"
docker run -itd --restart always --name frp_info \
 -u $(id -u):$(id -g) \
 -v path/to/config.py:/frp/app/config.py \
 -v path/to/allow.txt:/frp/allow.txt \
 -p 15666:6666 whuzfb/frp_info:latest

3.2 使用uwsgi

docker 使用方式及注意事项

插件默认监听容器的6666端口（uwsgi监听，需要与宿主机的frps.ini设置的插件端口匹配，可以使用-p映射到宿主机的任意端口）
修改并配置自己的config.py文件，可以使用-v映射到容器的/frp/app/config.py文件
注意config.py中的文件路径是容器内的路径，不是宿主机的路径
插件默认使用uwsgi作为web服务，可以使用-v映射自己的配置文件到容器的/frp/uwsgi_frp-info.ini文件来修改参数（建议保持默认）

docker使用示例

# -u 指定用户和组，否则容器内的文件权限可能有问题
# -v 映射目录 -p 映射端口
# 注意设置 config.py 的 SSH_IP_ALLOW="/frp/allow.txt"
docker run -itd --restart always --name frp_info \
 -u $(id -u):$(id -g) \
 -v path/to/config.py:/frp/app/config.py \
 -v path/to/allow.txt:/frp/allow.txt \
 -p 15666:6666 whuzfb/frp_info:uwsgi

需要修改什么文件都可以添加映射，容器内的/frp目录即为项目的根目录
下面是容器内项目结构

/frp  
├── allow.txt
├── app
│   ├── config.py
│   ├── controller
│   │   ├── __init__.py
│   │   └── main.py
│   ├── __init__.py
│   └── model
│       ├── DingTalkBot.py
│       ├── HandleFrpMsg.py
│       ├── __init__.py
│       └── SSHFilter.py
├── Dockerfile
├── log.py
├── requirements.txt
├── restart.sh
└── runserver.py

4. 本地手动运行

4.1 创建虚拟环境

插件基于python3编写，搭建flask服务（运行在虚拟环境），在当前项目主目录下创建虚拟环境并安装库：

#! /bin/bash
# 自动安装venv管理虚拟环境
sudo apt-get install python3-venv -y
# 创建虚拟环境venv
python3 -m venv venv
# 激活虚拟环境并安装库
source venv/bin/activate && pip install  -r requirements.txt && deactivate

4.2 运行代码

然后在项目主目录下输入以下命令测试启动uwsgi及插件frp-info：
source venv/bin/activate && uwsgi --ini uwsgi_frp-info.ini -d /dev/null && deactivate
此时可通过cat ./log/frp-info.log查看日志，或通过lsof -i:6666查看端口占用
最后重启frps服务service frps restart即可实现插件的安装配置

4.3 添加插件自启动

修改frp-info.service文件的uwsgi路径和配置文件路径为本机的路径，修改用户为本机的用户名

[Unit]
Description=Frp-info service
After=network.target

[Service]
Type=simple
User=ubuntu
Restart=on-failure
RestartSec=5s
WorkingDirectory=/home/ubuntu/frp-info
ExecStart=/home/ubuntu/frp-info/venv/bin/uwsgi --ini /home/ubuntu/frp-info/uwsgi_frp-info.ini

[Install]
WantedBy=multi-user.target

然后将此文件移动到系统服务目录：sudo mv ./frp-info.service /etc/systemd/system/
启动开机自启功能：systemctl enable frp-info
手动运行服务：service frp-info start
则所有配置完成，插件已正常工作，若重新启动系统，则frps和frp-info的service都会启动

4.4 服务管理的命令

重载服务后台（手动修改service文件后执行）：sudo systemctl daemon-reload
关闭服务：service frp-info stop
手动重启服务：service frp-info restart
查看开机自启的服务：systemctl list-unit-files --type=service|grep enabled

ubuntu@VM-16-13-ubuntu:~/$ systemctl status frp-info.service
● frp-info.service - Frp-info service
   Loaded: loaded (/etc/systemd/system/frp-info.service; enabled; vendor preset: enabled)
   Active: active (running) since Wed 2020-07-08 23:33:29 CST; 4min 41s ago
 Main PID: 5040 (uwsgi)
    Tasks: 14 (limit: 2122)
   CGroup: /system.slice/frp-info.service
           ├─5040 /home/ubuntu/frp-info/venv/bin/uwsgi --ini /home/ubuntu/frp-info/uwsgi_frp-info.ini
           ├─5057 /home/ubuntu/frp-info/venv/bin/uwsgi --ini /home/ubuntu/frp-info/uwsgi_frp-info.ini
           ├─5058 /home/ubuntu/frp-info/venv/bin/uwsgi --ini /home/ubuntu/frp-info/uwsgi_frp-info.ini
           ├─5059 /home/ubuntu/frp-info/venv/bin/uwsgi --ini /home/ubuntu/frp-info/uwsgi_frp-info.ini
           ├─5060 /home/ubuntu/frp-info/venv/bin/uwsgi --ini /home/ubuntu/frp-info/uwsgi_frp-info.ini
           └─5063 /home/ubuntu/frp-info/venv/bin/uwsgi --ini /home/ubuntu/frp-info/uwsgi_frp-info.ini

Jul 08 23:35:43 VM-16-13-ubuntu uwsgi[5040]: [pid: 5059|app: 0|req: 3/13] 127.0.0.1 () {34 vars in ...
ubuntu@VM-16-13-ubuntu:~/$

如何使用此插件限制frp的连接

文件app/config.py中的主要内容和解释如下：

# no表示不过滤IP，允许所有的IP，此时忽略SSH_IP_BLOCK、SSH_IP_ALLOW
# allow表示允许名单模式，只有SSH_IP_ALLOW允许访问，此时忽略SSH_IP_BLOCK
# block表示禁止名单模式，只有SSH_IP_BLOCK禁止访问，此时忽略SSH_IP_ALLOW
SSH_IP_MODE = 'no'
# 每个IP都用字符串表示；支持子网掩码格式，如192.168.0.0/28
# SSH_IP_ALLOW和SSH_IP_BLOCK可以写成list，也可写成文件的绝对路径
# SSH_IP_ALLOW = ["202.114.12.11", "192.168.0.0/28"]
# allow.txt文件内容示例（每个IP占一行，不需要引号）
# 202.114.12.11
# 192.168.0.0/28
SSH_IP_ALLOW = "/home/zfb/frp-info/allow.txt"
SSH_IP_BLOCK = []

常见问题

如何修改服务监听端口（默认为6666）？
修改frps.ini的plugin.frp-info部分的addr字段设置的端口；再修改uwsgi_frp-info.ini的http字段设置的端口，重新启动程序即可
无法正常使用service管理？
查看/etc/systemd/system/frp-info.service文件是否存在；确保User字段设置为本机用户名（防止权限问题），WorkingDirectory和ExecStart的路径与本机的路径一致
只想查看frp的连接信息，不需要ip过滤功能？
建议使用frp-notify。事实上，我最初也是用的此插件，想要添加过滤一些IP的功能，但是由于对Go语言不熟悉，所以就自己动手写了一个使用Python的插件

Name		Name	Last commit message	Last commit date
Latest commit History 20 Commits
.github/workflows		.github/workflows
app		app
.dockerignore		.dockerignore
.gitignore		.gitignore
Dockerfile		Dockerfile
LICENSE		LICENSE
README.md		README.md
allow.txt		allow.txt
entrypoint.sh		entrypoint.sh
frp-info.service		frp-info.service
log.py		log.py
requirements.txt		requirements.txt
restart.sh		restart.sh
runserver.py		runserver.py
uwsgi.Dockerfile		uwsgi.Dockerfile
uwsgi_frp-info.ini		uwsgi_frp-info.ini

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

插件说明和示例

1. frp服务端插件开发

2. frp-info插件使用说明

3. 使用docker运行

3.1 不使用uwsgi

3.2 使用uwsgi

4. 本地手动运行

4.1 创建虚拟环境

4.2 运行代码

4.3 添加插件自启动

4.4 服务管理的命令

如何使用此插件限制frp的连接

常见问题

About

Releases 6

Packages

Contributors 2

Languages

License

zfb132/frp_info

Folders and files

Latest commit

History

Repository files navigation

插件说明和示例

1. frp服务端插件开发

2. frp-info插件使用说明

3. 使用docker运行

3.1 不使用uwsgi

3.2 使用uwsgi

4. 本地手动运行

4.1 创建虚拟环境

4.2 运行代码

4.3 添加插件自启动

4.4 服务管理的命令

如何使用此插件限制frp的连接

常见问题

About

Resources

License

Stars

Watchers

Forks

Releases 6

Packages 0

Contributors 2

Languages

Packages