本文来源于官方中文文档
摘要
frp 是一个可用于内网穿透的高性能的反向代理应用,支持 tcp, udp, http, https 协议,利用处于内网或防火墙后的机器,对外网环境提供 http 或 https 服务,对于 http, https 服务支持基于域名的虚拟主机,支持自定义域名绑定,使多个域名可以共用一个80端口,利用处于内网或防火墙后的机器,对外网环境提供 tcp 和 udp 服务,例如在家里通过 ssh 访问处于公司内网环境内的主机
使用示例
根据对应的操作系统及架构,从 Release 页面下载最新版本的程序.
将 frps 及 frps.ini 放到具有公网 IP 的机器上。
将 frpc 及 frpc.ini 放到处于内网环境的机器上。
通过 ssh 访问公司内网机器
1.服务器端,修改 frps.ini 文件,这里使用了最简化的配置:
# frps.ini
[common]
bind_port = 7000
2.启动 frps:
./frps -c ./frps.ini
3.客户端,修改 frpc.ini 文件,假设 frps 所在服务器的公网 IP 为 x.x.x.x
# frpc.ini
[common]
server_addr = x.x.x.x
server_port = 7000
[ssh]
type = tcp
local_ip = 127.0.0.1
local_port = 22
remote_port = 6000
4.启动frpc:
./frpc -c ./frpc.ini
5.通过 ssh 访问内网机器,假设内网用户名为 test:x.x.x.x代表公网IP或域名
ssh -oPort=6000 test@x.x.x.x
通过自定义域名访问部署于内网的 web 服务
有时想要让其他人通过域名访问或者测试我们在本地搭建的 web 服务,但是由于本地机器没有公网 IP,无法将域名解析到本地的机器,通过 frp 就可以实现这一功能,以下示例为 http 服务,https 服务配置方法相同, vhost_http_port 替换为 vhost_https_port, type 设置为 https 即可.
1.服务器端,修改 frps.ini 文件,设置 http 访问端口为 8080:
# frps.ini
[common]
bind_port = 7000
vhost_http_port = 8080
2.启动 frps;
./frps -c ./frps.ini
3.客户端,修改 frpc.ini 文件,假设 frps 所在的服务器的 IP 为 x.x.x.x,local_port 为本地机器上 web 服务对应的端口, 绑定自定义域名:nas.onlycloud.xin
# frpc.ini
[common]
server_addr = x.x.x.x
server_port = 7000
[web]
type = http
local_port = 80
custom_domains = nas.onlycloud.xin
4.启动 frpc:
./frpc -c ./frpc.ini
5.将 nas.onlycloud.xin 的域名 A 记录解析到 IP x.x.x.x,如果服务器已经有对应的域名,也可以将 CNAME 记录解析到服务器原先的域名
6.通过浏览器访问 http://nas.onlycloud.xin:8080 即可访问到处于内网机器上的 web 服务。
转发 DNS 查询请求
DNS 查询请求通常使用 UDP 协议.frp 支持对内网 UDP 服务的穿透.配置方式和 TCP 基本一致.
1.服务器端,修改 frps.ini 文件:
# frps.ini
[common]
bind_port = 7000
2.启动 frps:
./frps -c ./frps.ini
3.客户端,修改 frpc.ini 文件,设置 frps 所在服务器的 IP 为 x.x.x.x,转发到 Google 的 DNS 查询服务器 8.8.8.8 的 udp 53 端口:
# frpc.ini
[common]
server_addr = x.x.x.x
server_port = 7000
[dns]
type = udp
local_ip = 8.8.8.8
local_port = 53
remote_port = 6000
4.启动 frpc:
./frpc -c ./frpc.ini
5.通过 dig 测试 UDP 包转发是否成功,预期会返回 www.google.com 域名的解析结果:
dig @x.x.x.x -p 6000 www.google.com
转发 Unix域套接字
通过 tcp 端口访问内网的 unix域套接字(例如和 docker daemon 通信)
1.服务器端,修改 frps.ini 文件:
# frps.ini
[common]
bind_port = 7000
2.启动 frps:
./frps -c ./frps.ini
3.客户端,启用 unix_domain_socket 插件,配置如下:(插件:unix_domain_socket)
# frpc.ini
[common]
server_addr = x.x.x.x
server_port = 7000
[unix_domain_socket]
type = tcp
remote_port = 6000
plugin = unix_domain_socket
plugin_unix_path = /var/run/docker.sock
4.启动 frpc:
./frpc -c ./frpc.ini
5.通过 curl 命令查看 docker 版本信息
curl http://x.x.x.x:6000/version
对外提供简单的文件访问服务
通过 static_file 插件可以对外提供一个简单的基于 HTTP 的文件访问服务.
1.服务器端,修改 frps.ini 文件:
# frps.ini
[common]
bind_port = 7000
2.启动 frps:
./frps -c ./frps.ini
3.客户端,启用 static_file 插件,配置如下:
# frpc.ini
[common]
server_addr = x.x.x.x
server_port = 7000
[test_static_file]
type = tcp
remote_port = 6000
plugin = static_file
# 要对外暴露的文件目录
plugin_local_path = /tmp/file
# 访问 url 中会被去除的前缀,保留的内容即为要访问的文件路径
plugin_strip_prefix = static
plugin_http_user = abc
plugin_http_passwd = abc
4.启动 frpc:
./frpc -c ./frpc.ini
5.通过浏览器访问 http://x.x.x.x:6000/static/ 来查看位于 /tmp/file 目录下的文件,会要求输入已设置好的用户名和密码。
安全地暴露内网服务
对于某些服务来说如果直接暴露于公网上将会存在安全隐患。
使用 stcp(secret tcp) 类型的代理可以避免让任何人都能访问到要穿透的服务,但是访问者也需要运行另外一个 frpc。
以下示例将会创建一个只有自己能访问到的 ssh 服务代理。
1.服务器端,修改 frps.ini 文件:
# frps.ini
[common]
bind_port = 7000
2.启动 frps:
./frps -c ./frps.ini
3.客户端,转发内网的 ssh 服务,配置如下,不需要指定远程端口:
# frpc.ini
[common]
server_addr = x.x.x.x
server_port = 7000
[secret_ssh]
type = stcp
# 只有 sk 一致的用户才能访问到此服务
sk = abcdefg
local_ip = 127.0.0.1
local_port = 22
4.在要访问这个服务的机器上启动另外一个 frpc,配置如下:
# frpc.ini
[common]
server_addr = x.x.x.x
server_port = 7000
[secret_ssh_visitor]
type = stcp
# stcp 的访问者
role = visitor
# 要访问的 stcp 代理的名字
server_name = secret_ssh
sk = abcdefg
# 绑定本地端口用于访问 ssh 服务
bind_addr = 127.0.0.1
bind_port = 6000
5.通过 ssh 访问内网机器,假设用户名为 test:
ssh -oPort=6000 test@127.0.0.1
点对点内网穿透
frp 提供了一种新的代理类型 xtcp 用于应对在希望传输大量数据且流量不经过服务器的场景。
使用方式同 stcp 类似,需要在两边都部署上 frpc 用于建立直接的连接。
目前处于开发的初级阶段,并不能穿透所有类型的 NAT 设备,所以穿透成功率较低。穿透失败时可以尝试 stcp 的方式。
1.服务器端,修改 frps.ini 文件:
# frps.ini
[common]
bind_port = 7000
bind_udp_port = 7001
2.启动 frps:
./frps -c ./frps.ini
3.服务端,转发内网的 ssh 服务,配置如下,不需要指定远程端口:
# frpc.ini
[common]
server_addr = x.x.x.x
server_port = 7000
[p2p_ssh]
type = xtcp
# 只有 sk 一致的用户才能访问到此服务
sk = abcdefg
local_ip = 127.0.0.1
local_port = 22
4.在要访问这个服务的机器上启动另外一个 frpc,配置如下:
# frpc.ini
[common]
server_addr = x.x.x.x
server_port = 7000
[p2p_ssh_visitor]
type = xtcp
# xtcp 的访问者
role = visitor
# 要访问的 xtcp 代理的名字
server_name = p2p_ssh
sk = abcdefg
# 绑定本地端口用于访问 ssh 服务
bind_addr = 127.0.0.1
bind_port = 6000
5.通过 ssh 访问内网机器,假设用户名为 test:
ssh -oPort=6000 test@127.0.0.1
通过 frpc 所在机器访问外网
frpc 内置了 http proxy 和 socks5 插件,可以使其他机器通过 frpc 的网络访问互联网。
1.服务器端,修改 frps.ini 文件:
# frps.ini
[common]
bind_port = 7000
bind_udp_port = 7001
2.启动 frps:
./frps -c ./frps.ini
3.客户端,启用 http_proxy 或 socks5 插件(plugin 换为 socks5 即可), 配置如下:
# frpc.ini
[common]
server_addr = x.x.x.x
server_port = 7000
[http_proxy]
type = tcp
remote_port = 6000
plugin = http_proxy
4.浏览器设置 http 或 socks5 代理地址为 x.x.x.x:6000
,通过 frpc 机器的网络访问互联网
功能说明
配置文件
由于 frp 目前支持的功能和配置项较多,未在文档中列出的功能可以从完整的示例配置文件中发现。
Dashboard
通过浏览器查看 frp 的状态以及代理统计信息展示。
1.需要在 frps.ini 中指定 dashboard 服务使用的端口,即可开启此功能:
[common]
dashboard_port = 7500
# dashboard 用户名密码,默认都为 admin
dashboard_user = admin
dashboard_pwd = admin
2.打开浏览器通过 http://[server_addr]:7500
访问 dashboard 界面,用户名密码默认为 admin
。
身份验证
从 v0.10.0 版本开始,所有 proxy 配置全部放在客户端(也就是之前版本的特权模式),服务端和客户端的 common 配置中的 privilege_token
参数一致则身份验证通过。
需要注意的是 frpc 所在机器和 frps 所在机器的时间相差不能超过 15 分钟,因为时间戳会被用于加密验证中,防止报文被劫持后被其他人利用。
这个超时时间可以在配置文件中通过 authentication_timeout
这个参数来修改,单位为秒,默认值为 900,即 15 分钟。如果修改为 0,则 frps 将不对身份验证报文的时间戳进行超时校验。
加密与压缩
这两个功能默认是不开启的,需要在 frpc.ini 中通过配置来为指定的代理启用加密与压缩的功能,压缩算法使用 snappy:
# frpc.ini
[ssh]
type = tcp
local_port = 22
remote_port = 6000
use_encryption = true
use_compression = true
如果公司内网防火墙对外网访问进行了流量识别与屏蔽,例如禁止了 ssh 协议等,通过设置 use_encryption = true
,将 frpc 与 frps 之间的通信内容加密传输,将会有效防止流量被拦截
如果传输的报文长度较长,通过设置 use_compression = true
对传输内容进行压缩,可以有效减小 frpc 与 frps 之间的网络流量,加快流量转发速度,但是会额外消耗一些 cpu 资源。
客户端热加载配置文件
当修改了 frpc 中的代理配置,可以通过 frpc reload
命令来动态加载配置文件,通常会在 10 秒内完成代理的更新。
启用此功能需要在 frpc 中启用 admin 端口,用于提供 API 服务。配置如下:
# frpc.ini
[common]
admin_addr = 127.0.0.1
admin_port = 7400
之后执行重启命令:
frpc reload -c ./frpc.ini
等待一段时间后客户端会根据新的配置文件创建,更新,删除代理。
客户端查看代理状态
frpc 支持通过 frpc status -c ./frpc.ini
命令查看代理的状态信息,此功能需要在 frpc 中配置 admin 端口。
特权模式
由于从 v0.10.0 版本开始,所有 proxy 都在客户端配置,原先的特权模式是目前唯一支持的模式。
端口白名单
为了防止端口被滥用,可以手动指定允许哪些端口被使用,在 frps.ini 中通过 privilege_allow_ports 来指定:
# frps.ini
[common]
privilege_allow_ports = 2000-3000,3001,3003,4000-50000
privilege_allow_ports 可以配置允许使用的某个指定端口或者是一个范围内的所有端口,以 ,
分隔,指定的范围以 -
分隔。
TCP 多路复用
从 v0.10.0 版本开始,客户端和服务器端之间的连接支持多路复用,不再需要为每一个用户请求创建一个连接,使连接建立的延迟降低,并且避免了大量文件描述符的占用,使 frp 可以承载更高的并发数。
该功能默认启用,如需关闭,可以在 frps.ini 和 frpc.ini 中配置,该配置项在服务端和客户端必须一致:
# frps.ini 和 frpc.ini 中
[common]
tcp_mux = false
底层通信可选 kcp 协议
从 v0.12.0 版本开始,底层通信协议支持选择 kcp 协议,在弱网环境下传输效率提升明显,但是会有一些额外的流量消耗。
开启 kcp 协议支持:
1.在 frps.ini 中启用 kcp 协议支持,指定一个 udp 端口用于接收客户端请求:
# frps.ini
[common]
bind_port = 7000
# kcp 绑定的是 udp 端口,可以和 bind_port 一样
kcp_bind_port = 7000
2.在 frpc.ini 指定需要使用的协议类型,目前只支持 tcp 和 kcp。其他代理配置不需要变更:
# frpc.ini
[common]
server_addr = x.x.x.x
# server_port 指定为 frps 的 kcp_bind_port
server_port = 7000
protocol = kcp
3.像之前一样使用 frp,需要注意开放相关机器上的 udp 的端口的访问权限。
连接池
默认情况下,当用户请求建立连接后,frps 才会请求 frpc 主动与后端服务建立一个连接。当为指定的代理启用连接池后,frp 会预先和后端服务建立起指定数量的连接,每次接收到用户请求后,会从连接池中取出一个连接和用户连接关联起来,避免了等待与后端服务建立连接以及 frpc 和 frps 之间传递控制信息的时间。
这一功能比较适合有大量短连接请求时开启。
1.首先可以在 frps.ini 中设置每个代理可以创建的连接池上限,避免大量资源占用,客户端设置超过此配置后会被调整到当前值:
# frps.ini
[common]
max_pool_count = 5
2.在 frpc.ini 中为客户端启用连接池,指定预创建连接的数量:
# frpc.ini
[common]
pool_count = 1
修改 Host Header
通常情况下 frp 不会修改转发的任何数据。但有一些后端服务会根据 http 请求 header 中的 host 字段来展现不同的网站,例如 nginx 的虚拟主机服务,启用 host-header 的修改功能可以动态修改 http 请求中的 host 字段。该功能仅限于 http 类型的代理。
# frpc.ini
[web]
type = http
local_port = 80
custom_domains = test.yourdomain.com
host_header_rewrite = dev.yourdomain.com
原来 http 请求中的 host 字段 test.yourdomain.com
转发到后端服务时会被替换为 dev.yourdomain.com
。
获取用户真实 IP
目前只有 http 类型的代理支持这一功能,可以通过用户请求的 header 中的 X-Forwarded-For
和 X-Real-IP
来获取用户真实 IP。
需要注意的是,目前只在每一个用户连接的第一个 HTTP 请求中添加了这两个 header。
通过密码保护你的 web 服务
由于所有客户端共用一个 frps 的 http 服务端口,任何知道你的域名和 url 的人都能访问到你部署在内网的 web 服务,但是在某些场景下需要确保只有限定的用户才能访问。
frp 支持通过 HTTP Basic Auth 来保护你的 web 服务,使用户需要通过用户名和密码才能访问到你的服务。
该功能目前仅限于 http 类型的代理,需要在 frpc 的代理配置中添加用户名和密码的设置。
# frpc.ini
[web]
type = http
local_port = 80
custom_domains = test.yourdomain.com
http_user = abc
http_pwd = abc
通过浏览器访问 http://test.yourdomain.com
,需要输入配置的用户名和密码才能访问。
自定义二级域名
在多人同时使用一个 frps 时,通过自定义二级域名的方式来使用会更加方便。
通过在 frps 的配置文件中配置 subdomain_host
,就可以启用该特性。之后在 frpc 的 http,https 类型的代理中可以不配置 custom_domains
,而是配置一个 subdomain
参数。
只需要将 *.{subdomain_host}
解析到 frps 所在服务器。之后用户可以通过 subdomain
自行指定自己的 web 服务所需要使用的二级域名,通过 {subdomain}.{subdomain_host}
来访问自己的 web 服务。
# frps.ini
[common]
subdomain_host = frps.com
将泛域名 *.frps.com
解析到 frps 所在服务器的 IP 地址。
# frpc.ini
[web]
type = http
local_port = 80
subdomain = test
frps 和 fprc 都启动成功后,通过 test.frps.com
就可以访问到内网的 web 服务。
需要注意的是如果 frps 配置了 subdomain_host
,则 custom_domains
中不能是属于 subdomain_host
的子域名或者泛域名。
同一个 http 或 https 类型的代理中 custom_domains
和 subdomain
可以同时配置。
URL 路由
frp 支持根据请求的 URL 路径路由转发到不同的后端服务。
通过配置文件中的 locations
字段指定一个或多个 proxy 能够匹配的 URL 前缀(目前仅支持最大前缀匹配,之后会考虑正则匹配)。例如指定 locations = /news
,则所有 URL 以 /news
开头的请求都会被转发到这个服务。
# frpc.ini
[web01]
type = http
local_port = 80
custom_domains = web.yourdomain.com
locations = /
[web02]
type = http
local_port = 81
custom_domains = web.yourdomain.com
locations = /news,/about
按照上述的示例配置后,web.yourdomain.com
这个域名下所有以 /news
以及 /about
作为前缀的 URL 请求都会被转发到 web02,其余的请求会被转发到 web01。
通过代理连接 frps
在只能通过代理访问外网的环境内,frpc 支持通过 HTTP PROXY 和 frps 进行通信。
可以通过设置 HTTP_PROXY
系统环境变量或者通过在 frpc 的配置文件中设置 http_proxy
参数来使用此功能。
仅在 protocol = tcp
时生效。
# frpc.ini
[common]
server_addr = x.x.x.x
server_port = 7000
http_proxy = http://user:pwd@192.168.1.128:8080
范围端口映射
在 frpc 的配置文件中可以指定映射多个端口,目前只支持 tcp 和 udp 的类型。
这一功能通过 range:
段落标记来实现,客户端会解析这个标记中的配置,将其拆分成多个 proxy,每一个 proxy 以数字为后缀命名。
例如要映射本地 6000-6005, 6007 这6个端口,主要配置如下:
# frpc.ini
[range:test_tcp]
type = tcp
local_ip = 127.0.0.1
local_port = 6000-6006,6007
remote_port = 6000-6006,6007
实际连接成功后会创建 6 个 proxy,命名为 test_tcp_0, test_tcp_1 ... test_tcp_5
。
插件
默认情况下,frpc 只会转发请求到本地 tcp 或 udp 端口。
插件模式是为了在客户端提供更加丰富的功能,目前内置的插件有 unix_domain_socket
,http_proxy
,socks5
,static_file
。具体使用方式请查看使用示例。
通过 plugin
指定需要使用的插件,插件的配置参数都以 plugin_
开头。使用插件后 local_ip
和 local_port
不再需要配置。
使用 http_proxy 插件的示例:
# frpc.ini
[http_proxy]
type = tcp
remote_port = 6000
plugin = http_proxy
plugin_http_user = abc
plugin_http_passwd = abc
plugin_http_user
和 plugin_http_passwd
即为 http_proxy
插件可选的配置参数。
实例参考
环境说明:
服务器: 阿里云ECS服务器一台 固定公网IP: 47.94.22.7 系统环境: CentOS 7.4
客户端: IP: 192.168.0.16 内网网段192.168.0.0/24 系统环境: CentOS 7.4
注意本示例中:
阿里云服务器需要在开 管理控制台 → 云服务器ECS → 网络和安全 → 安全组 → 配置规则 添加规则:
入方向 授权策略允许 fpr 服务监听端口:tcp7000, udp7001; web转发端口:tcp8080, tcp9090; tcp33899
服务器端
服务器端启动程序为 fprs 服务器端配置文件为 fprs.ini
# 下载 frp
wget https://github.com/fatedier/frp/releases/download/v0.16.0/frp_0.16.0_linux_amd64.tar.gz
# 解压
tar -xvf frp_0.16.0_linux_amd64.tar.gz
# 更改程序目录
mv frp_0.16.0_linux_amd64/ /usr/local/frp/ && cd /usr/local/frp/
# 编辑 frps.ini 文件内容如下
[common]
# 监听IP, TCP端口号:7000, UDP端口号:7001
bind_addr = 0.0.0.0
bind_port = 7000
bind_udp_port = 7001
# WEB管理端口, 登陆用户名, 登陆密码
dashboard_port = 7500
dashboard_user = username
dashboard_pwd = passwd
# 接收HTTP端口:8080, 接收HTTPS端口:9090
vhost_http_port = 8080
vhost_https_port = 9090
# 客户端连接服务器验证token
privilege_token = abcdef
# 配置开机自动启动
echo "/usr/bin/nohup /usr/local/frp/frps -c /usr/local/frp/frps.ini >>/usr/local/frp/frps-output.log 2>&1 &" >>/etc/rc.d/rc.local
chmod +x /etc/rc.d/rc.local
客户端
客户端启动程序为 fprc 客户端配置文件为 fprc.ini
# 下载 frp
wget https://github.com/fatedier/frp/releases/download/v0.16.0/frp_0.16.0_linux_amd64.tar.gz
# 解压
tar -xvf frp_0.16.0_linux_amd64.tar.gz
# 更改程序目录
mv frp_0.16.0_linux_amd64/ /usr/local/frp/ && cd /usr/local/frp/
# 编辑 frpc.ini 文件内容如下
# frpc.ini
[common]
# 服务器端IP, 服务器端监听端口号, 连接服务器token
server_addr = 47.94.22.71
server_port = 7000
privilege_token = abcdef
# 配置客户端热加载(客户端可以通过reload/status管理frpc)
admin_addr = 127.0.0.1
admin_port = 7400
# 浏览器打开 http://abc.onlycloud.xin:8080(端口号与服务定义的:vhost_http_port 相对应) 访问客户端本机的5000端口号 web 服务
[abc]
type = http
local_port = 5000
custom_domains = abc.onlycloud.xin
# 浏览器打开 http://bcd.onlycloud.xin:8080 访问局域网 192.168.0.10 主机80端口号 web 服务
[bcd]
type = http
local_port = 80
local_ip = 192.168.0.100
custom_domains = bcd.onlycloud.xin
# 浏览器打开 https://cde.onlycloud.xin:9090(端口号与服务定义的:vhost_https_port 相对应) 访问局域网 192.168.0.101 主机 443 端口 web 服务
[cde]
type = https
local_port = 443
local_ip = 192.168.0.101
custom_domains = cde.onlycloud.xin
# 使用远程桌面工具访问 47.94.22.71:33899(或 onlycloud.xin:33899) 相当于访问局域网 192.168.0.5 主机远程桌面
[Remote_desktop]
type = tcp
local_ip = 192.168.0.5
local_port = 33899
remote_port = 3389
# 浏览器打开 http://47.94.22.71:6000(或 onlycloud.xin:6000) 访问本机 /tmp 目录下的文件
[test_static_files]
type = tcp
remote_port = 6000
plugin = static_file
# 要对外暴露的文件目录
plugin_local_path = /tmp
# 添加父路径达到隐藏服务目的(可配置多层 static/abcd) 例如:http://47.94.22.71:6000/static
# plugin_strip_prefix = static
# 网页安全验证
plugin_http_user = 111
plugin_http_passwd = 111
# 配置开机自启动(如果是群晖NAS开启启动命令添加到 /etc/rc 文件 exit 0 之前)
echo "/usr/bin/nohup /usr/local/frp/frpc -c /usr/local/frp/frpc.ini >>/usr/local/frp/frpc-output.log 2>&1 &" >>/etc/rc.d/rc.local
chmod +x /etc/rc.d/rc.local
管理
服务器端浏览器打开 http://47.94.22.71:7500 查看连接状态
客户端配置热加载后通过命令 ./frpc status -c ./frpc.ini 查看连接状态
计划任务
服务端请替换 frpc 为 frps
1 | cat <<EOF >>/shell/check.sh |
配置共享的frp
以下配置中onlycloud.xin
是本人阿里云未备案域名 添加CNAME解析【*】记录 值:【frp2.chuantou.org】
配置文件
1 | # frpc.ini |
查看状态
1 | root@DiskStation:~# frpc status -c ./frpc.ini |