lwch / natpass

🔥居家办公，远程开发神器

natpass

新一代主机管理工具，支持shell管理，支持远程桌面管理实现原理

1. 如何部署
2. 规则配置
3. 开发文档

功能与特性：

1. 支持私有化部署
2. 较小的内存占用（约20M左右）
3. 支持tls安全连接
4. 支持多路异步IO
5. 支持虚拟链路层
6. 支持链路和终端会话监控
7. protobuf数据编码
8. 支持web shell
   • linux和mac系统支持创建pty设备和颜色输出
   • windows系统支持powershell
9. 支持web vnc
   • 支持基本的键盘鼠标操作
   • 支持全屏显示
   • 支持滚动
   • 支持远程剪贴板设置与读取
10. 支持code-server
11. 支持多种操作系统

• linux
• windows
• macos

效果图

dashboard页面

命令行

platform	386	amd64	arm	arm64
windows	✅	✅	✅	✅
macos		✅		✅
linux	✅	✅	✅	✅

远程桌面

platform	386	amd64	arm	arm64
windows	✅	✅	❌	❌
macos		✅		✅
linux	✅	✅	❌	❌

windows剪贴板内容

code-server支持

性能

在vmware环境下创建4C2G（AMD Ryzen 7 4800U with Radeon Graphics）测试环境，并进行all in one部署server、remote端和local端，使用bench规则进行压测，结果如下：

1. 压测结果仅包含local端发起连接到remote端收到连接并返回成功的整个过程
2. 实验结果表明，在4C2G环境下可达到上万+的qps，且p99和p100均在60ms以下

TODO

1. 支持include的yaml配置文件
2. 通用的connect、connect_response、disconnect消息
3. dashboard页面
4. 文件传输
5. web远程桌面
6. 流量监控统计页面，server还是client?
7. web端管理规则
8. 支持录屏

编译

1. 由于html/dashboard等目录下引用第三方库时使用软连接的方式进行处理， 因此在windows环境下进行编译时需要将这些软连接的目录进行手工替换， 第三方库的代码都在上级目录下可找到。

stars

免责声明

本软件仅用于个人研究学习，包括但不限于以下条款：

1. 严禁用于黑客攻击、远程控制他人计算机等违法违规行为
2. 软件使用者使用该软件造成的任何损失均与软件作者无关， 一切后果由使用者自己负责
3. 严禁用于一切商业用途，包括但不限于提供云桌面、云主机等

贡献代码

为了更好的发展，我们鼓励大家为natpass项目做出贡献及提出建议，项目的地址为https://github.com/lwch/natpass，因此在gitee上提交的pr将不被接受，请大家将pr提交到github的同名项目中。

natpass's Issues

natpass 被用于黑客攻击,如何侦测 ？

Decription

目前我们服务器被攻击，发现natpass-cli 启用6145 作为端口，

问题

如何侦测通过natpass 进程服务？

请问反向shell的规则要怎么配置

家里没有公网的情况只能 reverse shell 看源码好像有实现这个功能 需要另外配置规则吗

Got some error stright after deployment

~/natpass_0.9.0 
❯ bat server.yaml
──────────────
1 │ listen: 6154 # 监听端口号
2 │ #include common.yaml
3 │ #tls:
4 │ # key: /dir/to/tls/key/file # tls密钥
5 │ # crt: /dir/to/tls/crt/file # tls证书

Below log of errors which was occurred after I tried to open -> http://vpsip:6541 if i do http://vpsip:8080 - I cant connect ether

ubuntuvnc 19:36   ~/natpass_0.9.0 
❯ ./np-svr -conf server.yaml
2022/07/11 20:09:38 [ERROR]read handshake from 45.15.16.60:51496 1 times, err=read tcp 185.102.170.197:6154->45.15.16.60:51496: i/o timeout

• (/root/go/pkg/mod/github.com/lwch/[email protected]/log.go:30) github.com/lwch/logging.Error
• (/build/code/server/handler/handler.go:67) github.com/lwch/natpass/code/server/handler.(*Handler).Handle
  2022/07/11 20:09:38 [ERROR]read handshake from 45.15.16.60:51492 1 times, err=read tcp 185.102.170.197:6154->45.15.16.60:51492: i/o timeout
• (/root/go/pkg/mod/github.com/lwch/[email protected]/log.go:30) github.com/lwch/logging.Error
• (/build/code/server/handler/handler.go:67) github.com/lwch/natpass/code/server/handler.(*Handler).Handle
  2022/07/11 20:09:39 [ERROR]read handshake from 45.15.16.60:51496 2 times, err=EOF
• (/root/go/pkg/mod/github.com/lwch/[email protected]/log.go:30) github.com/lwch/logging.Error
• (/build/code/server/handler/handler.go:67) github.com/lwch/natpass/code/server/handler.(*Handler).Handle
  2022/07/11 20:09:39 [ERROR]read handshake from 45.15.16.60:51496 3 times, err=EOF
• (/root/go/pkg/mod/github.com/lwch/[email protected]/log.go:30) github.com/lwch/logging.Error
• (/build/code/server/handler/handler.go:67) github.com/lwch/natpass/code/server/handler.(*Handler).Handle
  2022/07/11 20:09:39 [ERROR]read handshake from 45.15.16.60:51496 4 times, err=EOF
• (/root/go/pkg/mod/github.com/lwch/[email protected]/log.go:30) github.com/lwch/logging.Error
• (/build/code/server/handler/handler.go:67) github.com/lwch/natpass/code/server/handler.(*Handler).Handle
  2022/07/11 20:09:39 [ERROR]read handshake from 45.15.16.60:51496 5 times, err=EOF
• (/root/go/pkg/mod/github.com/lwch/[email protected]/log.go:30) github.com/lwch/logging.Error
• (/build/code/server/handler/handler.go:67) github.com/lwch/natpass/code/server/handler.(*Handler).Handle
  2022/07/11 20:09:39 [ERROR]read handshake from 45.15.16.60:51496 6 times, err=EOF
• (/root/go/pkg/mod/github.com/lwch/[email protected]/log.go:30) github.com/lwch/logging.Error
• (/build/code/server/handler/handler.go:67) github.com/lwch/natpass/code/server/handler.(*Handler).Handle
  2022/07/11 20:09:39 [ERROR]read handshake from 45.15.16.60:51496 7 times, err=EOF
• (/root/go/pkg/mod/github.com/lwch/[email protected]/log.go:30) github.com/lwch/logging.Error
• (/build/code/server/handler/handler.go:67) github.com/lwch/natpass/code/server/handler.(*Handler).Handle
  2022/07/11 20:09:39 [ERROR]read handshake from 45.15.16.60:51496 8 times, err=EOF
• (/root/go/pkg/mod/github.com/lwch/[email protected]/log.go:30) github.com/lwch/logging.Error
• (/build/code/server/handler/handler.go:67) github.com/lwch/natpass/code/server/handler.(*Handler).Handle
  2022/07/11 20:09:39 [ERROR]read handshake from 45.15.16.60:51496 9 times, err=EOF
• (/root/go/pkg/mod/github.com/lwch/[email protected]/log.go:30) github.com/lwch/logging.Error
• (/build/code/server/handler/handler.go:67) github.com/lwch/natpass/code/server/handler.(*Handler).Handle
  2022/07/11 20:09:39 [ERROR]read handshake from 45.15.16.60:51496 10 times, err=EOF
• (/root/go/pkg/mod/github.com/lwch/[email protected]/log.go:30) github.com/lwch/logging.Error
• (/build/code/server/handler/handler.go:67) github.com/lwch/natpass/code/server/handler.(*Handler).Handle
  2022/07/11 20:09:43 [ERROR]read handshake from 45.15.16.60:51492 2 times, err=read tcp 185.102.170.197:6154->45.15.16.60:51492: i/o timeout
• (/root/go/pkg/mod/github.com/lwch/[email protected]/log.go:30) github.com/lwch/logging.Error
• (/build/code/server/handler/handler.go:67) github.com/lwch/natpass/code/server/handler.(*Handler).Handle
  2022/07/11 20:09:48 [ERROR]read handshake from 45.15.16.60:51492 3 times, err=read tcp 185.102.170.197:6154->45.15.16.60:51492: i/o timeout
• (/root/go/pkg/mod/github.com/lwch/[email protected]/log.go:30) github.com/lwch/logging.Error
• (/build/code/server/handler/handler.go:67) github.com/lwch/natpass/code/server/handler.(*Handler).Handle
  2022/07/11 20:09:53 [ERROR]read handshake from 45.15.16.60:51492 4 times, err=read tcp 185.102.170.197:6154->45.15.16.60:51492: i/o timeout
• (/root/go/pkg/mod/github.com/lwch/[email protected]/log.go:30) github.com/lwch/logging.Error
• (/build/code/server/handler/handler.go:67) github.com/lwch/natpass/code/server/handler.(*Handler).Handle
  2022/07/11 20:09:58 [ERROR]read handshake from 45.15.16.60:51492 5 times, err=read tcp 185.102.170.197:6154->45.15.16.60:51492: i/o timeout
• (/root/go/pkg/mod/github.com/lwch/[email protected]/log.go:30) github.com/lwch/logging.Error
• (/build/code/server/handler/handler.go:67) github.com/lwch/natpass/code/server/handler.(*Handler).Handle
  2022/07/11 20:10:03 [ERROR]read handshake from 45.15.16.60:51492 6 times, err=read tcp 185.102.170.197:6154->45.15.16.60:51492: i/o timeout
• (/root/go/pkg/mod/github.com/lwch/[email protected]/log.go:30) github.com/lwch/logging.Error
• (/build/code/server/handler/handler.go:67) github.com/lwch/natpass/code/server/handler.(*Handler).Handle

Server environments : Linux version 5.4.0-29-generic (buildd@lgw01-amd64-035) (gcc version 9.3.0 (Ubuntu 9.3.0-10ubuntu2)) #33-Ubuntu SMP Wed Apr 29 14:32:27 UTC 2020

目标鼠标位置不对

mac - control- window
控制时，鼠标位置不对，左右差很多，可能我mac用外挂显示器吗？

请教一下,window下开启服务端,报这个错

增加port转发的规则

现在支持shell, VNC的，不知道能否考虑支持port(tcp or udp)转发的规则配置，能把被控端网络内的某个端口（自己或者网络内其他机器的）转发到控制端本地的某个端口

Windows启动报错

看起来是说文件通配符识别不了.

如何使用API的方式进行web远程桌面控制嵌入到别的web页面上

如何使用API的方式进行web远程桌面控制嵌入到别的web页面上

能通过docker部署吗

能通过docker部署吗😹

是否可以连接Android设备

这个可以连接非同一局域网的Android设备吗

关于预共享密钥

现在预共享密钥，主控端和被控端，都必须和服务器的保持一致是吗？是否可以支持分别设定密码呢？

windows注册服务后无法启动 & 启动远程后客户端会弹出一个终端窗口

我使用powershell \np-cli.exe --conf remote.yaml 运行它可以，
但是每次远程的时候都会弹出一个终端窗口。可以无痕运行吗？

注册服务
sc.exe create natService binPath= "C:\natpass_0.13.0_windows_386\natpass_0.13.0\np-cli.exe --conf remote.yaml" start= auto

注册后无法启动该服务。win11系统

编译报错

编译报错如下，应该是缺少了assets.go文件

# github.com/lwch/natpass/code/client/rule/shell
rule\shell\h_render.go:16:15: undefined: Asset
rule\shell\h_render.go:26:12: undefined: Asset
# github.com/lwch/natpass/code/client/rule/code
rule\code\h_render.go:18:15: undefined: Asset
rule\code\h_render.go:28:12: undefined: Asset
# github.com/lwch/natpass/code/client/dashboard
dashboard\h_render.go:21:15: undefined: Asset
dashboard\h_render.go:35:15: undefined: Asset
dashboard\h_render.go:45:15: undefined: Asset
dashboard\h_render.go:46:14: undefined: Asset
dashboard\h_render.go:47:15: undefined: Asset
# github.com/lwch/natpass/code/client/rule/vnc
rule\vnc\h_render.go:16:15: undefined: Asset
rule\vnc\h_render.go:26:12: undefined: Asset

建议把不同的链接方式区分一下 同时反馈几个问题

RDP
BAT

VNC
SSH

就这4种方式了

建议:在受控端手动指定可以用哪几种方式连接

我刚刚简单测试了一下
受控端是WIN10 用批处理临时运行
服务器是openwrt
客户端是openwrt

然后我用自己的电脑访问op的网址

问题1:
vnc的模式只能显示不能控制 定格了
问题2:
shell模式输错了命令按退格键删除 显示异常
问题3:
怎么退出? 点了连接以后不想连了,要怎么关闭这个会话?

我本意是想找一款远程桌面软件的 目前在虚拟机里面装的QQ,用windows自带的mstsc远程控制,但是QQ的界面卡卡的,想找一款免费的软件
以前用过radmin,效果不错,但是这个是收费的

并发能力如何？

请问一下，设计并发能力和测试并发能力如何？有大概的数据吗？

web vnc 无法支持键盘鼠标操作

按照文档运行没有任何日志，运行失败

在同一台机器上运行了服务端和控制端
[root@VM-8-5-centos natpass-server]# sudo systemctl start np-svr
[root@VM-8-5-centos natpass-server]# sudo systemctl start np-cli
启动后没有任何提示，也没有日志输出，打开对应端口也是失败的

[ERROR]invalid handshake from X.X.X.X:XXXXX + (/github/home/go/pkg/mod/github.com/lwch/[email protected]/log.go:30) github.com/lwch/logging.Error + (/github/workspace/code/server/handler/handler.go:64) github.com/lwch/natpass/code/server/handler.(*Handler).Handle

控制端出现上述的报错内容，控制端和服务端的时间一致，common.yaml配置文件的secret的值也一致
报错内容

控制端的时间

服务端的时间

服务端的common.yaml

控制端的common.yaml

Originally posted by @SkewwG in #59 (comment)

服务端是否支持websocket的协议

服务端是否支持websocket的协议，如果不支持，后续是否考虑增加

客户端开发计划

你好，大佬 请问有客户端开发计划嘛，网页版的感觉不是特别好用，用了一下rustdesk，感觉很流畅，想弄一个跟rustdesk差不多的东西，奈何rust语言有点复杂，golang的发现很少

三端启动报错

hi. 我在测试中遇到一些问题，所有配置文件仅修改了端口和服务器IP，local 可以跑起来看到设备列表，但是无法vnc 和shell,
有如下错误信息。
ser:

 + (/root/go/pkg/mod/github.com/lwch/[email protected]/log.go:30) github.com/lwch/logging.Error
  + (/build/code/server/handler/handler.go:64) github.com/lwch/natpass/code/server/handler.(*Handler).Handle
2022/07/11 11:46:59 [ERROR]invalid handshake from 
  + (/root/go/pkg/mod/github.com/lwch/[email protected]/log.go:30) github.com/lwch/logging.Error
  + (/build/code/server/handler/handler.go:64) github.com/lwch/natpass/code/server/handler.(*Handler).Handle
panic: runtime error: index out of range [0] with length 0

goroutine 56 [running]:
github.com/lwch/logging.(*rotateSizeLogger).rotate(0xc000190000)
	/root/go/pkg/mod/github.com/lwch/[email protected]/rotate_size.go:99 +0x951
github.com/lwch/logging.(*Logger).Error(0xb9d900, {0x88a118, 0x27}, {0xc0001010e0, 0x3, 0x3})
	/root/go/pkg/mod/github.com/lwch/[email protected]/log.go:90 +0x9b
github.com/lwch/logging.Error(...)
	/root/go/pkg/mod/github.com/lwch/[email protected]/log.go:30
github.com/lwch/natpass/code/server/handler.(*Handler).Handle(0xc0001940c0, {0x929ec0?, 0xc00000e248?})
	/build/code/server/handler/handler.go:67 +0xdc
created by main.run
	/build/code/server/main.go:141 +0x165

cli local:

  + (/root/go/pkg/mod/github.com/lwch/[email protected]/log.go:30) github.com/lwch/logging.Error
  + (/build/code/client/conn/conn.go:114) github.com/lwch/natpass/code/client/conn.(*Conn).loopRead
2022/07/11 11:46:59 [INFO]x.x.x.x:8976 connected
2022/07/11 11:46:59 [ERROR]read message: EOF
  + (/root/go/pkg/mod/github.com/lwch/[email protected]/log.go:30) github.com/lwch/logging.Error
  + (/build/code/client/conn/conn.go:114) github.com/lwch/natpass/code/client/conn.(*Conn).loopRead

cli remote(win 10)

panic: runtime error: index out of range [0] with length 0

goroutine 35 [running]:
github.com/lwch/logging.(*rotateSizeLogger).rotate(0xc000094000)
        /root/go/pkg/mod/github.com/lwch/[email protected]/rotate_size.go:99 +0x951
github.com/lwch/logging.(*Logger).Error(0x14268c0, {0x15169df, 0xe}, {0xc000210170, 0x1, 0x1})
        /root/go/pkg/mod/github.com/lwch/[email protected]/log.go:90 +0x9b
github.com/lwch/logging.Error(...)
        /root/go/pkg/mod/github.com/lwch/[email protected]/log.go:30
github.com/lwch/natpass/code/network.(*Conn).loopWrite(0xc000222040)
        /build/code/network/network.go:127 +0x248
created by github.com/lwch/natpass/code/network.NewConn
        /build/code/network/network.go:42 +0x137

功能特性支持

支持web api调用么 文件传输啥时候支持

docker版本能增加下参数说明吗

docker pull lwch/natpass-release:latest 运行不起来啊！运行服务端和控制端，能说明下都需要填写哪些参数

建议

能否添加远程打开设备web界面的功能
理由：
很多边端设备是嵌入式设备，没有桌面环境，但是提供了web访问界面

锁屏时被控服务崩溃

在windows10下运行，当被控端锁屏时nt-cli.exe会报错，并且画面黑屏，应该如何处理

配合noVNC 使用

请问，目前支持noVNC的使用嘛

相比较于常用的ToDesk有什么区别

1.是否支持p2p打洞，还是数据都会经过中转服务器

vnc界面是空的，帧率和传输数据都是0

版本：
v0.9.1

vnc界面是空的，帧率和传输数据都是0。shell 是可以打开的。

请问vnc功能对受控端有什么要求？需要安装vnc服务吗？

在云上的服务器部署服务端时监听了IPV6端口而不是IPV4端口，导致客户端无法连接

在云上的服务器部署服务端时监听了IPV6端口而不是IPV4端口，导致客户端无法连接

服务器当中并未存在IPV6地址

关于windows多用户问题

natpass是否支持远程连接指定的windows中的某个用户桌面，我刚在我window的一个账户下启动了受控端的客户端程序，然后跑到另外一个windows账户下启动控制端的客户端程序，然后访问http://127.0.0.1:8080去访问vnc，终端页显示空白

2022/11/27 15:53:22 [ERROR]invalid handshake from 172.16.17.136:50278 + (/github/home/go/pkg/mod/github.com/lwch/[email protected]/log.go:30) github.com/lwch/logging.Error + (/github/workspace/code/server/handler/handler.go:64) github.com/lwch/natpass/code/server/handler.(*Handler).Handle

2022/11/27 15:53:22 [ERROR]invalid handshake from 172.16.17.136:50278

• (/github/home/go/pkg/mod/github.com/lwch/[email protected]/log.go:30) github.com/lwch/logging.Error
• (/github/workspace/code/server/handler/handler.go:64) github.com/lwch/natpass/code/server/handler.(*Handler).Handle

在rule.d/shell.yaml的local_port能不指定，然后随机使用一个没被占用的端口吗？

谢谢开发和分享这个工具。

如题，主要是要提前分配rule中的local_port有点麻烦，不知道能否不指定，然后软件自动使用一个端口

有一个问题

请问 前端显示各种shell 是canvs 实现得嘛， 连接应该都是websocket 长连接把

natpass_0.12.2_linux_amd64解压后在linux系统中启动报错

部署完成后怎么使用呢？

请问一下，部署完成后，怎么使用呢？打开url还是用什么终端？

编译出错

执行 build_all ，在编译 linux amd64 时出错，详细日志如下：
代码分支 v0.8.3

`natpass git:(heads/v0.8.3) ✗ ./build_all
[+] Building 3.3s (7/7) FINISHED
=> [internal] load build definition from Dockerfile 0.0s
=> => transferring dockerfile: 37B 0.0s
=> [internal] load .dockerignore 0.0s
=> => transferring context: 2B 0.0s
=> [internal] load metadata for docker.io/library/debian:stable-slim 3.2s
=> [1/3] FROM docker.io/library/debian:stable-slim@sha256:091320245c2637337fc612baf22430ec1735fd395e2c97e2c90136137d156f63 0.0s
=> CACHED [2/3] WORKDIR /build 0.0s
=> CACHED [3/3] RUN sed -i "s|deb.debian.org|mirrors.ustc.edu.cn|g" /etc/apt/sources.list && sed -i "s|security.debian.org|mirrors.ustc.edu.cn|g" /etc/apt/sources.list && 0.0s
=> exporting to image 0.0s
=> => exporting layers 0.0s
=> => writing image sha256:02faaa823400e4098f801bf50b212737f81314da3cbe5348d46615083e9cd7de 0.0s
=> => naming to docker.io/library/natpass 0.0s

Use 'docker scan' to run Snyk tests against images to find vulnerabilities and learn how to fix them
2022/03/07 08:44:13 [INFO]go env...
GO111MODULE=""
GOARCH="amd64"
GOBIN=""
GOCACHE="/root/.cache/go-build"
GOENV="/root/.config/go/env"
GOEXE=""
GOEXPERIMENT=""
GOFLAGS=""
GOHOSTARCH="amd64"
GOHOSTOS="linux"
GOINSECURE=""
GOMODCACHE="/root/go/pkg/mod"
GONOPROXY=""
GONOSUMDB=""
GOOS="linux"
GOPATH="/root/go"
GOPRIVATE=""
GOPROXY="https://goproxy.cn,direct"
GOROOT="/usr/local/go"
GOSUMDB="sum.golang.org"
GOTMPDIR=""
GOTOOLDIR="/usr/local/go/pkg/tool/linux_amd64"
GOVCS=""
GOVERSION="go1.17.7"
GCCGO="gccgo"
AR="ar"
CC="gcc"
CXX="g++"
CGO_ENABLED="1"
GOMOD="/build/go.mod"
CGO_CFLAGS="-g -O2"
CGO_CPPFLAGS=""
CGO_CXXFLAGS="-g -O2"
CGO_FFLAGS="-g -O2"
CGO_LDFLAGS="-g -O2"
PKG_CONFIG="pkg-config"
GOGCCFLAGS="-fPIC -m64 -pthread -fmessage-length=0 -fdebug-prefix-map=/tmp/go-build3024449258=/tmp/go-build -gno-record-gcc-switches"
2022/03/07 08:44:35 [INFO]build target linux/amd64...
2022/03/07 08:44:36 [INFO]build server...
2022/03/07 08:44:41 [INFO]build client...
# github.com/lwch/rdesktop/keycode
/usr/bin/ld: skipping incompatible /usr/lib/i386-linux-gnu/libX11.so when searching for -lX11
/usr/bin/ld: skipping incompatible /usr/lib/i386-linux-gnu/libX11.a when searching for -lX11
/usr/bin/ld: cannot find -lX11
/usr/bin/ld: skipping incompatible /usr/lib/i386-linux-gnu/libX11.so when searching for -lX11
collect2: error: ld returned 1 exit status
panic: exit status 2

goroutine 1 [running]:
github.com/lwch/runtime.Assert(...)
/root/go/pkg/mod/github.com/lwch/[email protected]/assert.go:6
main.build({{0x4f09db, 0x5}, {0x4f0972, 0x5}, {0x0, 0x0}, {0x0, 0x0}, {0x0, 0x0}, ...})
/build/contrib/build/build_all.go:207 +0x132f
main.main()
/build/contrib/build/build_all.go:114 +0x305
exit status 2`

小建议

• 代码目录结构：可否参照下相关golang开源项目或者规范靠一下呢，暂可忽略
• windows支持：既然当前只支持windows vnc，不知是否有调测，配置文件是否单独抽出windows支持的配置路径格式，或者程序处理转义路径形式。windows报错，启动panic,尴尬
• panic： 直接使用panic处理所有错误，太硬了，出问题哪里抛出的都不一定能直接找到，估摸的一层一层去找了，生产环境定然不能直接这样，推荐log信息埋点加时间event关键词是否会更友好点
• 直接上tls： 个人感觉有必要，也有点硬，门槛拉高了，只是想使用下，或者放置个默认试用证书？ 或者配置tls开启、关闭 客服考虑下
• 开发者文档：暂可忽略

目前看想试用下跑起来有点费劲。测试各种panic 泪崩